TAG LINE
SMALL TITLE

Contract / Termination

(API Version v4)


This entity is the top level container for penalty charges for an Account Contract. This could contain multiple penalties for the Account Contract.


What can you do with ContractTermination?


Properties

Property Details
identity
READ-ONLY
"identity": 20
Type: Number
This is the unique numeric identifier for the ContractTermination
penaltyServiceId
"penaltyServiceId": 20
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.
name
"name": "Early Termination Fee"
Type: String
User defined name for the Termination Penalty


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 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 ContractTermination object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v4/Contract/Termination/{id}
Delete an instance of the ContractTermination 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 ContractTermination object.
Delete an instance of the ContractTermination object.
DELETE api/v4/Contract/Termination/{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": "contractTermination"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Contract/Termination/
Retrieve all of the ContractTermination objects.
Retrieve all of the ContractTermination objects.
GET api/v4/Contract/Termination/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "penaltyServiceId": 7,
            "penaltyServiceName": "Sample Text Data",
            "name": "Early Termination Fee"
        }
    ]
}
GETapi/v4/Contract/Termination/Paged
Retrieve all of the ContractTermination 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 ContractTermination objects in a paged fashion.
GET api/v4/Contract/Termination/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,
                "penaltyServiceId": 8,
                "penaltyServiceName": "Sample Text Data",
                "name": "Early Termination Fee"
            }
        ]
    }
}
GETapi/v4/Contract/Termination/Paged/Detail
Retrieve all of the ContractTermination 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 ContractTermination objects in a paged fashion with all object details.
GET api/v4/Contract/Termination/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,
                "penaltyServiceId": 16,
                "penaltyServiceName": "Sample Text Data",
                "name": "Early Termination Fee",
                "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
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Contract/Termination/{id}
Retrieve an instance of the ContractTermination object by its ID.
{id}Unique identifier for the ContractTermination object.
Retrieve an instance of the ContractTermination object by its ID.
GET api/v4/Contract/Termination/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "penaltyServiceId": 23,
        "penaltyServiceName": "Sample Text Data",
        "name": "Early Termination Fee"
    }
}
GETapi/v4/Contract/Termination/{id}/Detail
Retrieve deep detail of the ContractTermination 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 ContractTermination object.
Retrieve deep detail of the ContractTermination object by its ID.
GET api/v4/Contract/Termination/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "penaltyServiceId": 14,
        "penaltyServiceName": "Sample Text Data",
        "name": "Early Termination Fee",
        "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
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Contract/Termination/{id}
Update or Add the ContractTermination 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 ContractTermination object.
Update or Add the ContractTermination object and optionally make changes to any child objects.
PATCH api/v4/Contract/Termination/{id}

{
    "details": {},
    "contractTerminations": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "penaltyServiceId": 0,
                "name": "Early Termination Fee"
            }
        ]
    }
}
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": "contractTermination",
                "instance": {
                    "identity": 1,
                    "penaltyServiceId": 0,
                    "penaltyServiceName": "Sample Text Data",
                    "name": "Early Termination Fee"
                }
            }
        ]
    }
}
POSTapi/v4/Contract/Termination/
Create a new instance of the ContractTermination object.
Create a new instance of the ContractTermination object.
POST api/v4/Contract/Termination/

{
    "penaltyServiceId": 1,
    "name": "Early Termination Fee"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "penaltyServiceId": 23,
                "penaltyServiceName": "Sample Text Data",
                "name": "Early Termination Fee"
            }
        ]
    }
}
POSTapi/v4/Contract/Termination/Search
Retreive a list of ContractTermination 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 ContractTermination objects based on search criteria.
POST api/v4/Contract/Termination/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,
            "penaltyServiceId": 25,
            "penaltyServiceName": "Sample Text Data",
            "name": "Early Termination Fee"
        }
    ]
}
PUTapi/v4/Contract/Termination/{id}
Update an existing instance of the ContractTermination object.
Update an existing instance of the ContractTermination object.
PUT api/v4/Contract/Termination/{id}

{
    "identity": 1,
    "penaltyServiceId": 8,
    "name": "Early Termination Fee"
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "penaltyServiceId": 26,
                "penaltyServiceName": "Sample Text Data",
                "name": "Early Termination Fee"
            }
        ]
    }
}