TAG LINE
SMALL TITLE

Udr / Mediated

(API Version v4)


What can you do with UDRMediated?


Properties

Property Details
identity
READ-ONLY
"identity": "Hello World"
Type: String
This is the unique numeric identifier for the UDRMediated
date
"date": "2021-04-26T15:25:27.587Z"
Type: Date
Date and time values are specified in the ISO 8601 format.
udrIdentifierTypeId
"udrIdentifierTypeId": 18
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": 5
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": 0
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": 15
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.
dataImportHistoryId
"dataImportHistoryId": 0
Type: Number
Unique identifier for the associated DataImportHistory object.
dataImportHistoryName
"dataImportHistoryName": "Sample Name"
Type: String
The name of the object associated with the dataImportHistoryId 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": 20
Type: Number
charge
"charge": 5
Type: Number
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.
id
"id": "Hello World"
Type: String


End Points

GETapi/v4/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 api/v4/Udr/Mediated/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "date": "2021-04-26T15:25:27.587Z",
        "udrIdentifierTypeId": 20,
        "udrName": "Sample Text Data",
        "originatingIdentifier": "Sample Text Data",
        "terminatingIdentifier": "Sample Text Data",
        "udrUsageIdentifier": "Sample Text Data",
        "value": "Sample Text Data",
        "reverseRating": true,
        "usageClassId": 0,
        "usageClassName": "Sample Text Data",
        "usageClassGroupTypeId": 22,
        "usageClassGroupTypeName": "Sample Text Data",
        "uniquenessIdentifier": "Sample Text Data",
        "usageClassTypeId": 12,
        "usageClassTypeName": "Sample Text Data",
        "dataImportHistoryId": 27,
        "dataImportHistoryName": "Sample Text Data",
        "usageBill": "2021-04-26T15:25:27.587Z",
        "inbound": true,
        "candidateTerminatingIdentifiers": "Sample Text Data",
        "primaryDataRow": 12,
        "charge": 22,
        "serviceTaxCategoryId": 20,
        "serviceTaxCategoryName": "Sample Text Data",
        "id": "Sample Text Data"
    }
}
POSTapi/v4/Udr/Mediated/{id}Search
Retreive a list of UDRMediated objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of UDRMediated objects based on search criteria.
POST api/v4/Udr/Mediated/{id}Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "date": "2021-04-26T15:25:27.587Z",
            "udrIdentifierTypeId": 11,
            "udrName": "Sample Text Data",
            "originatingIdentifier": "Sample Text Data",
            "terminatingIdentifier": "Sample Text Data",
            "udrUsageIdentifier": "Sample Text Data",
            "value": "Sample Text Data",
            "reverseRating": true,
            "usageClassId": 2,
            "usageClassName": "Sample Text Data",
            "usageClassGroupTypeId": 4,
            "usageClassGroupTypeName": "Sample Text Data",
            "uniquenessIdentifier": "Sample Text Data",
            "usageClassTypeId": 16,
            "usageClassTypeName": "Sample Text Data",
            "dataImportHistoryId": 21,
            "dataImportHistoryName": "Sample Text Data",
            "usageBill": "2021-04-26T15:25:27.587Z",
            "inbound": true,
            "candidateTerminatingIdentifiers": "Sample Text Data",
            "primaryDataRow": 24,
            "charge": 1,
            "serviceTaxCategoryId": 0,
            "serviceTaxCategoryName": "Sample Text Data",
            "id": "Sample Text Data"
        }
    ]
}