TAG LINE
SMALL TITLE
User defined terms for Package contracts.
identity READ-ONLY | "identity": 16 Type: Number This is the unique numeric identifier for the Term |
ownerId READ-ONLY | "ownerId": 0 Type: Number Unique identifier for the associated Owner object. |
ownerName READ-ONLY | "ownerName": "Sample Name" Type: String The name of the object associated with the ownerId property. |
name | "name": "12 months" Type: String User defined name for the Term |
isActive | "isActive": true Type: Boolean Whether or not this Term can be applied to a Package contract. |
frequency | "frequency": 1 Type: Number Numerical value of the frequency of the term. |
frequencyTypeId | "frequencyTypeId": 24 Type: Number Unique identifier for the associated FrequencyType object. |
frequencyTypeName | "frequencyTypeName": "Sample Name" Type: String The name of the object associated with the frequencyTypeId property. |
penaltyServiceId | "penaltyServiceId": 21 Type: Number Unique identifier for the associated Service object. |
penaltyServiceName | "penaltyServiceName": "Sample Name" Type: String The name of the object associated with the penaltyServiceId property. |
chargeRemainder | "chargeRemainder": true Type: Boolean Whether or not the remaining amount of the term due to early cancellation should be pro-rated and charged. |
When updating an object you use the update request header with the list of properties to update. Then you need only supply the new values in the body of your request. Please note, this header can only be used with PUT or PATCH requests.
Field List:
The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.
PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Term object.
Standard PATCH objects:
DataFlow PATCH objects:
| DELETE | api/v2/Term/{id} |
| Delete an instance of the Term object. Upon successful delete, this API will return a record of all of the reelated objects deleted with this operation. The specifics on which objects have been deleted will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the Term object. |
Delete an instance of the Term object. DELETE api/v2/Term/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "term"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v2/Term/ |
| Retrieve all of the Term objects. | |
Retrieve all of the Term objects. GET api/v2/Term/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 12,
"ownerName": "Sample Text Data",
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 18,
"frequencyTypeName": "Sample Text Data",
"penaltyServiceId": 19,
"penaltyServiceName": "Sample Text Data",
"chargeRemainder": true
}
]
} | |
| GET | api/v2/Term/Paged |
| Retrieve all of the Term 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 Term objects in a paged fashion. GET api/v2/Term/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,
"ownerId": 20,
"ownerName": "Sample Text Data",
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 21,
"frequencyTypeName": "Sample Text Data",
"penaltyServiceId": 7,
"penaltyServiceName": "Sample Text Data",
"chargeRemainder": true
}
]
}
} | |
| GET | api/v2/Term/Paged/Detail |
| Retrieve all of the Term objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
Retrieve all of the Term objects in a paged fashion with all object details. GET api/v2/Term/Paged/Detail HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"pagination": {
"pageNumber": 1,
"pageSize": 20,
"excludeTotalCount": false
},
"pagedResults": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 6,
"ownerName": "Sample Text Data",
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 26,
"frequencyTypeName": "Sample Text Data",
"penaltyServiceId": 8,
"penaltyServiceName": "Sample Text Data",
"chargeRemainder": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
]
}
} | |
| GET | api/v2/Term/{id} |
| Retrieve an instance of the Term object by its ID. | |
| {id} | Unique identifier for the Term object. |
Retrieve an instance of the Term object by its ID. GET api/v2/Term/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 15,
"ownerName": "Sample Text Data",
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 18,
"frequencyTypeName": "Sample Text Data",
"penaltyServiceId": 0,
"penaltyServiceName": "Sample Text Data",
"chargeRemainder": true
}
} | |
| GET | api/v2/Term/{id}/Detail |
| Retrieve deep detail of the Term object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system. | |
| {id} | Unique identifier for the Term object. |
Retrieve deep detail of the Term object by its ID. GET api/v2/Term/{id}/DetailHTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 23,
"ownerName": "Sample Text Data",
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 11,
"frequencyTypeName": "Sample Text Data",
"penaltyServiceId": 6,
"penaltyServiceName": "Sample Text Data",
"chargeRemainder": true,
"details": {
"sampleSingleObject": {
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
},
"sampleMultipleObjects": {
"totalCount": 1,
"items": [
{
"identity": 2,
"property1": "Sample Text",
"property2": "2021-04-26T15:25:29.117Z",
"property3": 2
}
]
}
}
}
} | |
| PATCH | api/v2/Term/{id} |
| Update or Add the Term object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array. | |
| {id} | Unique identifier for the Term object. |
Update or Add the Term object and optionally make changes to any child objects. PATCH api/v2/Term/{id}
{
"details": {},
"terms": {
"items": [
{
"patchType": "create",
"patchClientId": 1,
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 17,
"penaltyServiceId": 8,
"chargeRemainder": true
}
]
}
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "patch",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"action": "created",
"dtoTypeKey": "term",
"instance": {
"identity": 1,
"ownerId": 15,
"ownerName": "Sample Text Data",
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 22,
"frequencyTypeName": "Sample Text Data",
"penaltyServiceId": 7,
"penaltyServiceName": "Sample Text Data",
"chargeRemainder": true
}
}
]
}
} | |
| POST | api/v2/Term/ |
| Create a new instance of the Term object. | |
Create a new instance of the Term object. POST api/v2/Term/
{
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 3,
"penaltyServiceId": 4,
"chargeRemainder": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 24,
"ownerName": "Sample Text Data",
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 11,
"frequencyTypeName": "Sample Text Data",
"penaltyServiceId": 18,
"penaltyServiceName": "Sample Text Data",
"chargeRemainder": true
}
]
}
} | |
| PUT | api/v2/Term/{id} |
| Update an existing instance of the Term object. | |
Update an existing instance of the Term object. PUT api/v2/Term/{id}
{
"identity": 1,
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 1,
"penaltyServiceId": 10,
"chargeRemainder": true
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 17,
"ownerName": "Sample Text Data",
"name": "12 months",
"isActive": true,
"frequency": "1",
"frequencyTypeId": 2,
"frequencyTypeName": "Sample Text Data",
"penaltyServiceId": 18,
"penaltyServiceName": "Sample Text Data",
"chargeRemainder": true
}
]
}
} | |