State

(API Version v8)

The regional states defined in the system.

What can you do with State?

GET State/
Retrieve all of the State objects.
GET State/Paged
Retrieve all of the State objects in a paged fashion.
GET State/{id}
Retrieve an instance of the State object by its ID.

Properties

Property Details

identity READ-ONLY	"identity": 18 Type: Number This is the unique numeric identifier for the State
countryId	"countryId": 4 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": "California" Type: String The name of the regional state.
sortOrder	"sortOrder": 1 Type: Number The sort order of the state data.
code	"code": "CA" Type: String A shortcode representing the state.
isVisible	"isVisible": true Type: Boolean Whether the state is visible or not.
ownerId READ-ONLY	"ownerId": 1 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

Retrieve all of the State objects.

GET State/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "countryId": 24,
            "countryName": "Sample Text Data",
            "name": "California",
            "sortOrder": "1",
            "code": "CA",
            "isVisible": true,
            "ownerId": 11,
            "ownerName": "Sample Text Data"
        }
    ]
}

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

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": 3,
                "countryName": "Sample Text Data",
                "name": "California",
                "sortOrder": "1",
                "code": "CA",
                "isVisible": true,
                "ownerId": 8,
                "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} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "countryId": 19, "countryName": "Sample Text Data", "name": "California", "sortOrder": "1", "code": "CA", "isVisible": true, "ownerId": 22, "ownerName": "Sample Text Data" } }