Show Source

• alternateId: integer
  ID to use instead of the Employee ID when signing into the workstation.

  Example: 2121
• checkName: string
  Name to print on guest checks.

  Example: Employee Check Name
• dataExtensions: array dataExtensions
  An array of data extensions for employees
• firstName: string
  Employee's first name, which prints on reports.

  Example: Employee
• group: integer
  The group of the employee.

  Example: 1
• id: integer
  ID number to identify the employee on workstations.

  Example: 2021
• infoLine1: string
  Information line 1

  Example: Information line 1
• infoLine2: string
  Information line 2

  Example: Information line 2
• infoLine3: string
  Information line 3

  Example: Information line 3
• infoLine4: string
  Information line 4

  Example: Information line 4
• isDataPrivacyConsentGranted: boolean
  The consent status of the employee.

  Example: false
• languageObjNum: integer
  The object number of the default language for the employee on the EMC and the workstation.

  Example: 1
• lastName: string
  Employee's last name, which prints on reports.

  Example: Employee
• level: integer
  The level of the employee. This value should be between 1-9.

  Example: 1
• localeObjNum: integer
  The object number of the locale of the employee

  Example: 1
• objectNum(required): integer
  Unique reference of the employee in the system.

  Example: 1
• payrollId: string
  External payroll ID for the employee.

  Example: EMP-01
• pin: integer
  PIN for the employee.

  Example: 2222
• terminationDate: string
  The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added

  Example: 2021-11-21T00:00:00.000Z
• userName: string
  The login name for the EMC.

  Example: empName

{
    "type":"object",
    "required":[
        "objectNum"
    ],
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the employee in the system."
        },
        "firstName":{
            "type":"string",
            "example":"Employee",
            "description":"Employee's first name, which prints on reports."
        },
        "lastName":{
            "type":"string",
            "example":"Employee",
            "description":"Employee's last name, which prints on reports."
        },
        "checkName":{
            "type":"string",
            "example":"Employee Check Name",
            "description":"Name to print on guest checks."
        },
        "languageObjNum":{
            "type":"integer",
            "example":1,
            "description":"The object number of the default language for the employee on the EMC and the workstation."
        },
        "payrollId":{
            "type":"string",
            "example":"EMP-01",
            "description":"External payroll ID for the employee."
        },
        "id":{
            "type":"integer",
            "example":2021,
            "description":"ID number to identify the employee on workstations."
        },
        "alternateId":{
            "type":"integer",
            "example":2121,
            "description":"ID to use instead of the Employee ID when signing into the workstation."
        },
        "pin":{
            "type":"integer",
            "example":2222,
            "description":"PIN for the employee."
        },
        "level":{
            "type":"integer",
            "example":1,
            "description":"The level of the employee. This value should be between 1-9."
        },
        "group":{
            "type":"integer",
            "example":1,
            "description":"The group of the employee."
        },
        "terminationDate":{
            "type":"string",
            "example":"2021-11-21T00:00:00.000Z",
            "description":"The date the employee was terminated.Format:YYYY-MM-DD. This value is set from Labor Management and cannot be added"
        },
        "isDataPrivacyConsentGranted":{
            "type":"boolean",
            "example":false,
            "description":"The consent status of the employee."
        },
        "infoLine1":{
            "type":"string",
            "example":"Information line 1",
            "description":"Information line 1"
        },
        "infoLine2":{
            "type":"string",
            "example":"Information line 2",
            "description":"Information line 2"
        },
        "infoLine3":{
            "type":"string",
            "example":"Information line 3",
            "description":"Information line 3"
        },
        "infoLine4":{
            "type":"string",
            "example":"Information line 4",
            "description":"Information line 4"
        },
        "userName":{
            "type":"string",
            "example":"empName",
            "description":"The login name for the EMC."
        },
        "localeObjNum":{
            "type":"integer",
            "example":1,
            "description":"The object number of the locale of the employee"
        },
        "dataExtensions":{
            "type":"array",
            "description":"An array of data extensions for employees",
            "items":{
                "$ref":"#/definitions/Employee_dataExtensions"
            }
        }
    }
}

Show Source

• Array of: object Employee_dataExtensions

{
    "type":"array",
    "description":"An array of data extensions for employees",
    "items":{
        "$ref":"#/definitions/Employee_dataExtensions"
    }
}

Show Source

• columnName: string
  Name of the extention field

  Example: extension column 1
• value: string
  Value of the extention field

  Example: value 1

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "example":"extension column 1",
            "description":"Name of the extention field"
        },
        "value":{
            "type":"string",
            "example":"value 1",
            "description":"Value of the extention field"
        }
    }
}