Service / Status Type

(API Version v10)

User defined Status Types for a service that is tied to base types such as "billable", "cancelled" etc.

What can you do with ServiceStatusType?

DELETE Service/StatusType/{id}
Delete an instance of the ServiceStatusType object.
GET Service/StatusType/
Retrieve all of the ServiceStatusType objects.
GET Service/StatusType/Paged
Retrieve all of the ServiceStatusType objects in a paged fashion.
GET Service/StatusType/{id}
Retrieve an instance of the ServiceStatusType object by its ID.
POST Service/StatusType/
Create a new instance of the ServiceStatusType object.
PUT Service/StatusType/{id}
Update an existing instance of the ServiceStatusType object.

Properties

Property Details

identity READ-ONLY	"identity": 2 Type: Number This is the unique numeric identifier for the ServiceStatusType
ownerId READ-ONLY	"ownerId": 4 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": 24 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.

End Points

DELETE	Service/StatusType/{id}
Delete an instance of the ServiceStatusType object. Upon successful delete, this API will return a record of all of the related 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 Service/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": "serviceStatusType" }, { "lhsId": 2, "rhsId": 2, "action": "detached", "dtoTypeKey": "sampleObjectConnector" }, { "foreignKeyIdentity": 2, "action": "deleted", "dtoTypeKey": "sampleObject" } ] } }

Retrieve all of the ServiceStatusType objects.

GET Service/StatusType/

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 18,
            "ownerName": "Sample Text Data",
            "name": "Currently Active",
            "preventChanges": true,
            "baseBillingStatusTypeId": 25,
            "baseBillingStatusTypeName": "Sample Text Data"
        }
    ]
}

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 Service/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,
                "ownerId": 5,
                "ownerName": "Sample Text Data",
                "name": "Currently Active",
                "preventChanges": true,
                "baseBillingStatusTypeId": 7,
                "baseBillingStatusTypeName": "Sample Text Data"
            }
        ]
    }
}

GET	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 Service/StatusType/{id} View Sample Response HTTP/1.1 200 OK { "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b", "instance": { "identity": 1, "ownerId": 12, "ownerName": "Sample Text Data", "name": "Currently Active", "preventChanges": true, "baseBillingStatusTypeId": 18, "baseBillingStatusTypeName": "Sample Text Data" } }

Create a new instance of the ServiceStatusType object.

POST Service/StatusType/

{
    "name": "Currently Active",
    "preventChanges": true,
    "baseBillingStatusTypeId": 15
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 16,
                "ownerName": "Sample Text Data",
                "name": "Currently Active",
                "preventChanges": true,
                "baseBillingStatusTypeId": 4,
                "baseBillingStatusTypeName": "Sample Text Data"
            }
        ]
    }
}

Update an existing instance of the ServiceStatusType object.

PUT Service/StatusType/{id}

{
    "identity": 1,
    "name": "Currently Active",
    "preventChanges": true,
    "baseBillingStatusTypeId": 2
}

View Sample Response

HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 16,
                "ownerName": "Sample Text Data",
                "name": "Currently Active",
                "preventChanges": true,
                "baseBillingStatusTypeId": 22,
                "baseBillingStatusTypeName": "Sample Text Data"
            }
        ]
    }
}