Employee Service

getEmployeeNumbersV1

Retrieves a list of employee numbers from a specified location.

get/employee/v1/getEmployeeNumbers

Request

  • Base URL
    //webservices-test.net-chef.com (relative, and the document’s source URL is not known)
  • URL
    //webservices-test.net-chef.com/employee/v1/getEmployeeNumbers
  • Auth
    none declared. Required headers: authenticationtoken, password, sitename, userid

Query parameters

isIncludeTerminatedboolean

Use true to retrieve employees whose status is Terminated.

locationCodestring required

The Code that identifies the Location in Crunchtime.

minutesSinceUpdateinteger

The number of minutes since an employee record was last updated. Use to set how far back to search.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

string[] required

Changes

No recorded changes to this operation across all 2 revisions of this API.