Term

(API Version v10)

User defined terms for Package contracts.

What can you do with Term?

DELETE Term/{id}
Delete an instance of the Term object.
GET Term/
Retrieve all of the Term objects.
GET Term/Paged
Retrieve all of the Term objects in a paged fashion.
GET Term/Paged/Detail
Retrieve all of the Term objects in a paged fashion with all object details.
GET Term/{id}
Retrieve an instance of the Term object by its ID.
GET Term/{id}/Detail
Retrieve deep detail of the Term object by its ID.
PATCH Term/{id}
Update or Add the Term object and optionally make changes to any child objects.
POST Term/
Create a new instance of the Term object.
PUT Term/{id}
Update an existing instance of the Term object.

Properties

Property Details

identity READ-ONLY	"identity": 24 Type: Number This is the unique numeric identifier for the Term
ownerId READ-ONLY	"ownerId": 3 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": 13 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": 5 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.
termRenewalTypeId	"termRenewalTypeId": 18 Type: Number Unique identifier for the associated TermRenewalType object.
termRenewalTypeName	"termRenewalTypeName": "Sample Name" Type: String The name of the object associated with the termRenewalTypeId property.
renewTermId	"renewTermId": 12 Type: Number Unique identifier for the associated Term object.
renewTermName	"renewTermName": "Sample Name" Type: String The name of the object associated with the renewTermId property.
revokeDiscounts	"revokeDiscounts": true Type: Boolean Revoke Discounts when charging package term penalties. RevokeDiscounts can only be true if ChargeRemainder is true.

Patch Types

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. Below you will find the child objects that can be updated as part of PATCH operations for the Term object.

Standard PATCH objects:

termPenalty - create, update, delete

DataFlow PATCH objects:

term - create, update, delete
termPenalty - create, update, delete

End Points

DELETE	Term/{id}
Delete an instance of the Term object. Upon successful delete, this API will return a record of all of the related 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 Term/{id} View Sample Response 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" } ] } }

Retrieve all of the Term objects.

GET Term/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 5,
            "ownerName": "Sample Text Data",
            "name": "12 months",
            "isActive": true,
            "frequency": "1",
            "frequencyTypeId": 23,
            "frequencyTypeName": "Sample Text Data",
            "penaltyServiceId": 18,
            "penaltyServiceName": "Sample Text Data",
            "chargeRemainder": true,
            "termRenewalTypeId": 8,
            "termRenewalTypeName": "Sample Text Data",
            "renewTermId": 27,
            "renewTermName": "Sample Text Data",
            "revokeDiscounts": true
        }
    ]
}

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 Term/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,
                "ownerId": 17,
                "ownerName": "Sample Text Data",
                "name": "12 months",
                "isActive": true,
                "frequency": "1",
                "frequencyTypeId": 19,
                "frequencyTypeName": "Sample Text Data",
                "penaltyServiceId": 2,
                "penaltyServiceName": "Sample Text Data",
                "chargeRemainder": true,
                "termRenewalTypeId": 12,
                "termRenewalTypeName": "Sample Text Data",
                "renewTermId": 17,
                "renewTermName": "Sample Text Data",
                "revokeDiscounts": true
            }
        ]
    }
}

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 Term/Paged/Detail

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,
                "ownerId": 10,
                "ownerName": "Sample Text Data",
                "name": "12 months",
                "isActive": true,
                "frequency": "1",
                "frequencyTypeId": 1,
                "frequencyTypeName": "Sample Text Data",
                "penaltyServiceId": 10,
                "penaltyServiceName": "Sample Text Data",
                "chargeRemainder": true,
                "termRenewalTypeId": 3,
                "termRenewalTypeName": "Sample Text Data",
                "renewTermId": 14,
                "renewTermName": "Sample Text Data",
                "revokeDiscounts": true,
                "details": {
                    "termPenalties": [
                        {
                            "identity": 94,
                            "termId": 85,
                            "termName": "Sample Text Data",
                            "currencyId": 3,
                            "currencyName": "Sample Text Data",
                            "amount": 45.93,
                            "currencyCode": "Sample Text Data"
                        }
                    ]
                }
            }
        ]
    }
}

