TAG LINE
SMALL TITLE

Service

(API Version v4)


What can you do with Service?


Properties

Property Details
identity
READ-ONLY
"identity": 10
Type: Number
This is the unique numeric identifier for the Service
name
"name": "Hello World"
Type: String
ownerId
READ-ONLY
"ownerId": 14
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.
serviceTypeId
"serviceTypeId": 13
Type: Number
Unique identifier for the associated ServiceType object.
serviceTypeName
"serviceTypeName": "Sample Name"
Type: String
The name of the object associated with the serviceTypeId property.
usageFrequency
"usageFrequency": 17
Type: Number
usageFrequencyTypeId
"usageFrequencyTypeId": 5
Type: Number
Unique identifier for the associated FrequencyType object.
usageFrequencyTypeName
"usageFrequencyTypeName": "Sample Name"
Type: String
The name of the object associated with the usageFrequencyTypeId property.
created
READ-ONLY
"created": "2021-04-26T15:25:27.587Z"
Type: Date
This is a system generated date when the record was created. Date and time values are specified in the ISO 8601 format.
isActive
"isActive": true
Type: Boolean
isTaxExempt
"isTaxExempt": true
Type: Boolean
isInclusiveTaxes
"isInclusiveTaxes": true
Type: Boolean
generalLedgerId
"generalLedgerId": 3
Type: Number
Unique identifier for the associated GeneralLedger object.
generalLedgerName
"generalLedgerName": "Sample Name"
Type: String
The name of the object associated with the generalLedgerId property.
taxCodeId
"taxCodeId": 6
Type: Number
Unique identifier for the associated TaxCode object.
taxCodeName
"taxCodeName": "Sample Name"
Type: String
The name of the object associated with the taxCodeId property.
serviceTaxCategoryId
"serviceTaxCategoryId": 16
Type: Number
Unique identifier for the associated ServiceTaxCategory object.
serviceTaxCategoryName
"serviceTaxCategoryName": "Sample Name"
Type: String
The name of the object associated with the serviceTaxCategoryId property.
defaultServiceStatusTypeId
"defaultServiceStatusTypeId": 12
Type: Number
Unique identifier for the associated ServiceStatusType object.
defaultServiceStatusTypeName
"defaultServiceStatusTypeName": "Sample Name"
Type: String
The name of the object associated with the defaultServiceStatusTypeId property.
serviceCategoryId
"serviceCategoryId": 23
Type: Number
Unique identifier for the associated ServiceCategory object.
serviceCategoryName
"serviceCategoryName": "Sample Name"
Type: String
The name of the object associated with the serviceCategoryId property.
description
"description": "Hello World"
Type: String
id
"id": 26
Type: Number


Patch Types

The PATCH verb allows you to update an object. Just like a put, you only need to supply the fields that will be updated in the payload. However, a patch allows you to update many objects at once.

PATCH operations can be used as a standard API call or nested within the envelope of a DataFlow. Below you will find the child objects that can be updated as part of PATCH operations for the Service object.

Standard PATCH objects:

DataFlow PATCH objects:


End Points

