TAG LINE
SMALL TITLE

User / Status Type

(API Version v3)


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.


What can you do with UserStatusType?


Properties

Property Details
identity
READ-ONLY
"identity": 22
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": 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.
statusTypeId
"statusTypeId": 2
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.


Update Request Filters

Update Request Filters are no longer required starting with v4 of the LogiSense Billing API.

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:

  • name
  • statusTypeId

End Points

DELETEapi/v3/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/v3/User/StatusType/{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": "userStatusType"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v3/User/StatusType/
Retrieve all of the UserStatusType objects.
Retrieve all of the UserStatusType objects.
GET api/v3/User/StatusType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Active",
            "ownerId": 17,
            "ownerName": "Sample Text Data",
            "statusTypeId": 3,
            "statusTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v3/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/v3/User/StatusType/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,
                "name": "Active",
                "ownerId": 15,
                "ownerName": "Sample Text Data",
                "statusTypeId": 6,
                "statusTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v3/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/v3/User/StatusType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Active",
        "ownerId": 24,
        "ownerName": "Sample Text Data",
        "statusTypeId": 12,
        "statusTypeName": "Sample Text Data"
    }
}
POSTapi/v3/User/StatusType/
Create a new instance of the UserStatusType object.
Create a new instance of the UserStatusType object.
POST api/v3/User/StatusType/

{
    "name": "Active",
    "statusTypeId": 22
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Active",
                "ownerId": 5,
                "ownerName": "Sample Text Data",
                "statusTypeId": 11,
                "statusTypeName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v3/User/StatusType/{id}
Update an existing instance of the UserStatusType object.
Update an existing instance of the UserStatusType object.
PUT api/v3/User/StatusType/{id}

{
    "identity": 1,
    "name": "Active",
    "statusTypeId": 17
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Active",
                "ownerId": 13,
                "ownerName": "Sample Text Data",
                "statusTypeId": 3,
                "statusTypeName": "Sample Text Data"
            }
        ]
    }
}