SelfService - Get swop requests

API Url

Used in Self-service for loading swop requests one or more employees.

GET

http://localhost:16010/ProMarkREST/rest/SelfService/swops

Permissions: user

Query parameters

Field	Type	Description
empId`optional`	String	List of employee IDs who has initiated the swop request, with comma delimiter. The list will be validated against list of allowed employees. If you want to remove an employee from list, then add a '-' in front of id.
from`optional`	Date	Get data from this date forward (never in the past). Default is TODAY.
swopEmpId`optional`	String	List of employee IDs who are target of swop requests, with comma delimiter. The list will be validated against list of allowed employees. If you want to remove an employee from list, then add a '-' in front of id.
to`optional`	Date	Get data until this date.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
swops	Object[]	Object containing the swop requests.
acceptBefore`optional`	Date	Date until you want the request to be accepted.
actions`optional`	Object[]	List of actions that can be performed on the request.
id	String	Action identifier ("accept", "cancel", "decline").
name	String	Short action name.
attendanceDate	Date	Shift attendance date.
clockIn`optional`	Date	Shift start date-time as ISO-8601.
clockOut`optional`	Date	Shift end date-time as ISO-8601.
comment`optional`	String	Comment on the swop request (will be visible to other employees).
dayProfileDesc	String	Day profile description of the vacant shift.
dayProfileId	String	The day profile ID of the shift.
empId	String	The employee ID initiating the swop (owner of the shift).
empName	String	Name of employee initiating the swop (owner of shift).
id	Number	Unique identifier of the swop request.
statusCode	Number	Status code of the offer request (0: Vacant shift, 1: Waiting for manager, 2: Wating for employee, 3: Approved by employee, waiting for manager/approver, 4: Approved by employee, waiting for 2nd manager/approver, 5: Rejected by employee, 6: Rejected by manager/approver, 7: Approved by manager/approver, 8: Approved, 99: Request was deleted). Size range: `0-99`
statusMessage	String	Status message of the offer request. In correlation with 'statusCode'.
swopWith	Object	Object containing the shift to be swoped with.
attendanceDate	Date	Shift attendance date.
clockIn`optional`	Date	Shift start date-time as ISO-8601.
clockOut`optional`	Date	Shift end date-time as ISO-8601.
comment`optional`	String	Comment of the swoped employee.
dayProfileDesc	String	Day profile description of the vacant shift.
dayProfileId	String	The day profile ID of the shift.
empId	String	The employee ID, owner of the shift to be swoped with.
empName	String	Employee name, owner of shift to be swoped with.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "swops": [
            {
               "id": 12345678,
               "statusCode": 2,
               "statusMessage": "Waiting for employee approval",
               "empId": "414",
               "empName": "John Doe",
               "attendanceDate": "2017-06-07",
               "dayProfileId": "SH1",
               "dayProfileDesc": "Morning shift",
               "clockIn": "2017-06-07T08:00:00",
               "clockOut": "2017-06-07T16:00:00",
               "acceptBefore": "2017-06-06",
               "comment": "My sister is getting married. Could you help?",
               "swopWith": 
               {
                  "empId": "769",
                  "empName": "Kenneth Bing",
                  "attendanceDate": "2017-06-07",
                  "dayProfileId": "EH2",
                  "dayProfileDesc": "Evening shift",
                  "clockIn": "2017-06-07T13:00:00",
                  "clockOut": "2017-06-07T22:00:00",
               },
               "actions": [
                  {
                     "id": "accept",
                     "name": "Accept"
                  },
                  {
                     "id": "decline",
                     "name": "Decline"
                  }
               ]
            }
         ]
      }
   }
}

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.