GET shift
A call to this method returns a full audit report for shifts.| SentDateRangeFilter | If populated, returns only shifts sent between the specified range
UseDefaultAccountRange:
|
| StartDateRangeFilter | If populated, returns only shifts with shift start time falling in the specified range
UseDefaultAccountRange:
|
| ShiftStatus | If populated, returns only shifts with specified status
The possible values for this parameter are:
|
| SortBy | This parameter specifies the sort option
The possible values for this parameter are:
|
| PageNumber | This parameter specifies the page number (e.g. 0,1,2…) |
| PageSize | This parameter specifies the page size (e.g. 10,20,30…) |
| IsSortAscending | This parameter specifies the order for the sort option. The possible values are true and false |
| TimeZone | This parameter specifies the timezone. The value for this parameter should be same as the timezone which was used in the SendShift and ScheduleShift method.
Please see the ‘TimeZone’ section to see the possible values that can be specified for timezone. |
| OwnerRefList | This optional parameter specifies the list of user ids for the shiftex account. The size of OwnerRefList parameter depends on the number of Shiftex users. If there is only one user, the list will have only one element. Please see appendix 7 for how to obtain the value for this parameter. |
| Location | If populated, returns only shifts with specified location. |
| ShiftIdList | This parameter specifies the list of shiftIds (the shiftId that is returned from the SendShift and ScheduleShift methods e.g. ecad3e58-6311-492f-834a-267572968c08). If populated, retruns only shifts whose Id match with one of the elements specified in list of shiftIds |
| EmployeeKeyword | This parameter specifies employee information (e.g. first name, last name, email, mobile, landline) If populated, return only shifts whose employees’ information matches with the specified keyword |
| ManagerKeyword | This parameter specifies manager information (e.g.email, mobile) If populated, return only shifts whose managers’ information matches the specified keyword For example, if ‘6475558888 is specified as ‘ManagerKeyword’, All shifts whose notifications were sent to ‘6475558888’ will be retruned. |
Example Request
GETGET http://localhost/shiftex/api/shift?Location=MyLocation&PageSize=3&ShiftStatus=Available HTTP/1.1 Accept: application/json; version=2.0 SessionId: 77YiBch7QnkfIqDcY6yp3J+tO7flbsLRU1Je+egRjgE=
[
{
"shiftId": "50e1b6ff-1cd5-444f-b6ab-c28507e93b33",
"storeLocation": {
"id": null,
"name": "MyLocation",
"timeZone": "Etc/GMT+4"
},
"shiftReportEmployees": [ {
"id": "219853",
"smsContacts": [],
"emailContacts": [],
"ivrContacts": []
}],
"fillMechanic": 1,
"status": "Available",
"numberOfPositions": 1,
"positionsClaimed": 0,
"startOn": "2013-11-30T07:00:00",
"endOn": "2013-11-30T15:00:00",
"scheduledOn": "2013-03-08T09:22:59",
"deployOn": "2013-03-08T09:23:00.41",
"createdOn": "2013-03-08T09:23:00.41",
"comment": "?",
"shiftReportManagers": [ {
"id": "1000",
"smsNumber": null,
"email": "manager@jda.com"
}],
"expireOn": "2013-11-30T15:00:00",
"job": {
"id": "",
"name": ""
}
},
{
"shiftId": "b62be408-7059-43a5-9f9c-f7f7d39575af",
"storeLocation": {
"id": null,
"name": "MyLocation",
"timeZone": "Etc/GMT+5"
},
"shiftReportEmployees": [
{
"id": "gfgg0",
"firstName": "Employee 1",
"lastName": "",
"rank": 0,
"smsContacts": [],
"emailContacts": [ {
"status": "Pending",
"sentOn": "2013-03-25T12:57:26.463",
"responseOn": "2013-03-25T14:03:17.94",
"contact": "employee1@jda.com"
}],
"ivrContacts": [ {
"status": "AwaitingResponse",
"sentOn": "2013-03-25T12:57:26.443",
"contact": "6473387587"
}],
"status": "Pending",
"responseOn": "2013-03-25T14:03:17.94",
"responseChannel": "Email"
},
{
"id": "gfgg1",
"firstName": "Employee 2",
"lastName": "",
"rank": 0,
"smsContacts": [],
"emailContacts": [],
"ivrContacts": [ {
"status": "AwaitingResponse",
"sentOn": "2013-03-25T12:57:26.47",
"contact": "1234567890"
}],
"status": "AwaitingResponse"
}
],
"fillMechanic": 4,
"status": "Available",
"numberOfPositions": 2,
"positionsClaimed": 0,
"startOn": "2013-04-14T09:00:00",
"endOn": "2013-04-14T10:01:00",
"scheduledOn": "2013-03-25T12:57:18.143",
"deployOn": "2013-03-25T12:57:20.963",
"createdOn": "2013-03-25T12:57:20.963",
"comment": "",
"shiftReportManagers": [
{
"id": "1000",
"smsNumber": null,
"email": "manager@jda.com"
}
],
"expireOn": "2013-04-14T10:20:00",
"job": {
"id": "",
"name": ""
}
}
]