TAG LINE
TAG LINE
SMALL TITLE
Represents an internal category for a Package. Examples are "share plan", "billing activation", "one time billing" etc.. These are typically represented by check boxes during configuration.
identity READ-ONLY | "identity": 2 Type: Number This is the unique numeric identifier for the PackageCategory |
name READ-ONLY | "name": "Billing Activation" Type: String System defined name for the Package Category. |
sortOrder READ-ONLY | "sortOrder": 11 Type: Number Unused |
visible READ-ONLY | "visible": true Type: Boolean System value representing whether or not this Package Category is visible in the user interface. |
| GET | Package/Category/ |
| Retrieve all of the PackageCategory objects. | |
Retrieve all of the PackageCategory objects. GET Package/Category/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Billing Activation",
"sortOrder": 27,
"visible": true
}
]
} | |
| GET | Package/Category/Paged |
| Retrieve all of the PackageCategory 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 PackageCategory objects in a paged fashion. GET Package/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": "Billing Activation",
"sortOrder": 6,
"visible": true
}
]
}
} | |
| GET | Package/Category/{id} |
| Retrieve an instance of the PackageCategory object by its ID. | |
| {id} | Unique identifier for the PackageCategory object. |
Retrieve an instance of the PackageCategory object by its ID. GET Package/Category/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Billing Activation",
"sortOrder": 19,
"visible": true
}
} | |