v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB

Employee Service

saveEmployeeV1

Create a new employee. Update an employee's details.

post/employee/v1/saveEmployee

Headers

authenticationtokenstring required

Secure token for API authentication.

passwordstring

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring

User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Request body

franchiseSitestring

franchiseSite description Option for the Franchisor to upload employee data on behalf of the Franchisee without modifying the API Header Parameters. If used, must be the "Franchise Code" from the the "Franchise" setup in Enterprise Manager

Example request

{
  "employee": [
    {
      "address1": "200 Main Street",
      "age": 29,
      "breakWaiver": "Y",
      "broadcastSchedule": "Y",
      "city": "Anywhere",
      "country": "USA",
      "createUser": 10000003,
      "dateCreate": "04/17/2012",
      "dateHired": "02/01/2012",
      "dateOfBirth": "07/30/1991",
      "dateTerminated": "12/31/9999",
      "editUser": 10000001,
      "employeeLocations": [
        {
          "activeFlag": "Y",
          "allocateLaborTo": "N",
          "deleteFlag": "N",
          "id": 17,
          "locationCityName": "Anywhere",
          "locationName": "AUTOMATION THREE",
          "locationStateName": "MASSACHUSETTS",
          "primaryLocationFlag": true
        }
      ],
      "employeeNumber": "AUTO-0000000004",
      "employeePositions": [
        {
          "deleteFlag": "N"
        }
      ],
      "federalMaritalStatus": "SINGLE",
      "firstName": "John",
      "lastName": "Doe",
      "locationName": "AUTOMATION THREE",
      "manager": "Y",
      "middleName": "Middle",
      "partTime": "Y",
      "payType": "H",
      "payrollIdNumber": "0000000004",
      "postalCode": "01234",
      "primaryPositionName": "DINING ROOM SERVER (GT)",
      "sex": "F",
      "stateMaritalStatus": "SINGLE",
      "stateProvince": "MA",
      "status": "Leave",
      "statusCode": "Terminated"
    }
  ]
}

Response

Success

object required