Jump to

• Request
• Response

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

Body ()

Request body

Root Schema : ServiceChargeGroupGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• 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
• 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",
    "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"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Service Charge Group Detail objects of the organization

Body ()

Root Schema : ServiceChargeGroupGetResponse

Type: object

Model for ServiceChargeGroup Object

Show Source

• details(required): array details
  An array of service charges that are part of the service charge group
• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 1
• hierUnitName(required): object hierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(required): integer
  Object number of the hierarchy unit

  Example: 1
• name(required): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• objectNum(required): integer
  Object number of the Service Charge Group

  Example: 1

{
    "description":"Model for ServiceChargeGroup Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "hierUnitObjNum",
        "hierUnitName",
        "name",
        "objectNum",
        "details"
    ],
    "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"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "name":{
            "$ref":"#/definitions/TranslatedString"
        },
        "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":{
                        "$ref":"#/definitions/TranslatedString"
                    }
                }
            }
        }
    }
}

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":{
                "$ref":"#/definitions/TranslatedString"
            }
        }
    }
}

Nested Schema : hierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "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"
    },
    "additionalProperties":{
        "type":"string"
    }
}

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 : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A string that contains translations into multiple languages",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "es-MX":"Cafe"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages

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 TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• 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":{
            "$ref":"#/definitions/TranslatedString"
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top