TAG LINE
SMALL TITLE

State

(API Version v4)


What can you do with State?


Properties

Property Details
identity
READ-ONLY
"identity": 19
Type: Number
This is the unique numeric identifier for the State
countryId
"countryId": 22
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": 5
Type: Number
code
"code": "Hello World"
Type: String
isVisible
"isVisible": true
Type: Boolean
ownerId
READ-ONLY
"ownerId": 14
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.


End Points

GETapi/v4/State/
Retrieve all of the State objects.
Retrieve all of the State objects.
GET api/v4/State/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "countryId": 4,
            "countryName": "Sample Text Data",
            "name": "Sample Text Data",
            "sortOrder": 21,
            "code": "Sample Text Data",
            "isVisible": true,
            "ownerId": 22,
            "ownerName": "Sample Text Data"
        }
    ]
}
GETapi/v4/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 api/v4/State/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,
                "countryId": 11,
                "countryName": "Sample Text Data",
                "name": "Sample Text Data",
                "sortOrder": 17,
                "code": "Sample Text Data",
                "isVisible": true,
                "ownerId": 8,
                "ownerName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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 api/v4/State/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "countryId": 19,
        "countryName": "Sample Text Data",
        "name": "Sample Text Data",
        "sortOrder": 6,
        "code": "Sample Text Data",
        "isVisible": true,
        "ownerId": 24,
        "ownerName": "Sample Text Data"
    }
}
POSTapi/v4/State/Search
Retreive a list of State objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of State objects based on search criteria.
POST api/v4/State/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "countryId": 9,
            "countryName": "Sample Text Data",
            "name": "Sample Text Data",
            "sortOrder": 23,
            "code": "Sample Text Data",
            "isVisible": true,
            "ownerId": 9,
            "ownerName": "Sample Text Data"
        }
    ]
}