GET	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 Term/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 24, "ownerName": "Sample Text Data", "name": "12 months", "isActive": true, "frequency": "1", "frequencyTypeId": 5, "frequencyTypeName": "Sample Text Data", "penaltyServiceId": 8, "penaltyServiceName": "Sample Text Data", "chargeRemainder": true, "termRenewalTypeId": 19, "termRenewalTypeName": "Sample Text Data", "renewTermId": 9, "renewTermName": "Sample Text Data", "revokeDiscounts": true } }

GET	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 Term/{id}/Detail View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 2, "ownerName": "Sample Text Data", "name": "12 months", "isActive": true, "frequency": "1", "frequencyTypeId": 13, "frequencyTypeName": "Sample Text Data", "penaltyServiceId": 9, "penaltyServiceName": "Sample Text Data", "chargeRemainder": true, "termRenewalTypeId": 14, "termRenewalTypeName": "Sample Text Data", "renewTermId": 6, "renewTermName": "Sample Text Data", "revokeDiscounts": true, "details": { "termPenalties": [ { "identity": 94, "termId": 85, "termName": "Sample Text Data", "currencyId": 3, "currencyName": "Sample Text Data", "amount": 45.93, "currencyCode": "Sample Text Data" } ] } } }

PATCH	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 Term/{id} { "details": {}, "terms": { "items": [ { "patchType": "create", "patchClientId": 1, "name": "12 months", "isActive": true, "frequency": "1", "frequencyTypeId": 5, "penaltyServiceId": 0, "chargeRemainder": true, "termRenewalTypeId": 20, "renewTermId": 18, "revokeDiscounts": true } ] } } View Sample Response 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": 20, "ownerName": "Sample Text Data", "name": "12 months", "isActive": true, "frequency": "1", "frequencyTypeId": 17, "frequencyTypeName": "Sample Text Data", "penaltyServiceId": 17, "penaltyServiceName": "Sample Text Data", "chargeRemainder": true, "termRenewalTypeId": 10, "termRenewalTypeName": "Sample Text Data", "renewTermId": 21, "renewTermName": "Sample Text Data", "revokeDiscounts": true } } ] } }

Create a new instance of the Term object.

POST Term/

{
    "name": "12 months",
    "isActive": true,
    "frequency": "1",
    "frequencyTypeId": 1,
    "penaltyServiceId": 20,
    "chargeRemainder": true,
    "termRenewalTypeId": 22,
    "renewTermId": 17,
    "revokeDiscounts": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 17,
                "ownerName": "Sample Text Data",
                "name": "12 months",
                "isActive": true,
                "frequency": "1",
                "frequencyTypeId": 13,
                "frequencyTypeName": "Sample Text Data",
                "penaltyServiceId": 25,
                "penaltyServiceName": "Sample Text Data",
                "chargeRemainder": true,
                "termRenewalTypeId": 22,
                "termRenewalTypeName": "Sample Text Data",
                "renewTermId": 17,
                "renewTermName": "Sample Text Data",
                "revokeDiscounts": true
            }
        ]
    }
}

Update an existing instance of the Term object.

PUT Term/{id}

{
    "identity": 1,
    "name": "12 months",
    "isActive": true,
    "frequency": "1",
    "frequencyTypeId": 8,
    "penaltyServiceId": 27,
    "chargeRemainder": true,
    "termRenewalTypeId": 9,
    "renewTermId": 26,
    "revokeDiscounts": true
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 11,
                "ownerName": "Sample Text Data",
                "name": "12 months",
                "isActive": true,
                "frequency": "1",
                "frequencyTypeId": 19,
                "frequencyTypeName": "Sample Text Data",
                "penaltyServiceId": 21,
                "penaltyServiceName": "Sample Text Data",
                "chargeRemainder": true,
                "termRenewalTypeId": 12,
                "termRenewalTypeName": "Sample Text Data",
                "renewTermId": 7,
                "renewTermName": "Sample Text Data",
                "revokeDiscounts": true
            }
        ]
    }
}