ProRoster - Get Demands

API Url

Use it for loading the list of the demands assigned to a plan.

GET

http://localhost:16010/ProMarkREST/rest/ProRoster/plans/{id}/demands

Permissions: user

Path parameters

Field	Type	Description
id	Number	The plan unique identifier.

Query parameters

Field	Type	Description
expand`optional`	String	Expand specified properties (comma delimiter) with descriptions. Only the "bids" can be expanded so far.
fields`optional`	String	List of fields with comma delimiter to include in the response. Example to get only 2 attributes fields=dayProfile,normalTime.
from`optional`	Date	Start date for loading demands.
hasBids`optional`	Boolean	TRUE = loads only the demands which contains bids.
pendingBids`optional`	Boolean	TRUE = filtering the bids waiting for approval. (the ones with bid status = 1).
to`optional`	Date	End date for loading demands.

Parameter

Field	Type	Description
ignoreDayProfile`optional`	Object[]
isLocked	Boolean	Is the attribute locked.
value	Boolean

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
demands	Object[]	List of demands.
acceptBefore`optional`	Object[]
days`optional`	Number	Accept days before shift takes place.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
approvalGroup`optional`	Object[]
description`optional`	String	Description of the approvalGroup.
id`optional`	String	Id of the approvalGroup.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
assignmentMethod`optional`	Object[]
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
method`optional`	String	Assignment methode Automatic = "A" or Manual "M".
attendanceTime`optional`	Object[]	Attendance time interval.
endTime`optional`	Number	End time of the interval in seconds.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean
startTime`optional`	Number	Start time of the interval in seconds.
backColor	String	BackGround color in HEX without #.
baseDemandId	Number	The Id of the base demand from which the demand was created.
bids	Object[]	List of demands.
approverId	String	The user id who approved the bid.
comment	String	Employee's comment.
demandId	Number	The Id of the plan on which was bidded.
empId	String	The Id of the employee who bidded on the shift.
empName	String	The name of the employee who bidded on the shift.
id	Number	The Id of the bid.
status	String	1: Employee has bid on the shift. 2: The employee has been assigned the shift. 3: Declined. The employee has been declined by the Manager/Approver.
category`optional`	Object[]
description`optional`	String	Description of the category.
id`optional`	String	Id of the category.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
closedBidding`optional`	Boolean	Is the demand closed for bidding or not. Relevant only if the demand was published to ESM.
counter	Number	Counts the assigned demands of this demand.
date	Date	The date of the demand .
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`optional`	String	Day profile ID.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
isVariable	Boolean	True if day profile is variable.
startTime`optional`	Number	Normal time start of day profile.
department`optional`	Object[]
description`optional`	String	Description of the department.
id`optional`	String	Id of the department.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
description	String	Description of the demand.
foreColor	String	ForeGround color in HEX without #.
group`optional`	Object[]
description`optional`	String	Description of the group.
id`optional`	String	Id of the group.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
id	Number	The Id of the demand.
isPublished	Boolean	Is the demand published or not.
maximumBids`optional`	Object[]
amount`optional`	Number	Number of employees to bid in.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
name	String	The name of the demand .
normalTime`optional`	Object[]	Normal time interval for variable day profiles.
endTime`optional`	Number	End time of the interval in seconds.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
startTime`optional`	Number	Start time of the interval in seconds.
notes	Object[]
id	Number	Id of the note.
isEmpNote	Boolean	TRUE if the note is an employee note.
text	String	Note's text.
planId	Number	The Id of the plan.
qualificationSetup`optional`	Object[]
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
qualification`optional`	Object[]
description`optional`	String	Description of the qualification.
empQualId`optional`	String	Id of the employee qualification.
id`optional`	Number	Id of the demand qualification.
order`optional`	Number	Order of qualifications.
primary`optional`	Boolean	true = This is a primary qualification.
requiredEmployees	Object[]
amount	Number	Number of employees
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
version	Number	Version number of the demand.
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": {
            "demands": [
                {
                    "id": 2153908066,
                    "baseDemandId": 2134557518,
                    "planId": 2153557517,
                    "counter": 2,
                    "date": "2021-08-24",
                    "name": "Waiter, faress",
                    "description": "blah, blah, blah, blah, blah",
                    "foreColor": "000040",
                    "backColor": "000050",
                    "version": 1,
                    "isPublished": true,
                    "closedBidding": false,
                    "attendanceTime": [
                        {
                           "startTime": 0,
                           "endTime": 3600,
                           "isRequired": false,
                           "isLocked": true
                        }
                    ],
                    "dayProfile": [
                        {
                            "id": "DAY",
                            "startTime": 46800,
                            "endTime": 61200,
                            "description": "Day Shift 13:00 - 17:00",
                            "isVariable": false,
                            "foreColor": "000080",
                            "backColor": "00FF40",
                            "isRequired": false,
                            "isLocked": true
                        }
                    ],
                    "requiredEmployees": [
                        {
                            "amount": 5,
                            "isRequired": true,
                            "isLocked": true
                        }
                    ],
                    "department": [
                        {
                            "id": "0000007215",
                            "description": "SAP-HR-department 15",
                            "isRequired": false,
                            "isLocked": true
                        }
                    ],
                    "assignmentMethod": [
                        {
                            "isRequired": false,
                            "isLocked": false
                        }
                    ],
                    "group": [
                        {
                            "id": "1",
                            "description": "BH1",
                            "isRequired": false,
                            "isLocked": true
                        }
                    ],
                    "approvalGroup": [
                        {
                            "id": "01",
                            "description": "Kem Default",
                            "isRequired": true,
                            "isLocked": true
                        }
                    ],
                    "maximumBids": [
                        {
                            "amount": 10,
                            "isRequired": true,
                            "isLocked": true
                        }
                    ],
                    "category": [
                        {
                            "id": "02",
                            "description": "Part-day absence",
                            "isRequired": false,
                            "isLocked": true
                        }
                    ],
                    "ignoreDayProfile": [
                        {
                            "value": true,
                            "isLocked": true
                        }
                    ],
                    "acceptBefore": [
                        {
                            "days": 2,
                            "isRequired": false,
                            "isLocked": true
                        }
                    ],
                    "qualificationSetup": [
                        {
                            "isRequired": true,
                            "isLocked": true,
                            "qualifications": [
                                {
                                    "id": "1",
                                    "description": "Welding certificate f",
                                    "primary": true,
                                    "order": 1
                                },
                                {
                                    "id": "2",
                                    "description": "Truck certificate",
                                    "primary": true,
                                    "order": 2
                                }
                            ]
                        }
                    ],
                    "bids": [
                        {
                            "id": 2163180529,
                            "demandId": 2163182268,
                            "empId": "951",
                            "empName": "Joey Tribiani",
                            "comment": "Also available next week",
                            "status": 2,
                            "approverId": "CMD"
                        }
                    ],
                    "notes": [
                        {
                            "id": 2163396278,
                            "text": "bring coffee in the morning",
                            "isEmpNote": true
                        },
                        {
                            "id": 2163396279,
                            "text": "no breaks during this shift"
                        }
                    ]  
                }
            ]
        },
        "errorCode": 0,
        "errorMessage": ""
    }
}

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.