POST shift/send

Sends a shift immediately which is to be communicated to employees via one or more of three available channels (SMS, Email, and IVR). Once deployed, employees attempt to claim the shift by responding to an SMS with a shift PIN code, clicking a link in an email or pressing 1 on an IVR call. Managers whose details have been sent with this request are alerted via SMS or email when the shift has been successfully filled by Shiftex.

Body properties

numberOfPositions

The number of available positions.

Example Values: 1

employees optional This parameter is an array of Employee objects. The Employee object is structured as follows:
  • employee.id string string (40 chars)
  • employee.smsNumbers (optional): an array of strings (100 chars) for North American numbers the format is: 14164567890
  • employee.emails (optional): an array of strings (200 chars)
  • employee.ivrNumbers (optional): an array of strings (100 chars)
  • employee.firstName : string (200 chars)
  • employee.lastName : string (200 chars)
  • employee.rank (optional) : int
  • employee.cultureName (optional): string

Example Values: 

[{ "id": "gfgg0", 
   "emails": ["jose.fraga@jda.com"],
   "ivrNumbers": ["6473387588"],
   "firstName": "Jose",
   "lastName": "Fraga"
},
{ "id": "gfgg1", 
  "emails": ["javier.carmen@jda.com"],
  "ivrNumbers": ["7864006756"],
  "firstName": "Javier",
  "lastName": "Carmen"
}]

managers

optional

 This parameter is an array of Manager objects. The Manager object is structured as follows:
  • manager.id: string (40 chars)
  • manager.smsNumber (optional): string (100 chars)
  • manager.email (optional): string (200 chars)
  • manager.cultureName (optional): string (20 chars)
  • manager.notifyOnEmployeeClaim (optional): bool default is true
  • manager.notifyOnWindowClose (optional): bool default is true
  • manager.notifyOnShiftClose (optional): bool default is true
fillMechanic

optional

 Property used to specify the desired fill mechanic logic This property is set to:
  • 1 for First-come-first-served fill mechanic
  • 2 for Window based Seniority fill mechanic
  • 3 for Sequential fill mechanic
  • 4 for Manager based fill mechanic
  • 5 for ExternalClaim fill mechanic
callBackURL

optional

 Used to specify which URL to call back with notifications on shift events.
comment

optional

 Comments to be added to the end of shift messages. Following tokens can be used in the Comment. They will be replaced with information in shift when message is sent to each employee. #@#EMP_PIN#@# PIN number used for IVR calls #@#NAME#@# Employee’s first name

Example Request

POST http://shiftex.vortexconnectstage.com/api/shift/send HTTP/1.1
Accept: application/json; version=2.0
Content-Type: application/json
sessionId: wORaLP4wa8MbhK3psvNrEif3Cc8a1wtQvYgwTv52qnQ=
Content-Length: 1250
Host: localhost

{
"storeLocation" : {"name": "5W Med Surg", "timeZone": "Etc/GMT+5"},
"startOn": "2014-05-14T09:00:00",
"endOn": "2014-05-14T10:01:00",
"expireOn": "2014-05-14T10:20:00",
"numberOfPositions": 2,
"employees": [{ "id": "gfgg0", 
			 "emails": ["jose.fraga@jda.com"],
			 "ivrNumbers": ["6473387588"],
			 "firstName": "Jose",
			 "lastName": "Fraga"
		    },
		    { "id": "gfgg1", 
		    	 "emails": ["javier.carmen@jda.com"],
		      "ivrNumbers": ["7864006756"],
		      "firstName": "Javier",
	           "lastName": "Carmen"
		    }					
],
"managers": [{ "id": "1000",
		     "email": "manager@jda.com",
		     "notifyOnEmployeeClaim": "true",
		     "notifyOnWindowClose": "true",
		     "notifyOnShiftClose": "true"
		   },
		   { "id": "1001",
		     "email": "manager2@gmail.com",
		     "notifyOnEmployeeClaim": "true",
		     "notifyOnWindowClose": "true",
		     "notifyOnShiftClose": "true"
		   },
		   { "id": "1002",
		     "email": "manager3@jda.com",
		     "notifyOnEmployeeClaim": "true",
		     "notifyOnWindowClose": "true",
		     "notifyOnShiftClose": "true"
		   }
],
"comment": "This is text comment",
"fillMechanic": 4,
"callBackURL": "http://yourURL/serviceName"
}

{"shiftId":"8a62d290-688d-41b8-a5a0-db8613835e9d"}