Configuration and Content API Guide

Get Service Charge Group Details

post

/config/sim/v1/sales/servicechargegroups/getdetails

Gets a list of all the Service Charge Group Detail for the specified Service Charge Group

Request

Supported Media Types

application/json
multipart/form-data

Request body

Root Schema : ServiceChargeGroupDetailGetRequest

Type: object

The input Body model that needs to be given.

Show Source

hierUnitId(required): integer

Unique reference of the hierarchy unit

Example: 1
include: string

Objects included in response

Example: locations
includeAll: string

This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

Example: detailed
languages: string

If specified, limits translated strings returned

Example: en-US, de-DE, es-MX
limit: integer

If using paging, number of results returned in this page.

Example: 10
objectNum(required): integer

Object number of the Service Charge Group

Example: 1
offset: integer

Starting resource record index

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order

Example: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value

Example: where equals(active,1)

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order"
        },
        "searchCriteria":{
            "type":"string",
            "example":"where equals(active,1)",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "example":"locations",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "example":"en-US, de-DE, es-MX",
            "description":"If specified, limits translated strings returned"
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the Service Charge Group",
            "type":"integer",
            "example":1
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Service Charge Group Details.

Root Schema : ServiceChargeGroupDetailGetResponsev1

Type: object

Show Source

count: integer

Current response record count.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Service Charge Group Detail objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Service Charge Group Detail objects of the organization.",
            "items":{
                "$ref":"#/definitions/ServiceChargeGroupDetailResponsev1"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Service Charge Group Detail objects of the organization.

Show Source

Array of: object ServiceChargeGroupDetailResponsev1

Model for ServiceChargeGroupDetail Object

{
    "type":"array",
    "description":"Array of Service Charge Group Detail objects of the organization.",
    "items":{
        "$ref":"#/definitions/ServiceChargeGroupDetailResponsev1"
    }
}

Nested Schema : ServiceChargeGroupDetailResponsev1

Type: object

Model for ServiceChargeGroupDetail Object

Show Source

hierUnitId: integer

Unique reference of the hierarchy unit

Example: 1
hierUnitName: object hierUnitName

A group of string objects representing the name of the hierarchy unit configured languages
hierUnitObjNum: integer

Object number of the hierarchy unit

Example: 1
objectNum: integer

Object number of the Service Charge Group

Example: 1
sequenceNum: integer

Sequence number of the service charge group detail in the service charge group

Example: 1
svcName: object svcName

SVC Name
svcObjNum: integer

Object number of the service charge

Example: 1

{
    "description":"Model for ServiceChargeGroupDetail Object",
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "description":"A group of string objects representing the name of the hierarchy unit configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            }
        },
        "objectNum":{
            "description":"Object number of the Service Charge Group",
            "type":"integer",
            "example":1
        },
        "sequenceNum":{
            "description":"Sequence number of the service charge group detail in the service charge group",
            "type":"integer",
            "example":1
        },
        "svcObjNum":{
            "description":"Object number of the service charge",
            "type":"integer",
            "example":1
        },
        "svcName":{
            "type":"object",
            "description":"SVC Name",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"Cafe"
            }
        }
    }
}

Nested Schema : hierUnitName

Type: object

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : svcName

Type: object

SVC Name

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}