Configuration and Content API Guide

• 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

Copy{
    "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/CashierResponseV2"
            }
        },
        "offset":{
            "type":"integer",
            "example":"0",
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":"10",
            "description":"Server page size"
        }
    }
}

• Array of: object CashierResponseV2

  Model for Cashiers Object

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

• 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

Copy{
    "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":{
                "1":"Cashier",
                "2":"La caissiere",
                "3":"Cajero"
            }
        }
    }
}

• 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

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