TAG LINE
TAG LINE
SMALL TITLE

Service / Category

(API Version v5)


Represents an internal Category such as "share plan", "default" etc.


What can you do with ServiceCategory?


Properties

Property Details
identity
READ-ONLY
"identity": 10
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": 4
Type: Number
Unused
visible
READ-ONLY
"visible": true
Type: Boolean
Whether or not this is visible to the user interface.


End Points

GETService/Category/
Retrieve all of the ServiceCategory objects.
Retrieve all of the ServiceCategory objects.
GET Service/Category/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Share Plan",
            "sortOrder": 27,
            "visible": true
        }
    ]
}
GETService/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
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,
                "name": "Share Plan",
                "sortOrder": 10,
                "visible": true
            }
        ]
    }
}
GETService/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}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Share Plan",
        "sortOrder": 12,
        "visible": true
    }
}