TAG LINE
TAG LINE
SMALL TITLE

Country

(API Version v7)


This entity contains a list of country definitions.


What can you do with Country?

  • DELETE Country/{id}
    Delete an instance of the Country object.

  • DELETE Country/{id}
    Delete an instance of the Country object.

  • DELETE Country/{id}
    Delete an instance of the Country object.

  • DELETE Country/{id}
    Delete an instance of the Country object.

  • DELETE Country/{id}
    Delete an instance of the Country object.

  • GET Country/
    Retrieve all of the Country objects.

  • GET Country/
    Retrieve all of the Country objects.

  • GET Country/
    Retrieve all of the Country objects.

  • GET Country/
    Retrieve all of the Country objects.

  • GET Country/
    Retrieve all of the Country objects.

  • GET Country/Metadata
    Retrieve all of the Country objects.

  • GET Country/Metadata/sql
    Retrieve all of the Country objects.

  • GET Country/Paged
    Retrieve all of the Country objects in a paged fashion.

  • GET Country/Paged
    Retrieve all of the Country objects in a paged fashion.

  • GET Country/Paged
    Retrieve all of the Country objects in a paged fashion.

  • GET Country/Paged
    Retrieve all of the Country objects in a paged fashion.

  • 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/Paged/Detail
    Retrieve all of the Country objects in a paged fashion with all object details.

  • GET Country/Paged/Detail
    Retrieve all of the Country objects in a paged fashion with all object details.

  • GET Country/Paged/Detail
    Retrieve all of the Country objects in a paged fashion with all object details.

  • 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}
    Retrieve an instance of the Country object by its ID.

  • GET Country/{id}
    Retrieve an instance of the Country object by its ID.

  • GET Country/{id}
    Retrieve an instance of the Country object by its ID.

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

  • GET Country/{id}/Detail
    Retrieve deep detail of the Country object by its ID.

  • GET Country/{id}/Detail
    Retrieve deep detail of the Country object by its ID.

  • GET Country/{id}/Detail
    Retrieve deep detail 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.

  • PATCH Country/{id}
    Update or Add the Country object and optionally make changes to any child objects.

  • PATCH Country/{id}
    Update or Add the Country object and optionally make changes to any child objects.

  • PATCH Country/{id}
    Update or Add the Country object and optionally make changes to any child objects.

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

  • POST Country/
    Create a new instance of the Country object.

  • POST Country/
    Create a new instance of the Country object.

  • POST Country/
    Create a new instance of the Country object.

  • POST Country/
    Create a new instance of the Country object.

  • PUT Country/{id}
    Update an existing instance of the Country object.

  • PUT Country/{id}
    Update an existing instance of the Country object.

  • PUT Country/{id}
    Update an existing instance of the Country object.

  • PUT Country/{id}
    Update an existing instance of the Country object.

  • PUT Country/{id}
    Update an existing instance of the Country object.


Properties

Property Details
identity
READ-ONLY
"identity": 12
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": 11
Type: Number
Unused
ownerId
READ-ONLY
"ownerId": 16
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": 17
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 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

