Responses

• 200 application/json

  Request succeeded.

  Hide response attributes Show response attributes object

  • id string(uuid)

    The unique id.

  • createdTimestamp string(date-time) | null

    The date and time of creation in UTC time.

  • modifiedTimestamp string(date-time) | null

    The date and time last modification in UTC time.

  • lwaId string(uuid) | null

    The id of the Lone Wolf Account associated to the employee.

  • number string | null

    The assigned number.

  • firstName string Required

    The first name.

  • middleName string | null

    The middle name.

  • lastName string Required

    The last name.

  • nickname string | null

    The nickname.

  • officeId string(uuid) | null

    The id of the office to which the employee belongs.

  • inactiveDate string(date) | null

    The date the employee was inactive. If null, the employee is still active.

  • legalName string | null

    The legal name.

  • addressLine1 string | null

    The street address.

  • addressCity string | null

    The city.

  • addressProvinceCode string | null

    The two character state or province code.

  • addressPostalCode string | null

    The postal code. This will be unformatted.

  • emailAddressMain string | null

    The main email address.

  • birthDate string(date) | null

    The birthdate.

  • startDate string(date) | null

    The start date.

  • phoneNumberMain string | null

    The main phone number.

  • phoneNumberMobile string | null

    The mobile phone number.

  • phoneNumberPager string | null

    The pager number.

  • faxNumberMain string | null

    The fax number.

  • phoneNumberDirect string | null

    The direct phone number.

  • office object

    A read only representation of an office.

    Additional properties are NOT allowed.

    Hide office attributes Show office attributes object

    • name string | null

      The name of the office.

    • code string | null

      The code for the office.

• 400 application/json

  Invalid request. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 401 application/json

  Unauthorized. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.

• 403 application/json

  Permission denied. See response body for details.

  Hide response attributes Show response attributes object

  • id string

    The unique identifier for the error.

  • code integer(int32)

    A code used to help identify the type of error. This is typically set to the same value as the http status code.

  • message string

    A summary or short message describing the error.

  • details array[string] | null

    A list of more detailed errors messages.