TAG LINE
TAG LINE
SMALL TITLE
Defines a clasification of usage records which will determine the rules for how this type of usage will be rated.
identity READ-ONLY | "identity": 21 Type: Number This is the unique numeric identifier for the UsageClass |
name | "name": "Roaming Voice" Type: String The user defined name for this Usage Class. |
usageRaterTypeId | "usageRaterTypeId": 23 Type: Number Unique identifier for the associated UsageRaterType object. |
usageRaterTypeName | "usageRaterTypeName": "Sample Name" Type: String The name of the object associated with the usageRaterTypeId property. |
usageBaseUnitId | "usageBaseUnitId": 27 Type: Number Unique identifier for the associated UsageBaseUnit object. |
usageBaseUnitName | "usageBaseUnitName": "Sample Name" Type: String The name of the object associated with the usageBaseUnitId property. |
usageClassTypeId | "usageClassTypeId": 19 Type: Number Unique identifier for the associated UsageClassType object. |
usageClassTypeName | "usageClassTypeName": "Sample Name" Type: String The name of the object associated with the usageClassTypeId property. |
serviceTaxCategoryId | "serviceTaxCategoryId": 4 Type: Number Unique identifier for the associated ServiceTaxCategory object. |
serviceTaxCategoryName | "serviceTaxCategoryName": "Sample Name" Type: String The name of the object associated with the serviceTaxCategoryId property. |
| DELETE | Usage/Class/{id} |
| Delete an instance of the UsageClass object. Upon successful delete, this API will return a record of all of the related objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the UsageClass object. |
Delete an instance of the UsageClass object. DELETE Usage/Class/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "usageClass"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Usage/Class/ |
| Retrieve all of the UsageClass objects. | |
Retrieve all of the UsageClass objects. GET Usage/Class/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Roaming Voice",
"usageRaterTypeId": 25,
"usageRaterTypeName": "Sample Text Data",
"usageBaseUnitId": 13,
"usageBaseUnitName": "Sample Text Data",
"usageClassTypeId": 20,
"usageClassTypeName": "Sample Text Data",
"serviceTaxCategoryId": 5,
"serviceTaxCategoryName": "Sample Text Data"
}
]
} | |
| GET | Usage/Class/AvailableFor/RateGroup/{id}/BaseUnit/{usageBaseUnitId} |
| For a given RateGroup and BaseUnit return the UsageClass objects that are available. | |
| {id} | Unique identifier for the RateGroup object. |
| {usageBaseUnitId} | Unique identifier for the BaseUnit object. |
| GET | Usage/Class/Paged |
| Retrieve all of the UsageClass 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 UsageClass objects in a paged fashion. GET Usage/Class/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": "Roaming Voice",
"usageRaterTypeId": 19,
"usageRaterTypeName": "Sample Text Data",
"usageBaseUnitId": 26,
"usageBaseUnitName": "Sample Text Data",
"usageClassTypeId": 23,
"usageClassTypeName": "Sample Text Data",
"serviceTaxCategoryId": 1,
"serviceTaxCategoryName": "Sample Text Data"
}
]
}
} | |
| GET | Usage/Class/{id} |
| Retrieve an instance of the UsageClass object by its ID. | |
| {id} | Unique identifier for the UsageClass object. |
Retrieve an instance of the UsageClass object by its ID. GET Usage/Class/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Roaming Voice",
"usageRaterTypeId": 7,
"usageRaterTypeName": "Sample Text Data",
"usageBaseUnitId": 26,
"usageBaseUnitName": "Sample Text Data",
"usageClassTypeId": 6,
"usageClassTypeName": "Sample Text Data",
"serviceTaxCategoryId": 24,
"serviceTaxCategoryName": "Sample Text Data"
}
} | |
| POST | Usage/Class/ |
| Create a new instance of the UsageClass object. | |
Create a new instance of the UsageClass object. POST Usage/Class/
{
"name": "Roaming Voice",
"usageRaterTypeId": 19,
"usageBaseUnitId": 7,
"usageClassTypeId": 27,
"serviceTaxCategoryId": 11
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Roaming Voice",
"usageRaterTypeId": 7,
"usageRaterTypeName": "Sample Text Data",
"usageBaseUnitId": 27,
"usageBaseUnitName": "Sample Text Data",
"usageClassTypeId": 18,
"usageClassTypeName": "Sample Text Data",
"serviceTaxCategoryId": 19,
"serviceTaxCategoryName": "Sample Text Data"
}
]
}
} | |
| PUT | Usage/Class/{id} |
| Update an existing instance of the UsageClass object. | |
Update an existing instance of the UsageClass object. PUT Usage/Class/{id}
{
"identity": 1,
"name": "Roaming Voice",
"usageRaterTypeId": 3,
"usageBaseUnitId": 2,
"usageClassTypeId": 23,
"serviceTaxCategoryId": 3
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Roaming Voice",
"usageRaterTypeId": 19,
"usageRaterTypeName": "Sample Text Data",
"usageBaseUnitId": 14,
"usageBaseUnitName": "Sample Text Data",
"usageClassTypeId": 21,
"usageClassTypeName": "Sample Text Data",
"serviceTaxCategoryId": 18,
"serviceTaxCategoryName": "Sample Text Data"
}
]
}
} | |