DELETECountry/{id}
Delete an instance of the Country object. Upon successful delete, this API will return a record of all of the reelated 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"
            }
        ]
    }
}
DELETECountry/{id}
Delete an instance of the Country object. Upon successful delete, this API will return a record of all of the reelated 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"
            }
        ]
    }
}
DELETECountry/{id}
Delete an instance of the Country object. Upon successful delete, this API will return a record of all of the reelated 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"
            }
        ]
    }
}
DELETECountry/{id}
Delete an instance of the Country object. Upon successful delete, this API will return a record of all of the reelated 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"
            }
        ]
    }
}
DELETECountry/{id}
Delete an instance of the Country object. Upon successful delete, this API will return a record of all of the reelated 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"
            }
        ]
    }
}
GETCountry/
Retrieve all of the Country objects.
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": 26,
            "ownerId": 19,
            "ownerName": "Sample Text Data",
            "countryAddressFormatId": 21,
            "countryAddressFormatName": "Sample Text Data",
            "countryCode": "US",
            "isVisible": true
        }
    ]
}
GETCountry/
Retrieve all of the Country objects.
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": 20,
            "ownerId": 19,
            "ownerName": "Sample Text Data",
            "countryAddressFormatId": 21,
            "countryAddressFormatName": "Sample Text Data",
            "countryCode": "US",
            "isVisible": true
        }
    ]
}
GETCountry/
Retrieve all of the Country objects.
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": 0,
            "ownerId": 12,
            "ownerName": "Sample Text Data",
            "countryAddressFormatId": 26,
            "countryAddressFormatName": "Sample Text Data",
            "countryCode": "US",
            "isVisible": true
        }
    ]
}
GETCountry/
Retrieve all of the Country objects.
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": 12,
            "ownerId": 10,
            "ownerName": "Sample Text Data",
            "countryAddressFormatId": 8,
            "countryAddressFormatName": "Sample Text Data",
            "countryCode": "US",
            "isVisible": true
        }
    ]
}
GETCountry/
Retrieve all of the Country objects.
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": 5,
            "ownerId": 2,
            "ownerName": "Sample Text Data",
            "countryAddressFormatId": 0,
            "countryAddressFormatName": "Sample Text Data",
            "countryCode": "US",
            "isVisible": true
        }
    ]
}
GETCountry/Metadata
Retrieve all of the Country objects.
Retrieve all of the Country objects.
GET Country/Metadata
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": 6,
            "ownerId": 14,
            "ownerName": "Sample Text Data",
            "countryAddressFormatId": 27,
            "countryAddressFormatName": "Sample Text Data",
            "countryCode": "US",
            "isVisible": true
        }
    ]
}
GETCountry/Metadata/sql
Retrieve all of the Country objects.
Retrieve all of the Country objects.
GET Country/Metadata/sql
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": 20,
            "ownerId": 2,
            "ownerName": "Sample Text Data",
            "countryAddressFormatId": 22,
            "countryAddressFormatName": "Sample Text Data",
            "countryCode": "US",
            "isVisible": true
        }
    ]
}
GETCountry/Paged
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": 27,
                "ownerId": 1,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 11,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
GETCountry/Paged
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": 0,
                "ownerId": 10,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 22,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
GETCountry/Paged
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": 22,
                "ownerId": 13,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 11,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
GETCountry/Paged
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": 9,
                "ownerId": 21,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 23,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
GETCountry/Paged
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": 6,
                "ownerId": 1,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 10,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
GETCountry/Paged/Detail
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": 8,
                "ownerId": 13,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 16,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETCountry/Paged/Detail
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": 24,
                "ownerId": 14,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 23,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETCountry/Paged/Detail
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": 14,
                "ownerId": 24,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 14,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETCountry/Paged/Detail
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": 23,
                "ownerId": 0,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 27,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETCountry/Paged/Detail
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": 24,
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 9,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETCountry/{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": 22,
        "ownerId": 19,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 26,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true
    }
}
GETCountry/{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": 20,
        "ownerId": 26,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 20,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true
    }
}
GETCountry/{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": 0,
        "ownerId": 18,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 24,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true
    }
}
GETCountry/{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": 15,
        "ownerId": 22,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 2,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true
    }
}
GETCountry/{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": 3,
        "ownerId": 13,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 26,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true
    }
}
GETCountry/{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": 11,
        "ownerId": 7,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 17,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
GETCountry/{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": 18,
        "ownerId": 11,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 4,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
GETCountry/{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": 1,
        "ownerId": 22,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 14,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
GETCountry/{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": 17,
        "ownerId": 19,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 10,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
GETCountry/{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": 0,
        "ownerId": 16,
        "ownerName": "Sample Text Data",
        "countryAddressFormatId": 9,
        "countryAddressFormatName": "Sample Text Data",
        "countryCode": "US",
        "isVisible": true,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHCountry/{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": 9,
                "countryAddressFormatId": 14,
                "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": 5,
                    "ownerId": 27,
                    "ownerName": "Sample Text Data",
                    "countryAddressFormatId": 23,
                    "countryAddressFormatName": "Sample Text Data",
                    "countryCode": "US",
                    "isVisible": true
                }
            }
        ]
    }
}
PATCHCountry/{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": 23,
                "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": 9,
                    "ownerId": 8,
                    "ownerName": "Sample Text Data",
                    "countryAddressFormatId": 4,
                    "countryAddressFormatName": "Sample Text Data",
                    "countryCode": "US",
                    "isVisible": true
                }
            }
        ]
    }
}
PATCHCountry/{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": 20,
                "countryAddressFormatId": 22,
                "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": 26,
                    "ownerId": 21,
                    "ownerName": "Sample Text Data",
                    "countryAddressFormatId": 11,
                    "countryAddressFormatName": "Sample Text Data",
                    "countryCode": "US",
                    "isVisible": true
                }
            }
        ]
    }
}
PATCHCountry/{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": 18,
                "countryAddressFormatId": 24,
                "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": 22,
                    "ownerId": 7,
                    "ownerName": "Sample Text Data",
                    "countryAddressFormatId": 5,
                    "countryAddressFormatName": "Sample Text Data",
                    "countryCode": "US",
                    "isVisible": true
                }
            }
        ]
    }
}
PATCHCountry/{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": 17,
                "countryAddressFormatId": 12,
                "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": 6,
                    "ownerId": 7,
                    "ownerName": "Sample Text Data",
                    "countryAddressFormatId": 21,
                    "countryAddressFormatName": "Sample Text Data",
                    "countryCode": "US",
                    "isVisible": true
                }
            }
        ]
    }
}
POSTCountry/
Create a new instance of the Country object.
Create a new instance of the Country object.
POST Country/

