ProRoster - Create base demand

API Url

Use it for creating a base demand.

POST

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

Permissions: user

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
baseDemands	Object[]	List of Base 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 #.
category`optional`	Object[]
id	String	Id of the category.
isLocked	Boolean	Is the attribute locked.
isRequired	Boolean	Is the attribute required.
dayProfile`optional`	Object[]	Day profile for the base demand.
id`optional`	String	Day profile ID.
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.
isStrict	Boolean	True = you cannot assign the demand unless the employee has the same department.
description`optional`	String	Description of the base demand.
favorite`optional`	Boolean	True if base demand is favorite.
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.
isStrict	Boolean	True = you cannot assign the demand unless the employee has the same group.
ignoreDayProfile`optional`	Object[]
isLocked	Boolean	Is the attribute locked.
value	Boolean
inactive`optional`	Boolean	True if the base demand is inactive.
maximumBids`optional`	Object[]
amount	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 base 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.
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	Order of qualification.
primary	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.
userProfiles	String[50]	Restriction on user profiles for the demand
users	String[50]	Restriction on users for the demand
visibility	String	If the plan is global ("G") or private ("P"). Allowed values:`"P""G"`

Request example:

{
      "request": {
         "data": {
            "baseDemand": [
               {
                  "name": "Waiter, razvan132",
                  "inactive": false,
                  "favorite": true,
                  "visibility": "P",
                  "description": "blah, blah, blah, blah, blah",
                  "foreColor": "123400",
                  "backColor": "567800",
                  "userProfiles":["PROF","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""],
                  "users":["","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""],                          
                  "attendanceTime": [
                     {
                        "startTime": 0,
                        "endTime": 3600,
                        "isRequired": false,
                        "isLocked": true
                     }
                  ],
                  "normalTime": [
                     {
                        "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,
                        "isStrict": false
                     }
                  ],
                  "assignmentMethod": [
                     {
                     "method": "A",
                     "isRequired": false,
                     "isLocked": true
                     }
                  ],
                 "group": [
                    {
                       "id": "1",
                       "isRequired": false,
                       "isLocked": true,
                       "isStrict": 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
                   }
                ]
             }
          ]
       }
   }   
}

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
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.