Configuration and Content API Guide

Get Cashiers

post

/config/sim/v1/employees/getCashiers

Get all the cashiers.

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: 100
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",
            "description":"Starting resource record index. Not required if paging parameters are not supported.",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":100
        },
        "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 Cashiers objects.

Root Schema : CashiersGetResponseV1

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 Cashier objects.
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 Cashier objects.",
            "items":{
                "$ref":"#/definitions/CashierResponseV1"
            }
        },
        "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 Cashier objects.

Show Source

Array of: object CashierResponseV1

Model for Cashiers Object

{
    "type":"array",
    "description":"Array of Cashier objects.",
    "items":{
        "$ref":"#/definitions/CashierResponseV1"
    }
}

Nested Schema : CashierResponseV1

Type: object

Model for Cashiers Object

Show Source

hierUnitId: integer

Unique hierarchy unit id of the revenue center.

Example: 3599
name: object name

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

Object number of the cashiers.

Example: 1

{
    "description":"Model for Cashiers Object",
    "type":"object",
    "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"
}