TAG LINE
SMALL TITLE

Service Type

(API Version v4)


User defined service type that is then tied to lower base types such "fee", "recurring" etc.


What can you do with ServiceType?


Properties

Property Details
identity
READ-ONLY
"identity": 13
Type: Number
This is the unique numeric identifier for the ServiceType
name
"name": "Monthly Fee"
Type: String
User defined name for the the Service Type.
ownerId
READ-ONLY
"ownerId": 27
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": 16
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.


End Points

DELETEapi/v4/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/v4/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/v4/ServiceType/
Retrieve all of the ServiceType objects.
Retrieve all of the ServiceType objects.
GET api/v4/ServiceType/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Monthly Fee",
            "ownerId": 22,
            "ownerName": "Sample Text Data",
            "serviceBaseTypeId": 18,
            "serviceBaseTypeName": "Sample Text Data"
        }
    ]
}
GETapi/v4/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/v4/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/v4/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": "Monthly Fee",
                "ownerId": 5,
                "ownerName": "Sample Text Data",
                "serviceBaseTypeId": 21,
                "serviceBaseTypeName": "Sample Text Data"
            }
        ]
    }
}
GETapi/v4/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/v4/ServiceType/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Monthly Fee",
        "ownerId": 11,
        "ownerName": "Sample Text Data",
        "serviceBaseTypeId": 27,
        "serviceBaseTypeName": "Sample Text Data"
    }
}
POSTapi/v4/ServiceType/
Create a new instance of the ServiceType object.
Create a new instance of the ServiceType object.
POST api/v4/ServiceType/

{
    "name": "Monthly Fee",
    "serviceBaseTypeId": 15
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "create",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "name": "Monthly Fee",
                "ownerId": 9,
                "ownerName": "Sample Text Data",
                "serviceBaseTypeId": 19,
                "serviceBaseTypeName": "Sample Text Data"
            }
        ]
    }
}
POSTapi/v4/ServiceType/Search
Retreive a list of ServiceType objects based on search criteria. Search end points allow for retrieving results based on search criteria. Search criteria is sent as the payload of the POST.
Retreive a list of ServiceType objects based on search criteria.
POST api/v4/ServiceType/Search

{
    "query": {
        "top": 20,
        "search": [
            {
                "name": "MyFieldName",
                "operator": "startsWith",
                "value": "a"
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "itemCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Monthly Fee",
            "ownerId": 14,
            "ownerName": "Sample Text Data",
            "serviceBaseTypeId": 4,
            "serviceBaseTypeName": "Sample Text Data"
        }
    ]
}
PUTapi/v4/ServiceType/{id}
Update an existing instance of the ServiceType object.
Update an existing instance of the ServiceType object.
PUT api/v4/ServiceType/{id}

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