Country

What can you do with Country?


Properties

Property Details
id
"id": 317
Type: Number
This is the unique numeric identifier for the Country
name
"name": "Hello World"
Type: String
sortOrder
"sortOrder": 744
Type: Number
ownerId
"ownerId": 222
Type: Number
Unique identifier for the associated Owner object.
countryAddressFormatId
"countryAddressFormatId": 16
Type: Number
Unique identifier for the associated CountryAddressFormat object.
dataTypePostalCodeId
"dataTypePostalCodeId": 599
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:

  • identity
  • 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

DELETEapi/v1/Country/{id:int}
Delete an instance of the Country object.
GETapi/v1/Country
Retrieve all of the Country objects.
GETapi/v1/Country/Default
Retrieve all of the Country objects.
GETapi/v1/Country/Default/Paged
Retreive all of the Country objects in a paged fashion.
GETapi/v1/Country/Default/Paged/Detail
Retreive all of the Country objects in a paged fashion with all object details.
GETapi/v1/Country/Default/{id:int}
Retrieve an instance of the Country object by it's ID.
{id:int}Unique identifier for the Country object.
GETapi/v1/Country/Default/{id:int}/Detail
Retrieve a specified /{id:int}/ object by it's ID for a specified Country.
{id:int}Unique identifier for the Country object.
GETapi/v1/Country/Metadata
Retrieve all of the meta data details of the Country object.
GETapi/v1/Country/Metadata/{option}
Retrieve all the meta data details of the Country object based on provided options.
{option}Metadata options for the Country object.
GETapi/v1/Country/Paged
Retreive all of the Country objects in a paged fashion.
GETapi/v1/Country/Paged/Detail
Retreive all of the Country objects in a paged fashion with all object details.
GETapi/v1/Country/{id:int}
Retrieve an instance of the Country object by it's ID.
{id:int}Unique identifier for the Country object.
GETapi/v1/Country/{id:int}/Detail
Retreive all of the Detail objects for the specified Country.
{id:int}Unique identifier for the Country object.
PATCHapi/v1/Country/{id:int}
Update the Country object and optionally make changes to any child objects.
POSTapi/v1/Country
Create a new instance of the Country object.
PUTapi/v1/Country/{id:int}
Update an existing instance of the Country object.