Configuration and Content API Guide

Get Service Charge Groups

post

/config/sim/v1/sales/getservicechargegroups

Gets a list of all the Service Charge Group

Request

Supported Media Types

application/json
multipart/form-data

The input Body model that needs to be given.

Root Schema : schema

Type: object

Show Source

include: string

Objects included in the response.

Example: hierUnitId
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 the translated strings returned.

Example: en-US, es-ES, es-MX
limit: integer

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

Example: 0
offset: integer

Starting resource record index. Not required if paging parameters are not supported.

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(objectNum,1)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the 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, es-ES, es-MX",
            "description":"If specified, limits the translated strings returned."
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index. Not required if paging parameters are not supported."
        },
        "limit":{
            "type":"integer",
            "example":0,
            "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."
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A Collection of Service Charge Groups.

Root Schema : ServiceChargeGroupGetResponsev1

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 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 objects of the organization.",
            "items":{
                "$ref":"#/definitions/ServiceChargeGroupResponsev1"
            }
        },
        "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 objects of the organization.

Show Source

Array of: object ServiceChargeGroupResponsev1

Model for ServiceChargeGroup Object

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

Nested Schema : ServiceChargeGroupResponsev1

Type: object

Model for ServiceChargeGroup Object

Show Source

details: array details

An array of service charges that are part of the service charge group
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
name: object name

Name
objectNum: integer

Object number of the Service Charge Group

Example: 1

{
    "description":"Model for ServiceChargeGroup 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"
            }
        },
        "name":{
            "type":"object",
            "description":"Name",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"Cafe"
            }
        },
        "objectNum":{
            "description":"Object number of the Service Charge Group",
            "type":"integer",
            "example":1
        },
        "details":{
            "description":"An array of service charges that are part of the service charge group",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "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 : details

Type: array

An array of service charges that are part of the service charge group

Show Source

Array of: object items

{
    "description":"An array of service charges that are part of the service charge group",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "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 : name

Type: object

Name

Example:

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

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "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 : svcName

Type: object

SVC Name

Example:

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