Country

(API Version v10)

This entity contains a list of country definitions.

What can you do with Country?

DELETE Country/{id}
Delete an instance of the Country object.
GET Country/
Retrieve all of the Country objects.
GET Country/Paged
Retrieve all of the Country objects in a paged fashion.
GET Country/Paged/Detail
Retrieve all of the Country objects in a paged fashion with all object details.
GET Country/{id}
Retrieve an instance of the Country object by its ID.
GET Country/{id}/Detail
Retrieve deep detail of the Country object by its ID.
PATCH Country/{id}
Update or Add the Country object and optionally make changes to any child objects.
POST Country/
Create a new instance of the Country object.
PUT Country/{id}
Update an existing instance of the Country object.

Properties

Property Details

identity READ-ONLY	"identity": 0 Type: Number This is the unique numeric identifier for the Country
name	"name": "United States of America" Type: String User Defined name for the Country
sortOrder	"sortOrder": 15 Type: Number Unused
ownerId READ-ONLY	"ownerId": 17 Type: Number Unique identifier for the associated Owner object.
ownerName READ-ONLY	"ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property.
countryAddressFormatId	"countryAddressFormatId": 10 Type: Number Unique identifier for the associated CountryAddressFormat object.
countryAddressFormatName	"countryAddressFormatName": "Sample Name" Type: String The name of the object associated with the countryAddressFormatId property.
countryCode	"countryCode": "US" Type: String The ISO code for the country
isVisible	"isVisible": true Type: Boolean Internal flag representing if this country is visible in the user interface.

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. 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	Country/{id}
Delete an instance of the Country object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system.
{id}	Unique identifier for the Country object.
Delete an instance of the Country object. DELETE Country/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "delete", "results": { "totalCount": 4, "items": [ { "identity": 1, "action": "deleted", "dtoTypeKey": "country" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the Country objects.

GET Country/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "United States of America",
            "sortOrder": 4,
            "ownerId": 5,
            "ownerName": "Sample Text Data",
            "countryAddressFormatId": 11,
            "countryAddressFormatName": "Sample Text Data",
            "countryCode": "US",
            "isVisible": true
        }
    ]
}

Retrieve all of the Country objects in a paged fashion. This endpoint implements pagination for its results. Individual pages can be requested to return a particular paged set in the list of results. To learn more, see details on working with paginated endpoints.

Retrieve all of the Country objects in a paged fashion.

GET Country/Paged

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "United States of America",
                "sortOrder": 16,
                "ownerId": 26,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 18,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}

Retrieve all of the Country objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.

Retrieve all of the Country objects in a paged fashion with all object details.

GET Country/Paged/Detail

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "pagination": {
        "pageNumber": 1,
        "pageSize": 20,
        "excludeTotalCount": false
    },
    "pagedResults": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "United States of America",
                "sortOrder": 6,
                "ownerId": 13,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 13,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true,
                "details": {
                    "states": [
                        {
                            "identity": 0,
                            "countryId": 52,
                            "countryName": "Sample Text Data",
                            "name": "Sample Text Data",
                            "sortOrder": 3,
                            "code": "Sample Text Data",
                            "isVisible": true,
                            "countryCode": "Sample Text Data"
                        }
                    ]
                }
            }
        ]
    }
}

GET	Country/{id}
Retrieve an instance of the Country object by its ID.
{id}	Unique identifier for the Country object.
Retrieve an instance of the Country object by its ID. GET Country/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "United States of America", "sortOrder": 26, "ownerId": 25, "ownerName": "Sample Text Data", "countryAddressFormatId": 7, "countryAddressFormatName": "Sample Text Data", "countryCode": "US", "isVisible": true } }

GET	Country/{id}/Detail
Retrieve deep detail of the Country object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}	Unique identifier for the Country object.
Retrieve deep detail of the Country object by its ID. GET Country/{id}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "United States of America", "sortOrder": 12, "ownerId": 13, "ownerName": "Sample Text Data", "countryAddressFormatId": 24, "countryAddressFormatName": "Sample Text Data", "countryCode": "US", "isVisible": true, "details": { "states": [ { "identity": 0, "countryId": 52, "countryName": "Sample Text Data", "name": "Sample Text Data", "sortOrder": 3, "code": "Sample Text Data", "isVisible": true, "countryCode": "Sample Text Data" } ] } } }

PATCH	Country/{id}
Update or Add the Country object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}	Unique identifier for the Country object.
Update or Add the Country object and optionally make changes to any child objects. PATCH Country/{id} { "details": {}, "countrys": { "items": [ { "patchType": "create", "patchClientId": 1, "name": "United States of America", "sortOrder": 25, "countryAddressFormatId": 23, "countryCode": "US", "isVisible": true } ] } } View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "type": "patch", "results": { "totalCount": 1, "items": [ { "identity": 1, "action": "created", "dtoTypeKey": "country", "instance": { "identity": 1, "name": "United States of America", "sortOrder": 7, "ownerId": 18, "ownerName": "Sample Text Data", "countryAddressFormatId": 14, "countryAddressFormatName": "Sample Text Data", "countryCode": "US", "isVisible": true } } ] } }

Create a new instance of the Country object.

POST Country/

{
    "name": "United States of America",
    "sortOrder": 6,
    "countryAddressFormatId": 0,
    "countryCode": "US",
    "isVisible": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "United States of America",
                "sortOrder": 12,
                "ownerId": 24,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 12,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}

Update an existing instance of the Country object.

PUT Country/{id}

{
    "identity": 1,
    "name": "United States of America",
    "sortOrder": 0,
    "countryAddressFormatId": 8,
    "countryCode": "US",
    "isVisible": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "United States of America",
                "sortOrder": 19,
                "ownerId": 27,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 5,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}