TAG LINE
TAG LINE
SMALL TITLE

Term Type

(API Version v7)


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


What can you do with TermType?

  • GET TermType/
    Retrieve all of the TermType objects.

  • GET TermType/
    Retrieve all of the TermType objects.

  • GET TermType/
    Retrieve all of the TermType objects.

  • GET TermType/
    Retrieve all of the TermType objects.

  • GET TermType/
    Retrieve all of the TermType objects.

  • GET TermType/Metadata
    Retrieve all of the TermType objects.

  • GET TermType/Metadata/sql
    Retrieve all of the TermType objects.

  • GET TermType/Paged
    Retrieve all of the TermType objects in a paged fashion.

  • GET TermType/Paged
    Retrieve all of the TermType objects in a paged fashion.

  • GET TermType/Paged
    Retrieve all of the TermType objects in a paged fashion.

  • GET TermType/Paged
    Retrieve all of the TermType objects in a paged fashion.

  • GET TermType/Paged
    Retrieve all of the TermType objects in a paged fashion.

  • GET TermType/{id}
    Retrieve an instance of the TermType object by its ID.

  • GET TermType/{id}
    Retrieve an instance of the TermType object by its ID.

  • GET TermType/{id}
    Retrieve an instance of the TermType object by its ID.

  • GET TermType/{id}
    Retrieve an instance of the TermType object by its ID.

  • GET TermType/{id}
    Retrieve an instance of the TermType object by its ID.


Properties

Property Details
identity
READ-ONLY
"identity": 16
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": 4
Type: Number
Unused


End Points

GETTermType/
Retrieve all of the TermType objects.
Retrieve all of the TermType objects.
GET 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
        }
    ]
}
GETTermType/
Retrieve all of the TermType objects.
Retrieve all of the TermType objects.
GET TermType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Fixed Term",
            "sortOrder": 16
        }
    ]
}
GETTermType/
Retrieve all of the TermType objects.
Retrieve all of the TermType objects.
GET TermType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Fixed Term",
            "sortOrder": 22
        }
    ]
}
GETTermType/
Retrieve all of the TermType objects.
Retrieve all of the TermType objects.
GET TermType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Fixed Term",
            "sortOrder": 16
        }
    ]
}
GETTermType/
Retrieve all of the TermType objects.
Retrieve all of the TermType objects.
GET 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
        }
    ]
}
GETTermType/Metadata
Retrieve all of the TermType objects.
Retrieve all of the TermType objects.
GET TermType/Metadata
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Fixed Term",
            "sortOrder": 15
        }
    ]
}
GETTermType/Metadata/sql
Retrieve all of the TermType objects.
Retrieve all of the TermType objects.
GET TermType/Metadata/sql
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Fixed Term",
            "sortOrder": 20
        }
    ]
}
GETTermType/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 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": 0
            }
        ]
    }
}
GETTermType/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 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": 8
            }
        ]
    }
}
GETTermType/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 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": 22
            }
        ]
    }
}
GETTermType/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 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": 14
            }
        ]
    }
}
GETTermType/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 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": 11
            }
        ]
    }
}
GETTermType/{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 TermType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Fixed Term",
        "sortOrder": 26
    }
}
GETTermType/{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 TermType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Fixed Term",
        "sortOrder": 19
    }
}
GETTermType/{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 TermType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Fixed Term",
        "sortOrder": 26
    }
}
GETTermType/{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 TermType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Fixed Term",
        "sortOrder": 23
    }
}
GETTermType/{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 TermType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Fixed Term",
        "sortOrder": 2
    }
}