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

Header Parameters

• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

Request body

Root Schema : ServiceChargeGroupGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• include(optional): string
  Objects included in response

  Example: locations
• languages(optional): string
  If specified, limits translated strings returned

  Example: en-US,es-SS,lt-LT
• limit(optional): integer
  If using paging, number of results returned in this page.

  Example: 10
• offset(optional): integer
  Starting resource record index

  Example: 0
• orderBy(optional): string
  Sorts the response by the specified field name and sort order

  Example: objectNum:asc
• searchCriteria(optional): 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"
        },
        "languages":{
            "type":"string",
            "example":"en-US,es-SS,lt-LT",
            "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 : ServiceChargeGroup

Type: object

Model for ServiceChargeGroup Object

Show Source

• details(optional): 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(optional): object hierUnitName
  Additional Properties Allowed: additionalProperties

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

  Example: 1
• name: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• objectNum: integer
  Object number of the Service Charge Group

  Example: 1

{
    "description":"Model for ServiceChargeGroup Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "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",
                "es-SS":"Empresa",
                "lt=LT":"??mon??"
            },
            "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",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

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

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A string that contains translations into multiple languages\n\n**Example**\n`{ \"en-US\": \"coffee\", \"de-DE\": \"kaffee\", \"ar-AR\": \"????????\" }`\n",
    "type":"object",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "ar-AR":"????????"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "ar-AR":"????????"
}

Nested Schema : items

Type: object

Show Source

• sequenceNum(optional): integer
  Sequence number of the service charge group detail in the service charge group

  Example: 1
• svcName(optional): object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages **Example** `{ "en-US": "coffee", "de-DE": "kaffee", "ar-AR": "????????" }`
• svcObjNum(optional): 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(optional): string
  A short, human-readable summary of the problem.

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

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

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

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

  Example: VALIDATION ERROR
• type(optional): 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",
    "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