TAG LINE
TAG LINE
SMALL TITLE
The status types defined in the system.
identity READ-ONLY | "identity": 25 Type: Number This is the unique numeric identifier for the StatusType |
name | "name": "Active" Type: String The name of the Status Type. |
GET | StatusType/ |
Retrieve all of the StatusType objects. | |
Retrieve all of the StatusType objects. GET StatusType/ HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "totalCount": 1, "items": [ { "identity": 1, "name": "Active" } ] } |
GET | StatusType/Paged |
Retrieve all of the StatusType 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 StatusType objects in a paged fashion. GET StatusType/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, "name": "Active" } ] } } |
GET | StatusType/{id} |
Retrieve an instance of the StatusType object by its ID. | |
{id} | Unique identifier for the StatusType object. |
Retrieve an instance of the StatusType object by its ID. GET StatusType/{id} HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "name": "Active" } } |