DELETEapi/v4/Service/{id}
Delete an instance of the Service 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 Service object.
Delete an instance of the Service object.
DELETE api/v4/Service/{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": "service"
            },
            {
                "lhsId": 2,
                "rhsId": 2,
                "action": "detached",
                "dtoTypeKey": "sampleObjectConnector"
            },
            {
                "foreignKeyIdentity": 2,
                "action": "deleted",
                "dtoTypeKey": "sampleObject"
            }
        ]
    }
}
GETapi/v4/Service/
Retrieve all of the Service objects.
Retrieve all of the Service objects.
GET api/v4/Service/
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "ownerId": 3,
            "ownerName": "Sample Text Data",
            "serviceTypeId": 27,
            "serviceTypeName": "Sample Text Data",
            "usageFrequency": 20,
            "usageFrequencyTypeId": 4,
            "usageFrequencyTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "isActive": true,
            "isTaxExempt": true,
            "isInclusiveTaxes": true,
            "generalLedgerId": 24,
            "generalLedgerName": "Sample Text Data",
            "taxCodeId": 20,
            "taxCodeName": "Sample Text Data",
            "serviceTaxCategoryId": 12,
            "serviceTaxCategoryName": "Sample Text Data",
            "defaultServiceStatusTypeId": 25,
            "defaultServiceStatusTypeName": "Sample Text Data",
            "serviceCategoryId": 10,
            "serviceCategoryName": "Sample Text Data",
            "description": "Sample Text Data",
            "id": 17
        }
    ]
}
GETapi/v4/Service/AvailableFor/SharePlans
Returns the list of Service objects available for configuration on a Share Plan.
Returns the list of Service objects available for configuration on a Share Plan.
GET api/v4/Service/AvailableFor/SharePlans
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "totalCount": 1,
    "items": [
        {
            "identity": 1,
            "name": "Sample Text Data",
            "ownerId": 9,
            "ownerName": "Sample Text Data",
            "serviceTypeId": 25,
            "serviceTypeName": "Sample Text Data",
            "usageFrequency": 10,
            "usageFrequencyTypeId": 17,
            "usageFrequencyTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "isActive": true,
            "isTaxExempt": true,
            "isInclusiveTaxes": true,
            "generalLedgerId": 10,
            "generalLedgerName": "Sample Text Data",
            "taxCodeId": 22,
            "taxCodeName": "Sample Text Data",
            "serviceTaxCategoryId": 22,
            "serviceTaxCategoryName": "Sample Text Data",
            "defaultServiceStatusTypeId": 10,
            "defaultServiceStatusTypeName": "Sample Text Data",
            "serviceCategoryId": 17,
            "serviceCategoryName": "Sample Text Data",
            "description": "Sample Text Data",
            "id": 9
        }
    ]
}
GETapi/v4/Service/Paged
Retrieve all of the Service 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 Service objects in a paged fashion.
GET api/v4/Service/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": 14,
                "ownerName": "Sample Text Data",
                "serviceTypeId": 26,
                "serviceTypeName": "Sample Text Data",
                "usageFrequency": 23,
                "usageFrequencyTypeId": 0,
                "usageFrequencyTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "isActive": true,
                "isTaxExempt": true,
                "isInclusiveTaxes": true,
                "generalLedgerId": 20,
                "generalLedgerName": "Sample Text Data",
                "taxCodeId": 12,
                "taxCodeName": "Sample Text Data",
                "serviceTaxCategoryId": 0,
                "serviceTaxCategoryName": "Sample Text Data",
                "defaultServiceStatusTypeId": 10,
                "defaultServiceStatusTypeName": "Sample Text Data",
                "serviceCategoryId": 22,
                "serviceCategoryName": "Sample Text Data",
                "description": "Sample Text Data",
                "id": 19
            }
        ]
    }
}
GETapi/v4/Service/Paged/Detail
Retrieve all of the Service objects in a paged fashion with all object details. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
Retrieve all of the Service objects in a paged fashion with all object details.
GET api/v4/Service/Paged/Detail
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": 23,
                "ownerName": "Sample Text Data",
                "serviceTypeId": 9,
                "serviceTypeName": "Sample Text Data",
                "usageFrequency": 24,
                "usageFrequencyTypeId": 18,
                "usageFrequencyTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "isActive": true,
                "isTaxExempt": true,
                "isInclusiveTaxes": true,
                "generalLedgerId": 24,
                "generalLedgerName": "Sample Text Data",
                "taxCodeId": 22,
                "taxCodeName": "Sample Text Data",
                "serviceTaxCategoryId": 2,
                "serviceTaxCategoryName": "Sample Text Data",
                "defaultServiceStatusTypeId": 22,
                "defaultServiceStatusTypeName": "Sample Text Data",
                "serviceCategoryId": 1,
                "serviceCategoryName": "Sample Text Data",
                "description": "Sample Text Data",
                "id": 27,
                "details": {
                    "sampleSingleObject": {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    },
                    "sampleMultipleObjects": {
                        "totalCount": 1,
                        "items": [
                            {
                                "identity": 2,
                                "property1": "Sample Text",
                                "property2": "2021-04-26T15:25:29.117Z",
                                "property3": 2
                            }
                        ]
                    }
                }
            }
        ]
    }
}
GETapi/v4/Service/{id}
Retrieve an instance of the Service object by its ID.
{id}Unique identifier for the Service object.
Retrieve an instance of the Service object by its ID.
GET api/v4/Service/{id}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Sample Text Data",
        "ownerId": 17,
        "ownerName": "Sample Text Data",
        "serviceTypeId": 1,
        "serviceTypeName": "Sample Text Data",
        "usageFrequency": 22,
        "usageFrequencyTypeId": 27,
        "usageFrequencyTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "isActive": true,
        "isTaxExempt": true,
        "isInclusiveTaxes": true,
        "generalLedgerId": 4,
        "generalLedgerName": "Sample Text Data",
        "taxCodeId": 10,
        "taxCodeName": "Sample Text Data",
        "serviceTaxCategoryId": 19,
        "serviceTaxCategoryName": "Sample Text Data",
        "defaultServiceStatusTypeId": 7,
        "defaultServiceStatusTypeName": "Sample Text Data",
        "serviceCategoryId": 8,
        "serviceCategoryName": "Sample Text Data",
        "description": "Sample Text Data",
        "id": 16
    }
}
GETapi/v4/Service/{id}/Detail
Retrieve deep detail of the Service object by its ID. This endpoint returns additional detailed data related to this object. The specifics on which data is returned will depend on which related objects have been populated in the system.
{id}Unique identifier for the Service object.
Retrieve deep detail of the Service object by its ID.
GET api/v4/Service/{id}/Detail
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "instance": {
        "identity": 1,
        "name": "Sample Text Data",
        "ownerId": 18,
        "ownerName": "Sample Text Data",
        "serviceTypeId": 4,
        "serviceTypeName": "Sample Text Data",
        "usageFrequency": 8,
        "usageFrequencyTypeId": 3,
        "usageFrequencyTypeName": "Sample Text Data",
        "created": "2021-04-26T15:25:27.587Z",
        "isActive": true,
        "isTaxExempt": true,
        "isInclusiveTaxes": true,
        "generalLedgerId": 11,
        "generalLedgerName": "Sample Text Data",
        "taxCodeId": 7,
        "taxCodeName": "Sample Text Data",
        "serviceTaxCategoryId": 6,
        "serviceTaxCategoryName": "Sample Text Data",
        "defaultServiceStatusTypeId": 8,
        "defaultServiceStatusTypeName": "Sample Text Data",
        "serviceCategoryId": 14,
        "serviceCategoryName": "Sample Text Data",
        "description": "Sample Text Data",
        "id": 3,
        "details": {
            "sampleSingleObject": {
                "identity": 2,
                "property1": "Sample Text",
                "property2": "2021-04-26T15:25:29.117Z",
                "property3": 2
            },
            "sampleMultipleObjects": {
                "totalCount": 1,
                "items": [
                    {
                        "identity": 2,
                        "property1": "Sample Text",
                        "property2": "2021-04-26T15:25:29.117Z",
                        "property3": 2
                    }
                ]
            }
        }
    }
}
PATCHapi/v4/Service/{id}
Update or Add the Service object and optionally make changes to any child objects. Patch end points allow for adding/updating multiple related entities and the results of those changes will be reported in the response JSON payload in the items array.
{id}Unique identifier for the Service object.
Update or Add the Service object and optionally make changes to any child objects.
PATCH api/v4/Service/{id}

