TAG LINE
TAG LINE
SMALL TITLE
User defined Status Types for a service that is tied to base types such as "billable", "cancelled" etc.
identity READ-ONLY | "identity": 9 Type: Number This is the unique numeric identifier for the ServiceStatusType |
ownerId READ-ONLY | "ownerId": 10 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": "Currently Active" Type: String User defined name for the Status Type. |
preventChanges | "preventChanges": true Type: Boolean Whether or not to prevent the user from making changes if this status Type is assigned. |
baseBillingStatusTypeId | "baseBillingStatusTypeId": 21 Type: Number Unique identifier for the associated BaseBillingStatusType object. |
baseBillingStatusTypeName | "baseBillingStatusTypeName": "Sample Name" Type: String The name of the object associated with the baseBillingStatusTypeId property. |
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/Service/StatusType/{id} |
| Delete an instance of the ServiceStatusType 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 ServiceStatusType object. |
Delete an instance of the ServiceStatusType object. DELETE api/v3/Service/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "serviceStatusType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v3/Service/StatusType/ |
| Retrieve all of the ServiceStatusType objects. | |
Retrieve all of the ServiceStatusType objects. GET api/v3/Service/StatusType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 7,
"ownerName": "Sample Text Data",
"name": "Currently Active",
"preventChanges": true,
"baseBillingStatusTypeId": 24,
"baseBillingStatusTypeName": "Sample Text Data"
}
]
} | |
| GET | api/v3/Service/StatusType/Paged |
| Retrieve all of the ServiceStatusType 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 ServiceStatusType objects in a paged fashion. GET api/v3/Service/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": 15,
"ownerName": "Sample Text Data",
"name": "Currently Active",
"preventChanges": true,
"baseBillingStatusTypeId": 15,
"baseBillingStatusTypeName": "Sample Text Data"
}
]
}
} | |
| GET | api/v3/Service/StatusType/{id} |
| Retrieve an instance of the ServiceStatusType object by its ID. | |
| {id} | Unique identifier for the ServiceStatusType object. |
Retrieve an instance of the ServiceStatusType object by its ID. GET api/v3/Service/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"ownerId": 25,
"ownerName": "Sample Text Data",
"name": "Currently Active",
"preventChanges": true,
"baseBillingStatusTypeId": 25,
"baseBillingStatusTypeName": "Sample Text Data"
}
} | |
| POST | api/v3/Service/StatusType/ |
| Create a new instance of the ServiceStatusType object. | |
Create a new instance of the ServiceStatusType object. POST api/v3/Service/StatusType/
{
"name": "Currently Active",
"preventChanges": true,
"baseBillingStatusTypeId": 27
}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": "Currently Active",
"preventChanges": true,
"baseBillingStatusTypeId": 5,
"baseBillingStatusTypeName": "Sample Text Data"
}
]
}
} | |
| PUT | api/v3/Service/StatusType/{id} |
| Update an existing instance of the ServiceStatusType object. | |
Update an existing instance of the ServiceStatusType object. PUT api/v3/Service/StatusType/{id}
{
"identity": 1,
"name": "Currently Active",
"preventChanges": true,
"baseBillingStatusTypeId": 0
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"ownerId": 3,
"ownerName": "Sample Text Data",
"name": "Currently Active",
"preventChanges": true,
"baseBillingStatusTypeId": 13,
"baseBillingStatusTypeName": "Sample Text Data"
}
]
}
} | |