{
    "name": "United States of America",
    "sortOrder": 20,
    "countryAddressFormatId": 26,
    "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": 6,
                "ownerId": 10,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 25,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
POSTCountry/
Create a new instance of the Country object.
Create a new instance of the Country object.
POST Country/

{
    "name": "United States of America",
    "sortOrder": 2,
    "countryAddressFormatId": 11,
    "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": 10,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 27,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
POSTCountry/
Create a new instance of the Country object.
Create a new instance of the Country object.
POST Country/

{
    "name": "United States of America",
    "sortOrder": 8,
    "countryAddressFormatId": 21,
    "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": 3,
                "ownerId": 4,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 5,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
POSTCountry/
Create a new instance of the Country object.
Create a new instance of the Country object.
POST Country/

{
    "name": "United States of America",
    "sortOrder": 3,
    "countryAddressFormatId": 21,
    "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": 4,
                "ownerId": 12,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 4,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
POSTCountry/
Create a new instance of the Country object.
Create a new instance of the Country object.
POST Country/

{
    "name": "United States of America",
    "sortOrder": 11,
    "countryAddressFormatId": 10,
    "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": 13,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 18,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
PUTCountry/{id}
Update an existing instance of the Country object.
Update an existing instance of the Country object.
PUT Country/{id}

{
    "identity": 1,
    "name": "United States of America",
    "sortOrder": 10,
    "countryAddressFormatId": 23,
    "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": 7,
                "ownerId": 26,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 21,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
PUTCountry/{id}
Update an existing instance of the Country object.
Update an existing instance of the Country object.
PUT Country/{id}

{
    "identity": 1,
    "name": "United States of America",
    "sortOrder": 4,
    "countryAddressFormatId": 7,
    "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": 11,
                "ownerId": 2,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 24,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
PUTCountry/{id}
Update an existing instance of the Country object.
Update an existing instance of the Country object.
PUT Country/{id}

{
    "identity": 1,
    "name": "United States of America",
    "sortOrder": 5,
    "countryAddressFormatId": 16,
    "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": 25,
                "ownerId": 7,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 10,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
PUTCountry/{id}
Update an existing instance of the Country object.
Update an existing instance of the Country object.
PUT Country/{id}

{
    "identity": 1,
    "name": "United States of America",
    "sortOrder": 13,
    "countryAddressFormatId": 14,
    "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": 17,
                "ownerId": 4,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 25,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}
PUTCountry/{id}
Update an existing instance of the Country object.
Update an existing instance of the Country object.
PUT Country/{id}

{
    "identity": 1,
    "name": "United States of America",
    "sortOrder": 6,
    "countryAddressFormatId": 9,
    "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": 10,
                "ownerId": 0,
                "ownerName": "Sample Text Data",
                "countryAddressFormatId": 24,
                "countryAddressFormatName": "Sample Text Data",
                "countryCode": "US",
                "isVisible": true
            }
        ]
    }
}