TAG LINE
TAG LINE
SMALL TITLE
Defines a list of status types for a user in the system. These are user defined statuses that then point to a system status for meaning.
identity READ-ONLY | "identity": 25 Type: Number This is the unique numeric identifier for the UserStatusType |
name | "name": "Active" Type: String The user defined name for the Status Type |
ownerId READ-ONLY | "ownerId": 15 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. |
statusTypeId | "statusTypeId": 9 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. |
| DELETE | api/v6/User/StatusType/{id} |
| Delete an instance of the UserStatusType 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 UserStatusType object. |
Delete an instance of the UserStatusType object. DELETE api/v6/User/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "delete",
"results": {
"totalCount": 4,
"items": [
{
"identity": 1,
"action": "deleted",
"dtoTypeKey": "userStatusType"
},
{
"lhsId": 2,
"rhsId": 2,
"action": "detached",
"dtoTypeKey": "sampleObjectConnector"
},
{
"foreignKeyIdentity": 2,
"action": "deleted",
"dtoTypeKey": "sampleObject"
}
]
}
} | |
| GET | api/v6/User/StatusType/ |
| Retrieve all of the UserStatusType objects. | |
Retrieve all of the UserStatusType objects. GET api/v6/User/StatusType/ HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Active",
"ownerId": 18,
"ownerName": "Sample Text Data",
"statusTypeId": 4,
"statusTypeName": "Sample Text Data"
}
]
} | |
| GET | api/v6/User/StatusType/Paged |
| Retrieve all of the UserStatusType 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 UserStatusType objects in a paged fashion. GET api/v6/User/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,
"name": "Active",
"ownerId": 10,
"ownerName": "Sample Text Data",
"statusTypeId": 3,
"statusTypeName": "Sample Text Data"
}
]
}
} | |
| GET | api/v6/User/StatusType/{id} |
| Retrieve an instance of the UserStatusType object by its ID. | |
| {id} | Unique identifier for the UserStatusType object. |
Retrieve an instance of the UserStatusType object by its ID. GET api/v6/User/StatusType/{id}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"instance": {
"identity": 1,
"name": "Active",
"ownerId": 3,
"ownerName": "Sample Text Data",
"statusTypeId": 10,
"statusTypeName": "Sample Text Data"
}
} | |
| POST | api/v6/User/StatusType/ |
| Create a new instance of the UserStatusType object. | |
Create a new instance of the UserStatusType object. POST api/v6/User/StatusType/
{
"name": "Active",
"statusTypeId": 6
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "create",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Active",
"ownerId": 21,
"ownerName": "Sample Text Data",
"statusTypeId": 25,
"statusTypeName": "Sample Text Data"
}
]
}
} | |
| PUT | api/v6/User/StatusType/{id} |
| Update an existing instance of the UserStatusType object. | |
Update an existing instance of the UserStatusType object. PUT api/v6/User/StatusType/{id}
{
"identity": 1,
"name": "Active",
"statusTypeId": 8
}HTTP/1.1 200 OK
{
"trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
"type": "update",
"results": {
"totalCount": 1,
"items": [
{
"identity": 1,
"name": "Active",
"ownerId": 16,
"ownerName": "Sample Text Data",
"statusTypeId": 21,
"statusTypeName": "Sample Text Data"
}
]
}
} | |