{
    "details": {},
    "services": {
        "items": [
            {
                "patchType": "create",
                "patchClientId": 1,
                "name": "Sample Text Data",
                "serviceTypeId": 22,
                "usageFrequency": 24,
                "usageFrequencyTypeId": 13,
                "isActive": true,
                "isTaxExempt": true,
                "isInclusiveTaxes": true,
                "generalLedgerId": 14,
                "taxCodeId": 1,
                "serviceTaxCategoryId": 0,
                "defaultServiceStatusTypeId": 19,
                "serviceCategoryId": 10,
                "description": "Sample Text Data",
                "id": 5
            }
        ]
    }
}
View Sample Response
HTTP/1.1 200 OK
{
    "trackingId": "d2ae5304-2355-44eb-a328-272f02935f8b",
    "type": "patch",
    "results": {
        "totalCount": 1,
        "items": [
            {
                "identity": 1,
                "action": "created",
                "dtoTypeKey": "service",
                "instance": {
                    "identity": 1,
                    "name": "Sample Text Data",
                    "ownerId": 10,
                    "ownerName": "Sample Text Data",
                    "serviceTypeId": 11,
                    "serviceTypeName": "Sample Text Data",
                    "usageFrequency": 17,
                    "usageFrequencyTypeId": 14,
                    "usageFrequencyTypeName": "Sample Text Data",
                    "created": "2021-04-26T15:25:27.587Z",
                    "isActive": true,
                    "isTaxExempt": true,
                    "isInclusiveTaxes": true,
                    "generalLedgerId": 4,
                    "generalLedgerName": "Sample Text Data",
                    "taxCodeId": 9,
                    "taxCodeName": "Sample Text Data",
                    "serviceTaxCategoryId": 15,
                    "serviceTaxCategoryName": "Sample Text Data",
                    "defaultServiceStatusTypeId": 20,
                    "defaultServiceStatusTypeName": "Sample Text Data",
                    "serviceCategoryId": 9,
                    "serviceCategoryName": "Sample Text Data",
                    "description": "Sample Text Data",
                    "id": 9
                }
            }
        ]
    }
}
POSTapi/v4/Service/
Create a new instance of the Service object.
Create a new instance of the Service object.
POST api/v4/Service/

