TAG LINE
TAG LINE
SMALL TITLE
date | "date": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
udrIdentifierTypeId | "udrIdentifierTypeId": 15 Type: Number Unique identifier for the associated UDRIdentifierType object. |
udrName | "udrName": "Sample Name" Type: String The name of the object associated with the udrIdentifierTypeId property. |
originatingIdentifier | "originatingIdentifier": "Hello World" Type: String |
terminatingIdentifier | "terminatingIdentifier": "Hello World" Type: String |
udrUsageIdentifier | "udrUsageIdentifier": "Hello World" Type: String |
value | "value": "Hello World" Type: String |
reverseRating | "reverseRating": true Type: Boolean |
usageClassId | "usageClassId": 21 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. |
usageClassGroupTypeId | "usageClassGroupTypeId": 13 Type: Number Unique identifier for the associated UsageClassGroupType object. |
usageClassGroupTypeName | "usageClassGroupTypeName": "Sample Name" Type: String The name of the object associated with the usageClassGroupTypeId property. |
uniquenessIdentifier | "uniquenessIdentifier": "Hello World" Type: String |
usageClassTypeId | "usageClassTypeId": 3 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. |
importBatchId | "importBatchId": 24 Type: Number Unique identifier for the associated ImportBatch object. |
importBatchName | "importBatchName": "Sample Name" Type: String The name of the object associated with the importBatchId property. |
usageBill | "usageBill": "2021-04-26T15:25:27.587Z" Type: Date Date and time values are specified in the ISO 8601 format. |
inbound | "inbound": true Type: Boolean |
candidateTerminatingIdentifiers | "candidateTerminatingIdentifiers": "Hello World" Type: String |
primaryDataRow | "primaryDataRow": 18 Type: Number |
charge | "charge": 7 Type: Number |
serviceTaxCategoryId | "serviceTaxCategoryId": 9 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. |
id | "id": "Hello World" Type: String |
id | "id": "Hello World" Type: String |
| DELETE | Udr/Mediated/{id} |
| Delete an instance of the UDRMediated object. Upon successful delete, this API will return a record of all of the reelated 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 UDRMediated object. |
Delete an instance of the UDRMediated object. DELETE Udr/Mediated/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "udrMediated"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | Udr/Mediated/ |
| Retrieve all of the UDRMediated objects. | |
Retrieve all of the UDRMediated objects. GET Udr/Mediated/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 12,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 18,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 19,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 27,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 19,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 8,
"charge": 3,
"serviceTaxCategoryId": 1,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
]
} | |
| GET | Udr/Mediated/Metadata |
| Retrieve all of the UDRMediated objects. | |
Retrieve all of the UDRMediated objects. GET Udr/Mediated/Metadata HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 12,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 16,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 27,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 16,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 2,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 0,
"charge": 18,
"serviceTaxCategoryId": 18,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
]
} | |
| GET | Udr/Mediated/Metadata/sql |
| Retrieve all of the UDRMediated objects. | |
Retrieve all of the UDRMediated objects. GET Udr/Mediated/Metadata/sql HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 15,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 10,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 10,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 16,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 2,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 5,
"charge": 18,
"serviceTaxCategoryId": 18,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
]
} | |
| GET | Udr/Mediated/Paged |
| Retrieve all of the UDRMediated 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 UDRMediated objects in a paged fashion. GET Udr/Mediated/Paged HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 23,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 18,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 12,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 21,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 9,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 25,
"charge": 6,
"serviceTaxCategoryId": 19,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |
| GET | Udr/Mediated/{id} |
| Retrieve an instance of the UDRMediated object by its ID. | |
| {id} | Unique identifier for the UDRMediated object. |
Retrieve an instance of the UDRMediated object by its ID. GET Udr/Mediated/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 22,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 8,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 23,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 7,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 12,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 26,
"charge": 7,
"serviceTaxCategoryId": 15,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
} | |
| GET | Udr/Mediated/{id} |
| Retrieve an instance of the UDRMediated object by its ID. | |
| {id} | Unique identifier for the UDRMediated object. |
Retrieve an instance of the UDRMediated object by its ID. GET Udr/Mediated/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 15,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 14,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 24,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 22,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 19,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 6,
"charge": 10,
"serviceTaxCategoryId": 9,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
} | |
| GET | Udr/Mediated/{id} |
| Retrieve an instance of the UDRMediated object by its ID. | |
| {id} | Unique identifier for the UDRMediated object. |
Retrieve an instance of the UDRMediated object by its ID. GET Udr/Mediated/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 15,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 1,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 26,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 11,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 10,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 20,
"charge": 23,
"serviceTaxCategoryId": 11,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
} | |
| GET | Udr/Mediated/{id} |
| Retrieve an instance of the UDRMediated object by its ID. | |
| {id} | Unique identifier for the UDRMediated object. |
Retrieve an instance of the UDRMediated object by its ID. GET Udr/Mediated/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 7,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 26,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 4,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 8,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 21,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 18,
"charge": 19,
"serviceTaxCategoryId": 0,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
} | |
| GET | Udr/Mediated/{id} |
| Retrieve an instance of the UDRMediated object by its ID. | |
| {id} | Unique identifier for the UDRMediated object. |
Retrieve an instance of the UDRMediated object by its ID. GET Udr/Mediated/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 17,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 8,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 14,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 10,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 15,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 25,
"charge": 15,
"serviceTaxCategoryId": 27,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
} | |
| POST | Udr/Mediated/ |
| Create a new instance of the UDRMediated object. | |
Create a new instance of the UDRMediated object. POST Udr/Mediated/
{
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 6,
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 7,
"usageClassGroupTypeId": 15,
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 10,
"importBatchId": 18,
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 9,
"charge": 4,
"serviceTaxCategoryId": 3,
"id": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 25,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 23,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 23,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 1,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 10,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 11,
"charge": 19,
"serviceTaxCategoryId": 14,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |
| PUT | Udr/Mediated/{id} |
| Update an existing instance of the UDRMediated object. | |
Update an existing instance of the UDRMediated object. PUT Udr/Mediated/{id}
{
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 20,
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 19,
"usageClassGroupTypeId": 22,
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 17,
"importBatchId": 1,
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 18,
"charge": 1,
"serviceTaxCategoryId": 25,
"id": "Sample Text Data"
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"date": "2021-04-26T15:25:27.587Z",
"udrIdentifierTypeId": 3,
"udrName": "Sample Text Data",
"originatingIdentifier": "Sample Text Data",
"terminatingIdentifier": "Sample Text Data",
"udrUsageIdentifier": "Sample Text Data",
"value": "Sample Text Data",
"reverseRating": true,
"usageClassId": 24,
"usageClassName": "Sample Text Data",
"usageClassGroupTypeId": 20,
"usageClassGroupTypeName": "Sample Text Data",
"uniquenessIdentifier": "Sample Text Data",
"usageClassTypeId": 11,
"usageClassTypeName": "Sample Text Data",
"importBatchId": 25,
"importBatchName": "Sample Text Data",
"usageBill": "2021-04-26T15:25:27.587Z",
"inbound": true,
"candidateTerminatingIdentifiers": "Sample Text Data",
"primaryDataRow": 6,
"charge": 8,
"serviceTaxCategoryId": 7,
"serviceTaxCategoryName": "Sample Text Data",
"id": "Sample Text Data"
}
]
}
} | |