Configuration and Content API Guide

Get System Employee Property Operators

post

/config/sim/v2/employees/getSystemEmployeePropertyOperators

Gets all System Employee Property Operators

Request

Supported Media Types

application/json
multipart/form-data

Root Schema : schema

Type: object

Show Source

include: string

If specified, limits the data returned to these fields.

Example: objectNum, hierUnitId
includeAll: string

If this value is specified, the include parameter is ignored.

Value Description

basic Forces the response to include all fields except option string details

detailed Forces the response to include all fields including option string details

Example: detailed
langIds: string

If specified, limits translated strings returned

Example: 1,2,3
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. Allowed fields are objectNum and hierUnitId

Example: objectNum:asc
searchCriteria: string

If specified, returns records that match the criteria. Allowed fields are objectNum and hierUnitId

Example: where equals(objectnum, 1792)

{
    "type":"object",
    "properties":{
        "searchCriteria":{
            "type":"string",
            "example":"where equals(objectnum, 1792)",
            "description":"If specified, returns records that match the criteria. Allowed fields are objectNum and hierUnitId"
        },
        "include":{
            "type":"string",
            "example":"objectNum, hierUnitId",
            "description":"If specified, limits the data returned to these fields."
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"If this value is specified, the include parameter is ignored.\n<table>\n<tr>\n  <td><b>Value</b></td>\n  <td><b>Description</b></td>\n</tr>\n<tr>\n  <td>basic</td>\n  <td>Forces the response to include all fields except option string details</td>\n</tr>\n<tr>\n  <td>detailed</td>\n  <td>Forces the response to include all fields including option string details</td>\n</tr>\n</table>\n"
        },
        "langIds":{
            "type":"string",
            "description":"If specified, limits translated strings returned",
            "example":"1,2,3"
        },
        "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",
            "description":"Sorts the response by the specified field name and sort order. Allowed fields are objectNum and hierUnitId",
            "example":"objectNum:asc"
        }
    }
}

Response

Supported Media Types

application/json

200 Response

Success

Root Schema : schema

Type: object

Show Source

count: integer

Number of records returned on this page

Example: 10
hasMore: boolean

Indicates whether there are additional pages of records

Example: true
items: array items

System employee property operator records
limit: integer

The maximum number of records returned on a page

Example: 10
offset: integer

The page number of this data. Starts at 0.

Example: 0
totalResults: integer

Total number of records in the data set

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "description":"Total number of records in the data set",
            "type":"integer",
            "example":100
        },
        "hasMore":{
            "description":"Indicates whether there are additional pages of records",
            "type":"boolean",
            "example":true
        },
        "count":{
            "description":"Number of records returned on this page",
            "type":"integer",
            "example":10
        },
        "offset":{
            "description":"The page number of this data.  Starts at 0.",
            "type":"integer",
            "example":0
        },
        "limit":{
            "description":"The maximum number of records returned on a page",
            "type":"integer",
            "example":10
        },
        "items":{
            "description":"System employee property operator records",
            "type":"array",
            "items":{
                "$ref":"#/definitions/SystemEmployeePropertyOperator"
            }
        }
    }
}

Nested Schema : items

Type: array

System employee property operator records

Show Source

Array of: object SystemEmployeePropertyOperator

System employee property operator record

{
    "description":"System employee property operator records",
    "type":"array",
    "items":{
        "$ref":"#/definitions/SystemEmployeePropertyOperator"
    }
}

Nested Schema : SystemEmployeePropertyOperator

Type: object

System employee property operator record

Show Source

cashierObjNum: integer

Object number of the cashier linked to the workstation operator..

Example: 1
hierUnitId: integer

Hierarchy unit value of operator associated with employee.

Example: 3599
objectNum: integer

Object number of the system employee.

Example: 1

{
    "description":"System employee property operator record",
    "type":"object",
    "properties":{
        "objectNum":{
            "description":"Object number of the system employee.",
            "type":"integer",
            "example":1
        },
        "hierUnitId":{
            "description":"Hierarchy unit value of operator associated with employee.",
            "type":"integer",
            "example":3599
        },
        "cashierObjNum":{
            "description":"Object number of the cashier linked to the workstation operator..",
            "type":"integer",
            "example":1
        }
    }
}

Value	Description
basic	Forces the response to include all fields except option string details
detailed	Forces the response to include all fields including option string details