TAG LINE
SMALL TITLE

Service Type

(API Version v2)


What can you do with ServiceType?


Properties

Property Details
identity
READ-ONLY
"identity": 1
Type: Number
This is the unique numeric identifier for the ServiceType
name
"name": "Hello World"
Type: String
ownerId
READ-ONLY
"ownerId": 11
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.
serviceBaseTypeId
"serviceBaseTypeId": 26
Type: Number
Unique identifier for the associated ServiceBaseType object.
serviceBaseTypeName
"serviceBaseTypeName": "Sample Name"
Type: String
The name of the object associated with the serviceBaseTypeId 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
  • serviceBaseTypeId

End Points

DELETEapi/v2/ServiceType/{id}
Delete an instance of the ServiceType 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 ServiceType object.
Delete an instance of the ServiceType object.
DELETE api/v2/ServiceType/{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": "serviceType"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v2/ServiceType/
Retrieve all of the ServiceType objects.
Retrieve all of the ServiceType objects.
GET api/v2/ServiceType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "ownerId": 23,
            "ownerName": "Sample Text Data",
            "serviceBaseTypeId": 1,
            "serviceBaseTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v2/ServiceType/AvailableFor/SharePlans
This end point is Unused. NOTE: This API is marked for deprication and will be removed in v5 of the API.
GETapi/v2/ServiceType/Paged
Retrieve all of the ServiceType 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 ServiceType objects in a paged fashion.
GET api/v2/ServiceType/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": "Sample Text Data",
                "ownerId": 17,
                "ownerName": "Sample Text Data",
                "serviceBaseTypeId": 10,
                "serviceBaseTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v2/ServiceType/{id}
Retrieve an instance of the ServiceType object by its ID.
{id}Unique identifier for the ServiceType object.
Retrieve an instance of the ServiceType object by its ID.
GET api/v2/ServiceType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Sample Text Data",
        "ownerId": 21,
        "ownerName": "Sample Text Data",
        "serviceBaseTypeId": 24,
        "serviceBaseTypeName": "Sample Text Data"
    }
}
POSTapi/v2/ServiceType/
Create a new instance of the ServiceType object.
Create a new instance of the ServiceType object.
POST api/v2/ServiceType/

{
    "name": "Sample Text Data",
    "serviceBaseTypeId": 24
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "ownerId": 26,
                "ownerName": "Sample Text Data",
                "serviceBaseTypeId": 0,
                "serviceBaseTypeName": "Sample Text Data"
            }
        ]
    }
}
PUTapi/v2/ServiceType/{id}
Update an existing instance of the ServiceType object.
Update an existing instance of the ServiceType object.
PUT api/v2/ServiceType/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "serviceBaseTypeId": 21
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "update",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Sample Text Data",
                "ownerId": 2,
                "ownerName": "Sample Text Data",
                "serviceBaseTypeId": 8,
                "serviceBaseTypeName": "Sample Text Data"
            }
        ]
    }
}