TAG LINE
SMALL TITLE

Service / Base Type

(API Version v4)


Represents an internal base type such as "recurring charge", "non-recurring charge" or "fee".


What can you do with ServiceBaseType?


Properties

Property Details
identity
READ-ONLY
"identity": 12
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": 16
Type: Number
Unused
tokenName
READ-ONLY
"tokenName": "Hello World"
Type: String
Unused


End Points

GETapi/v4/Service/BaseType/
Retrieve all of the ServiceBaseType objects.
Retrieve all of the ServiceBaseType objects.
GET api/v4/Service/BaseType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Recurring Charge",
            "sortOrder": 5,
            "tokenName": "Sample Text Data"
        }
    ]
}
GETapi/v4/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 api/v4/Service/BaseType/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,
                "name": "Recurring Charge",
                "sortOrder": 21,
                "tokenName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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 api/v4/Service/BaseType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Recurring Charge",
        "sortOrder": 16,
        "tokenName": "Sample Text Data"
    }
}
POSTapi/v4/Service/BaseType/Search
Retreive a list of ServiceBaseType 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 ServiceBaseType objects based on search criteria.
POST api/v4/Service/BaseType/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,
            "name": "Recurring Charge",
            "sortOrder": 10,
            "tokenName": "Sample Text Data"
        }
    ]
}