Country

(API Version v2)

What can you do with Country?

DELETE api/v2/Country/{id:int}
GET api/v2/Country
GET api/v2/Country/Paged
GET api/v2/Country/Paged/Detail
GET api/v2/Country/{id:int}
GET api/v2/Country/{id:int}/Detail
PATCH api/v2/Country/{id:int}
POST api/v2/Country
PUT api/v2/Country/{id:int}

Properties

Property Details

id	"id": 18 Type: Number This is the unique numeric identifier for the Country
name	"name": "Hello World" Type: String
sortOrder	"sortOrder": 2 Type: Number
ownerId	"ownerId": 16 Type: Number Unique identifier for the associated Owner object.
countryAddressFormatId	"countryAddressFormatId": 10 Type: Number Unique identifier for the associated CountryAddressFormat object.
dataTypePostalCodeId	"dataTypePostalCodeId": 9 Type: Number Unique identifier for the associated DataTypePostalCode object.
countryCode	"countryCode": "Hello World" Type: String
isVisible	"isVisible": true Type: Boolean

Update Request Filters

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

name
sortOrder
countryAddressFormatId
dataTypePostalCodeId
countryCode
isVisible

Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Country object.

Standard PATCH objects:

state - create, update, delete

DataFlow PATCH objects:

country - create, update, delete
state - create, update, delete

End Points

DELETE	api/v2/Country/{id:int}
Delete an instance of the Country object.

GET	api/v2/Country
Retrieve all of the Country objects.

GET	api/v2/Country/Paged
Retreive all of the Country objects in a paged fashion.

GET	api/v2/Country/Paged/Detail
Retreive all of the Country objects in a paged fashion with all object details.

GET	api/v2/Country/{id:int}
Retrieve an instance of the Country object by it's ID.
{id:int}	Unique identifier for the Country object.

GET	api/v2/Country/{id:int}/Detail
Retreive all of the Detail objects for the specified Country.
{id:int}	Unique identifier for the Country object.

PATCH	api/v2/Country/{id:int}
Update the Country object and optionally make changes to any child objects.

POST	api/v2/Country
Create a new instance of the Country object.

PUT	api/v2/Country/{id:int}
Update an existing instance of the Country object.