TAG LINE
TAG LINE
SMALL TITLE
Represents an internal base type such as "recurring charge", "non-recurring charge" or "fee".
identity READ-ONLY | "identity": 10 Type: Number This is the unique numeric identifier for the ServiceBaseType |
name READ-ONLY | "name": "Recurring Charge" Type: String System defined name for the Base Type. |
sortOrder READ-ONLY | "sortOrder": 3 Type: Number Unused |
tokenName READ-ONLY | "tokenName": "Hello World" Type: String Unused |
| GET | Service/BaseType/ |
| Retrieve all of the ServiceBaseType objects. | |
Retrieve all of the ServiceBaseType objects. GET Service/BaseType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Recurring Charge",
"sortOrder": 8,
"tokenName": "Sample Text Data"
}
]
} | |
| GET | Service/BaseType/Paged |
| Retrieve all of the ServiceBaseType 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 ServiceBaseType objects in a paged fashion. GET Service/BaseType/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": "Recurring Charge",
"sortOrder": 16,
"tokenName": "Sample Text Data"
}
]
}
} | |
| GET | Service/BaseType/{id} |
| Retrieve an instance of the ServiceBaseType object by its ID. | |
| {id} | Unique identifier for the ServiceBaseType object. |
Retrieve an instance of the ServiceBaseType object by its ID. GET Service/BaseType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Recurring Charge",
"sortOrder": 18,
"tokenName": "Sample Text Data"
}
} | |