TAG LINE
TAG LINE
SMALL TITLE
identity READ-ONLY | "identity": 1 Type: Number This is the unique numeric identifier for the State |
countryId | "countryId": 1 Type: Number Unique identifier for the associated Country object. |
countryName | "countryName": "Sample Name" Type: String The name of the object associated with the countryId property. |
name | "name": "Hello World" Type: String |
sortOrder | "sortOrder": 10 Type: Number |
code | "code": "Hello World" Type: String |
isVisible | "isVisible": true Type: Boolean |
ownerId READ-ONLY | "ownerId": 10 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. |
GET | State/ |
Retrieve all of the State objects. | |
Retrieve all of the State objects. GET State/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "countryId": 5, "countryName": "Sample Text Data", "name": "Sample Text Data", "sortOrder": 20, "code": "Sample Text Data", "isVisible": true, "ownerId": 15, "ownerName": "Sample Text Data" } ] } |
GET | State/Paged |
Retrieve all of the State 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 State objects in a paged fashion. GET State/Paged HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "pagination": { "pageNumber": 1, "pageSize": 20, "excludeTotalCount": false }, "pagedResults": { "totalCount": 1, "items": [ { "identity": 1, "countryId": 11, "countryName": "Sample Text Data", "name": "Sample Text Data", "sortOrder": 2, "code": "Sample Text Data", "isVisible": true, "ownerId": 12, "ownerName": "Sample Text Data" } ] } } |
GET | State/{id} |
Retrieve an instance of the State object by its ID. | |
{id} | Unique identifier for the State object. |
Retrieve an instance of the State object by its ID. GET State/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "countryId": 7, "countryName": "Sample Text Data", "name": "Sample Text Data", "sortOrder": 9, "code": "Sample Text Data", "isVisible": true, "ownerId": 6, "ownerName": "Sample Text Data" } } |