TAG LINE
SMALL TITLE

Service / Category

(API Version v2)


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


What can you do with ServiceCategory?


Properties

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


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.

Field List:

  • name
  • sortOrder
  • visible

End Points

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