TAG LINE
TAG LINE
SMALL TITLE
This object lists the different types of contract status types such as "Active" or "Expired".
identity READ-ONLY | "identity": 1 Type: Number This is the unique numeric identifier for the AccountContractStatusType |
ownerId READ-ONLY | "ownerId": 21 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": "Expires at End of Term" Type: String The name given to the Status Type. The user can name a status type whatever they like, the actions associated with the Status Type will be determined by the system statusTypeId. |
statusTypeId | "statusTypeId": 21 Type: Number Unique identifier for the associated StatusType object. |
statusTypeName | "statusTypeName": "Sample Name" Type: String The name of the object associated with the statusTypeId property. |
sortOrder READ-ONLY | "sortOrder": 12 Type: Number Unused field and can be ignored |
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:
| DELETE | api/v3/Account/Contract/StatusType/{id} |
| Delete an instance of the AccountContractStatusType 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 AccountContractStatusType object. |
Delete an instance of the AccountContractStatusType object. DELETE api/v3/Account/Contract/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "accountContractStatusType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v3/Account/Contract/StatusType/ |
| Retrieve all of the AccountContractStatusType objects. | |
Retrieve all of the AccountContractStatusType objects. GET api/v3/Account/Contract/StatusType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 1,
"ownerName": "Sample Text Data",
"name": "Expires at End of Term",
"statusTypeId": 6,
"statusTypeName": "Sample Text Data",
"sortOrder": 6
}
]
} | |
| GET | api/v3/Account/Contract/StatusType/Paged |
| Retrieve all of the AccountContractStatusType 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 AccountContractStatusType objects in a paged fashion. GET api/v3/Account/Contract/StatusType/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": 16,
"ownerName": "Sample Text Data",
"name": "Expires at End of Term",
"statusTypeId": 12,
"statusTypeName": "Sample Text Data",
"sortOrder": 22
}
]
}
} | |
| GET | api/v3/Account/Contract/StatusType/{id} |
| Retrieve an instance of the AccountContractStatusType object by its ID. | |
| {id} | Unique identifier for the AccountContractStatusType object. |
Retrieve an instance of the AccountContractStatusType object by its ID. GET api/v3/Account/Contract/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 3,
"ownerName": "Sample Text Data",
"name": "Expires at End of Term",
"statusTypeId": 6,
"statusTypeName": "Sample Text Data",
"sortOrder": 19
}
} | |
| POST | api/v3/Account/Contract/StatusType/ |
| Create a new instance of the AccountContractStatusType object. | |
Create a new instance of the AccountContractStatusType object. POST api/v3/Account/Contract/StatusType/
{
"name": "Expires at End of Term",
"statusTypeId": 17
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 14,
"ownerName": "Sample Text Data",
"name": "Expires at End of Term",
"statusTypeId": 5,
"statusTypeName": "Sample Text Data",
"sortOrder": 21
}
]
}
} | |
| PUT | api/v3/Account/Contract/StatusType/{id} |
| Update an existing instance of the AccountContractStatusType object. | |
Update an existing instance of the AccountContractStatusType object. PUT api/v3/Account/Contract/StatusType/{id}
{
"identity": 1,
"name": "Expires at End of Term",
"statusTypeId": 14
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 14,
"ownerName": "Sample Text Data",
"name": "Expires at End of Term",
"statusTypeId": 15,
"statusTypeName": "Sample Text Data",
"sortOrder": 22
}
]
}
} | |