ProRoster - Get matching swops

API Url

Use it for returning a list of days

GET

http://localhost:16010/ProMarkREST/rest/ProRoster/employees/{id}/swop-shifts

Permissions: user

Path parameters

Field	Type	Description
id	Number	The id of the source employee

Query parameters

Field	Type	Description
date`optional`	Date	The date of the source
empIds`optional`	String	List of target empIds separated with comma delimiter.
from`optional`	Date	The start date of the period you want to match
planId`optional`	Date	The id of the plan
shiftId`optional`	Date	The id of the source shift. If not sent, swapping of days is matched.
to`optional`	Date	The date of the source

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
employees	Object[]	Array of employees
canSwop	Boolean	True if day can be swapped.
date	Date	The date in which the swop matches.
empId	String	Employee id
empName	String	Employee full name
empNo	String	Employee number
shifts`optional`	Object[]	Collection of shifts.
attendanceTime`optional`	Object[]	Attendancetime interval of the shift.
endTime`optional`	Number	End time of the interval in seconds.
startTime`optional`	Number	Start time of the interval in seconds.
canSwop	Date	True if shift can be swapped.
date	Date	The date of the shift.
dayProfile`optional`	Object[]	The day profile object.
backColor`optional`	String	BackGround color.
description	String	Description of the day profile.
endTime`optional`	Number	Normal time end of day profile.
foreColor`optional`	String	ForeGround color.
id	String	Day profile ID.
isVariable	Boolean	True if day profile is variable.
startTime`optional`	Number	Normal time start of day profile.
department`optional`	Object[]	The department object.
description`optional`	String	Description of the department.
id	String	Id of the department.
empId	String	The Id of the employee.
group`optional`	Object[]	The group object.
description`optional`	String	Description of the group.
id	String	Id of the group.
id	Number	The Id of the shift.
isPublished	Boolean	True if shift is published False if not.
normalTime`optional`	Object[]	Normal time interval for variable day profiles.
endTime`optional`	Number	End time of the interval in seconds.
startTime`optional`	Number	Start time of the interval in seconds.
planId	Number	The Id of the plan.
code	String	The code of the message.
message	String	The text of the message.
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": {
            "employees": [
                {
                    "empId": "1191",
                    "empNo": "DST",
                    "empName": "Dwight Schrute",
                    "date": "2019-09-30",
                    "canSwop": true,
                    "shifts": [
                        {
                            "id": "2163650668\u00011191\u00012458758\u00010",
                            "empId": "1191",
                            "date": "2019-09-30",
                            "canSwop": true,
                            "planId": 2163650668,
                            "isPublished": true,
                            "dayProfile": [
                                {
                                    "id": "FLEX",
                                    "startTime": 28800,
                                    "endTime": 57600,
                                    "description": "Fixed/flex",
                                    "isVariable": false,
                                    "foreColor": "FFFFFF",
                                    "backColor": "5032F5"
                                }
                            ],
                            "department": [
                                {
                                    "id": "WAREHOUSE",
                                    "description": "FGN warehouse department"
                                }
                            ],
                            "group": [
                                {
                                    "id": "WHGRP",
                                    "description": "FGN's Warehouse group"
                                }
                            ]
                        }
                    ]
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}