TAG LINE
SMALL TITLE

Package / Category

(API Version v3)


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.


What can you do with PackageCategory?


Properties

Property Details
identity
READ-ONLY
"identity": 13
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": 23
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.


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/v3/Package/Category/
Retrieve all of the PackageCategory objects.
Retrieve all of the PackageCategory objects.
GET api/v3/Package/Category/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Billing Activation",
            "sortOrder": 26,
            "visible": true
        }
    ]
}
GETapi/v3/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 api/v3/Package/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": "Billing Activation",
                "sortOrder": 10,
                "visible": true
            }
        ]
    }
}
GETapi/v3/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 api/v3/Package/Category/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Billing Activation",
        "sortOrder": 17,
        "visible": true
    }
}