{
    "name": "Sample Text Data",
    "serviceTypeId": 24,
    "usageFrequency": 5,
    "usageFrequencyTypeId": 3,
    "isActive": true,
    "isTaxExempt": true,
    "isInclusiveTaxes": true,
    "generalLedgerId": 18,
    "taxCodeId": 3,
    "serviceTaxCategoryId": 18,
    "defaultServiceStatusTypeId": 25,
    "serviceCategoryId": 9,
    "description": "Sample Text Data",
    "id": 11
}
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",
                "serviceTypeId": 2,
                "serviceTypeName": "Sample Text Data",
                "usageFrequency": 19,
                "usageFrequencyTypeId": 12,
                "usageFrequencyTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "isActive": true,
                "isTaxExempt": true,
                "isInclusiveTaxes": true,
                "generalLedgerId": 19,
                "generalLedgerName": "Sample Text Data",
                "taxCodeId": 23,
                "taxCodeName": "Sample Text Data",
                "serviceTaxCategoryId": 20,
                "serviceTaxCategoryName": "Sample Text Data",
                "defaultServiceStatusTypeId": 6,
                "defaultServiceStatusTypeName": "Sample Text Data",
                "serviceCategoryId": 4,
                "serviceCategoryName": "Sample Text Data",
                "description": "Sample Text Data",
                "id": 25
            }
        ]
    }
}
POSTapi/v4/Service/Search
Retreive a list of Service 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 Service objects based on search criteria.
POST api/v4/Service/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": "Sample Text Data",
            "ownerId": 27,
            "ownerName": "Sample Text Data",
            "serviceTypeId": 16,
            "serviceTypeName": "Sample Text Data",
            "usageFrequency": 18,
            "usageFrequencyTypeId": 19,
            "usageFrequencyTypeName": "Sample Text Data",
            "created": "2021-04-26T15:25:27.587Z",
            "isActive": true,
            "isTaxExempt": true,
            "isInclusiveTaxes": true,
            "generalLedgerId": 8,
            "generalLedgerName": "Sample Text Data",
            "taxCodeId": 24,
            "taxCodeName": "Sample Text Data",
            "serviceTaxCategoryId": 23,
            "serviceTaxCategoryName": "Sample Text Data",
            "defaultServiceStatusTypeId": 4,
            "defaultServiceStatusTypeName": "Sample Text Data",
            "serviceCategoryId": 12,
            "serviceCategoryName": "Sample Text Data",
            "description": "Sample Text Data",
            "id": 21
        }
    ]
}
PUTapi/v4/Service/{id}
Update an existing instance of the Service object.
Update an existing instance of the Service object.
PUT api/v4/Service/{id}

{
    "identity": 1,
    "name": "Sample Text Data",
    "serviceTypeId": 2,
    "usageFrequency": 10,
    "usageFrequencyTypeId": 4,
    "isActive": true,
    "isTaxExempt": true,
    "isInclusiveTaxes": true,
    "generalLedgerId": 16,
    "taxCodeId": 16,
    "serviceTaxCategoryId": 23,
    "defaultServiceStatusTypeId": 7,
    "serviceCategoryId": 2,
    "description": "Sample Text Data",
    "id": 24
}
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": 21,
                "ownerName": "Sample Text Data",
                "serviceTypeId": 22,
                "serviceTypeName": "Sample Text Data",
                "usageFrequency": 2,
                "usageFrequencyTypeId": 23,
                "usageFrequencyTypeName": "Sample Text Data",
                "created": "2021-04-26T15:25:27.587Z",
                "isActive": true,
                "isTaxExempt": true,
                "isInclusiveTaxes": true,
                "generalLedgerId": 23,
                "generalLedgerName": "Sample Text Data",
                "taxCodeId": 12,
                "taxCodeName": "Sample Text Data",
                "serviceTaxCategoryId": 20,
                "serviceTaxCategoryName": "Sample Text Data",
                "defaultServiceStatusTypeId": 7,
                "defaultServiceStatusTypeName": "Sample Text Data",
                "serviceCategoryId": 4,
                "serviceCategoryName": "Sample Text Data",
                "description": "Sample Text Data",
                "id": 26
            }
        ]
    }
}