GET shift/detailed/{id}

A call to this method returns all available data for a specific shift. Employee IDs may be filtered depending on the EmployeeStatus filter parameter.

Parameters

Id

The unique Id for the shift.

Example Values: fe2996b2-5fb5-4977-9026-fbb11082edf3

EmployeeStatus optional If populated, returns only employees with specified status in the array. If not populated, returns employees data of all employees according to ReportMode argument. The accepted values here, some of them only apply to channels as mentioned beside each status:
  • AwaitingResponse
  • Claimed
  • Rejected
  • NoAttempt
  • Bumped
  • LateAttempt
  • Pending
  • UnsuccessfulAttempt
  • NotAvailable (Channel only)
  • Inactive (Channel only)
  • Cancelled (Employee only)
  • Removed (Employee only)

Example Request

GET http://shiftex.vortexconnectstage.com/api/shift/detailed/fe2996b2-5fb5-4977-9026-fbb11082edf3 HTTP/1.1
Accept: application/json; version=2.0
sessionId: 77YiBch7QnkfIqDcY6yp3J+tO7flbsLRU1Je+egRjgE=

{
   "shiftId": "fe2996b2-5fb5-4977-9026-fbb11082edf3",
   "storeLocation":    {
      "id": "2043",
      "name": "Vortex Miami",
      "timeZone": "America/Toronto"
   },
   "shiftReportEmployees": [   {
      "id": "219853",
      "firstName": "Jose Gmail",
      "lastName": "Carballo",
      "rank": 0,
      "smsContacts": [      {
         "status": "NoAttempt",
         "sentOn": "2013-03-11T16:24:24.15",
         "contact": "7864006756"
      }],
      "emailContacts": [      {
         "status": "Claimed",
         "sentOn": "2013-03-11T16:24:24.15",
         "responseOn": "2013-03-11T16:40:34.427",
         "contact": "jcarballomiret@gmail.com"
      }],
      "ivrContacts": [      {
         "status": "NoAttempt",
         "sentOn": "2013-03-11T16:24:24.137",
         "contact": "7864006756"
      }],
      "status": "Claimed",
      "responseOn": "2013-03-11T16:40:34.427",
      "responseChannel": "Email"
   }],
   "fillMechanic": 1,
   "status": "Closed",
   "numberOfPositions": 1,
   "positionsClaimed": 1,
   "startOn": "2013-03-11T09:00:00",
   "endOn": "2013-03-11T17:00:00",
   "scheduledOn": "2013-03-11T16:24:21.263",
   "deployOn": "2013-03-11T16:24:23.887",
   "createdOn": "2013-03-11T16:24:23.887",
   "comment": "",
   "shiftReportManagers": [],
   "expireOn": "2013-03-11T17:00:00",
   "job":    {
      "id": "22",
      "name": "Developer"
   }
}