TAG LINE
SMALL TITLE

Service / Transition

(API Version v2)


User defined representation of changing from one Status to another Status.


What can you do with ServiceTransition?


Properties

Property Details
identity
READ-ONLY
"identity": 2
Type: Number
This is the unique numeric identifier for the ServiceTransition
ownerId
READ-ONLY
"ownerId": 25
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": "Suspended"
Type: String
User defined name for the the Transition.
fromServiceStatusTypeId
"fromServiceStatusTypeId": 24
Type: Number
Unique identifier for the associated ServiceStatusType object.
fromServiceStatusTypeName
"fromServiceStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the fromServiceStatusTypeId property.
toServiceStatusTypeId
"toServiceStatusTypeId": 26
Type: Number
Unique identifier for the associated ServiceStatusType object.
toServiceStatusTypeName
"toServiceStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the toServiceStatusTypeId 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:

  • identity
  • name
  • fromServiceStatusTypeId
  • toServiceStatusTypeId

End Points

DELETEapi/v2/Service/Transition/{id}
Delete an instance of the ServiceTransition 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 ServiceTransition object.
Delete an instance of the ServiceTransition object.
DELETE api/v2/Service/Transition/{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": "serviceTransition"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/Service/Transition/
Retrieve all of the ServiceTransition objects.
Retrieve all of the ServiceTransition objects.
GET api/v2/Service/Transition/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "ownerId": 0,
            "ownerName": "Sample Text Data",
            "name": "Suspended",
            "fromServiceStatusTypeId": 12,
            "fromServiceStatusTypeName": "Sample Text Data",
            "toServiceStatusTypeId": 10,
            "toServiceStatusTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v2/Service/Transition/Paged
Retrieve all of the ServiceTransition 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 ServiceTransition objects in a paged fashion.
GET api/v2/Service/Transition/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": 2,
                "ownerName": "Sample Text Data",
                "name": "Suspended",
                "fromServiceStatusTypeId": 26,
                "fromServiceStatusTypeName": "Sample Text Data",
                "toServiceStatusTypeId": 25,
                "toServiceStatusTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/Service/Transition/{id}
Retrieve an instance of the ServiceTransition object by its ID.
{id}Unique identifier for the ServiceTransition object.
Retrieve an instance of the ServiceTransition object by its ID.
GET api/v2/Service/Transition/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "ownerId": 7,
        "ownerName": "Sample Text Data",
        "name": "Suspended",
        "fromServiceStatusTypeId": 14,
        "fromServiceStatusTypeName": "Sample Text Data",
        "toServiceStatusTypeId": 22,
        "toServiceStatusTypeName": "Sample Text Data"
    }
}
POSTapi/v2/Service/Transition/
Create a new instance of the ServiceTransition object.
Create a new instance of the ServiceTransition object.
POST api/v2/Service/Transition/

{
    "name": "Suspended",
    "fromServiceStatusTypeId": 8,
    "toServiceStatusTypeId": 13
}
View Sample Response
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": "Suspended",
                "fromServiceStatusTypeId": 5,
                "fromServiceStatusTypeName": "Sample Text Data",
                "toServiceStatusTypeId": 0,
                "toServiceStatusTypeName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v2/Service/Transition/{id}
Update an existing instance of the ServiceTransition object.
Update an existing instance of the ServiceTransition object.
PUT api/v2/Service/Transition/{id}

{
    "identity": 1,
    "name": "Suspended",
    "fromServiceStatusTypeId": 23,
    "toServiceStatusTypeId": 1
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "ownerId": 4,
                "ownerName": "Sample Text Data",
                "name": "Suspended",
                "fromServiceStatusTypeId": 16,
                "fromServiceStatusTypeName": "Sample Text Data",
                "toServiceStatusTypeId": 2,
                "toServiceStatusTypeName": "Sample Text Data"
            }
        ]
    }
}