TAG LINE
SMALL TITLE

Usage / Class / Dynamic / Rule

(API Version v3)


Defines a rule used with a Dynamic Usage Class.


What can you do with UsageClassDynamicRule?


Properties

Property Details
identity
READ-ONLY
"identity": 5
Type: Number
This is the unique numeric identifier for the UsageClassDynamicRule
usageClassDynamicId
"usageClassDynamicId": 7
Type: Number
Unique identifier for the associated UsageClassDynamic object.
usageClassDynamicName
"usageClassDynamicName": "Sample Name"
Type: String
The name of the object associated with the usageClassDynamicId property.
extensionAttributeListItemId
"extensionAttributeListItemId": 24
Type: Number
A specified user defined Mediation field in the usage feed to be used as part of this rule.

Unique identifier for the associated ExtensionAttributeListItem object.
extensionAttributeListItemName
"extensionAttributeListItemName": "Sample Name"
Type: String
The name of the object associated with the extensionAttributeListItemId property.
geoTreeLocationGroupId
"geoTreeLocationGroupId": 17
Type: Number
Unique identifier for the associated GeoTreeLocationGroup object.
geoTreeLocationGroupName
"geoTreeLocationGroupName": "Sample Name"
Type: String
The name of the object associated with the geoTreeLocationGroupId property.
usageClassId
"usageClassId": 12
Type: Number
Unique identifier for the associated UsageClass object.
usageClassName
"usageClassName": "Sample Name"
Type: String
The name of the object associated with the usageClassId property.
sortOrder
READ-ONLY
"sortOrder": 1
Type: Number
Unused


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:

  • usageClassDynamicId
  • extensionAttributeListItemId
  • geoTreeLocationGroupId
  • usageClassId
  • sortOrder

End Points

GETapi/v3/Usage/Class/Dynamic/Rule/
Retrieve all of the UsageClassDynamicRule objects.
Retrieve all of the UsageClassDynamicRule objects.
GET api/v3/Usage/Class/Dynamic/Rule/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "usageClassDynamicId": 18,
            "usageClassDynamicName": "Sample Text Data",
            "extensionAttributeListItemId": 26,
            "extensionAttributeListItemName": "Sample Text Data",
            "geoTreeLocationGroupId": 21,
            "geoTreeLocationGroupName": "Sample Text Data",
            "usageClassId": 2,
            "usageClassName": "Sample Text Data",
            "sortOrder": 4
        }
    ]
}
GETapi/v3/Usage/Class/Dynamic/Rule/Paged
Retrieve all of the UsageClassDynamicRule 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 UsageClassDynamicRule objects in a paged fashion.
GET api/v3/Usage/Class/Dynamic/Rule/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,
                "usageClassDynamicId": 14,
                "usageClassDynamicName": "Sample Text Data",
                "extensionAttributeListItemId": 25,
                "extensionAttributeListItemName": "Sample Text Data",
                "geoTreeLocationGroupId": 13,
                "geoTreeLocationGroupName": "Sample Text Data",
                "usageClassId": 4,
                "usageClassName": "Sample Text Data",
                "sortOrder": 12
            }
        ]
    }
}
GETapi/v3/Usage/Class/Dynamic/Rule/{id}
Retrieve an instance of the UsageClassDynamicRule object by its ID.
{id}Unique identifier for the UsageClassDynamicRule object.
Retrieve an instance of the UsageClassDynamicRule object by its ID.
GET api/v3/Usage/Class/Dynamic/Rule/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "usageClassDynamicId": 8,
        "usageClassDynamicName": "Sample Text Data",
        "extensionAttributeListItemId": 10,
        "extensionAttributeListItemName": "Sample Text Data",
        "geoTreeLocationGroupId": 19,
        "geoTreeLocationGroupName": "Sample Text Data",
        "usageClassId": 1,
        "usageClassName": "Sample Text Data",
        "sortOrder": 14
    }
}