TAG LINE
SMALL TITLE

Term Type

(API Version v4)


System defined list of term types such as Fixed or Variable.


What can you do with TermType?


Properties

Property Details
identity
READ-ONLY
"identity": 14
Type: Number
This is the unique numeric identifier for the TermType
name
READ-ONLY
"name": "Fixed Term"
Type: String
System defined name for the Term Type
sortOrder
READ-ONLY
"sortOrder": 15
Type: Number
Unused


End Points

GETapi/v4/TermType/
Retrieve all of the TermType objects.
Retrieve all of the TermType objects.
GET api/v4/TermType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Fixed Term",
            "sortOrder": 1
        }
    ]
}
GETapi/v4/TermType/Paged
Retrieve all of the TermType 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 TermType objects in a paged fashion.
GET api/v4/TermType/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": "Fixed Term",
                "sortOrder": 4
            }
        ]
    }
}
GETapi/v4/TermType/{id}
Retrieve an instance of the TermType object by its ID.
{id}Unique identifier for the TermType object.
Retrieve an instance of the TermType object by its ID.
GET api/v4/TermType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Fixed Term",
        "sortOrder": 12
    }
}
POSTapi/v4/TermType/Search
Retreive a list of TermType 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 TermType objects based on search criteria.
POST api/v4/TermType/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": "Fixed Term",
            "sortOrder": 18
        }
    ]
}