ProRoster - Create demand

API Url

Use it for creating a demand and copying a demand to a different date. If a base demand id is provided the demand is created based on a basedemand . If the plan demand id is provided the it is a copy to a different date.

POST

http://localhost:16010/ProMarkREST/rest/ProRoster/demands

Permissions: user

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
demands	Object[]	List of plan Demands.
approvalGroup`optional`	Object[]
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	Is the attribute required.
startTime`optional`	Number	Start time of the interval in seconds.
backColor`optional`	String	BackGround color in HEX without #.
baseDemandId`optional`	Number	Id of the base demand incase the demand is based on a basedemand to link it.
category`optional`	Object[]
id	String	Id of the category.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
date	Date	The date of the plan demand.
dayProfile`optional`	Object[]
id`optional`	String
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
daysBefore`optional`	Object[]
days`optional`	Number	Accept days before shift takes place.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
department`optional`	Object[]
id`optional`	String	Id of the department.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
description`optional`	String	Description of the base demand.
foreColor`optional`	String	ForeGround color in HEX without #.
group`optional`	Object[]
id`optional`	String	Id of the group.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
id`optional`	Number	The Id of the plan demand to copy from.
ignoreDayProfile`optional`	Object[]
isLocked	Boolean	Is the attribute locked.
value	Boolean
maximumBids`optional`	Object[]
amount	Number	Number of employees to bid in.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
name`optional`	String	The name of the plan demand.
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.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
planId	Number	Id of the plan currently working on.
qualificationSetup`optional`	Object[]
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
qualifications`optional`	Object[]
id	Number	Id of the employee qualification.
order	Number
primary	Boolean
requiredEmployees	Object[]
amount	Number	Number of employees
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
version`optional`	Number	Version of the plan demand.

Request example:

HTTP/1.1 200 OK
   {
      "request": {
         "data": {
            "demands": [
               {
                  "id": 2153900338,
                  "planId": 2153900339,
                  "baseDemandId": 2153905338,
                  "date": "18-02-2018",
                  "name": "Bla",
                  "description": "blah, blah, blah, blah, blah",
                  "foreColor": "123400",
                  "backColor": "567800",
                  "version": 1,
                  "attendanceTime": [
                     {
                        "startTime": 0,
                        "endTime": 3600,
                        "isRequired": false,
                        "isLocked": true
                     }
                  ],
                  "normalTimeInterval": [
                     {
                        "startTime": 0,
                        "endTime": 3600,
                        "isRequired": false,
                        "isLocked": true
                     }
                  ],
                  "dayProfile": [
                     {
                        "id": "DAY",
                        "isRequired": false,
                        "isLocked": true
                     }
                  ], 
                  "requiredEmployees": [
                     {
                        "amount": 3,
                        "isRequired": false,
                        "isLocked": true
                     }
                  ],
                  "department": [
                     {
                        "id": "0000007215",
                        "isRequired": false,
                        "isLocked": true
                     }
                  ],
                  "assignmentMethod": [
                     {
                     "method": "A",
                     "isRequired": false,
                     "isLocked": true
                     }
                  ],
                 "group": [
                    {
                       "id": "1",
                       "isRequired": false,
                       "isLocked": true
                    }
                 ],
                 "approvalGroup": [
                    {
                       "id": "01",
                       "isRequired": true,
                       "isLocked": true
                    }
                 ],
                "maximumBids": [
                   {
                      "amount": 9,
                      "isRequired": false,
                      "isLocked": true
                   }
                ],
                "category": [
                   {
                      "id": "02",
                      "isRequired": false,
                      "isLocked": true
                   }
                ],
                 "ignoreDayProfile": [
                   {
                       "value": true,
                       "isLocked": true
                   }
                ],
                "daysBefore": [
                   {
                      "days": 2,
                      "isRequired": false,
                      "isLocked": true
                   }
                ],
                "qualifications": [
                   {
                      "id": 2153900339,
                      "empQualId": "3",
                      "primary": true,
                      "order": 1,
                      "isRequired": true,
                      "isLocked": true
                   }
                ],
                "notes": [
                   {
                      "id": 2163396278,
                      "text": "bring coffee in the morning",
                      "isEmpNote": true
                   },
                   {
                      "id": 2163396279,
                      "text": "no breaks during this shift"
                   }
                ]
             }
          ]
       }
   }   
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
notes	Object[]
id	Number	Id of the note.
isEmpNote	Boolean	TRUE if the note is an employee note.
text	String	Note's text.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

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.