TAG LINE
TAG LINE
SMALL TITLE
Represents an internal Category such as "share plan", "default" etc.
identity READ-ONLY | "identity": 18 Type: Number This is the unique numeric identifier for the ServiceCategory |
name READ-ONLY | "name": "Share Plan" Type: String System defined name for the Category. |
sortOrder READ-ONLY | "sortOrder": 12 Type: Number Unused |
visible READ-ONLY | "visible": true Type: Boolean Whether or not this is visible to the user interface. |
| GET | Service/Category/ |
| Retrieve all of the ServiceCategory objects. | |
Retrieve all of the ServiceCategory objects. GET Service/Category/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Share Plan",
"sortOrder": 20,
"visible": true
}
]
} | |
| GET | Service/Category/Paged |
| Retrieve all of the ServiceCategory 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 ServiceCategory objects in a paged fashion. GET Service/Category/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": "Share Plan",
"sortOrder": 13,
"visible": true
}
]
}
} | |
| GET | Service/Category/{id} |
| Retrieve an instance of the ServiceCategory object by its ID. | |
| {id} | Unique identifier for the ServiceCategory object. |
Retrieve an instance of the ServiceCategory object by its ID. GET Service/Category/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Share Plan",
"sortOrder": 6,
"visible": true
}
} | |