Jump to

• Request
• Response

Get Cashiers

post

/config/sim/v1/employees/getCashiers

Get all the cashiers.

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A request body

Root Schema : GetCashiersRequest

Type: object

The input Body model that needs to be given for get request.

Show Source

• include: string
  Objects included in response
• 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
• limit: integer
  If using paging, number of results returned in this page.
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy: integer
  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

{
    "description":"The input Body model that needs to be given for get request.",
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "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",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"integer",
            "example":"objectNum:asc",
            "description":"Sorts the response by the specified field name and sort order."
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of Cashiers objects of the organization

Body ()

Root Schema : Cashiers

Type: object

Model for Cashiers Object

Show Source

• hierUnitId(required): integer
  Unique hierarchy unit id of the revenue center.

  Example: 3599
• name(required): object name
  A group of string objects representing the name of the cashiers in configured languages.
• objectNum(required): integer
  Object number of the cashiers.

  Example: 1

{
    "description":"Model for Cashiers Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique hierarchy unit id of the revenue center.",
            "type":"integer",
            "example":3599
        },
        "objectNum":{
            "description":"Object number of the cashiers.",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"A group of string objects representing the name of the cashiers in configured languages.",
            "type":"object",
            "example":{
                "en-US":"Cashier",
                "de-DE":"La caissiere",
                "es-MX":"Cajero"
            }
        }
    }
}

Nested Schema : name

Type: object

A group of string objects representing the name of the cashiers in configured languages.

Example:

{
    "en-US":"Cashier",
    "de-DE":"La caissiere",
    "es-MX":"Cajero"
}

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

Back to Top