ProRoster - Get base demands

API Url

Use it for loading the list of all base demands .

GET

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

Permissions: user

Query parameters

Field	Type	Description
fields`optional`	String	List of fields with comma delimiter to include in the response. Example to get only 2 attributes fields=dayProfile,normalTime.
showInactive`optional`	Boolean	Show inactive base demands
visibility`optional`	String	"P" = show only private , "G" = show only Global , "" = show all.

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.
baseDemands	Object[]	List of Base 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	Is the attribute required.
startTime`optional`	Number	Start time of the interval in seconds.
backColor	String	BackGround color in HEX without #.
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.
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.
isStrict	Boolean	True = you cannot assign the demand unless the employee has the same department.
description	String	Description of the base demand.
favorite	Boolean	True if base demans is favorite.
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.
isStrict	Boolean	True = you cannot assign the demand unless the employee has the same group.
id	Number	The Id of the base demand.
inactive	Boolean	True if the base demand is inavtive.
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 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.
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.
userProfiles	String[50]	Restriction on user profiles for the demand
users	String[50]	Restriction on users for the demand
version	Number	Version number of the base demand.
visibility	String	If the plan is global or private.
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": {
            "baseDemand": [
               {
                  "id": 2153900338,
                  "name": "Waiter, razvan132",
                  "inactive": false,
                  "favorite": true,
                  "visibility": "P",
                  "description": "blah, blah, blah, blah, blah",
                  "foreColor": "123400",
                  "backColor": "567800",
                  "version": 1,
                  "userProfiles":["PROF","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""],
                  "users":["","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","","",""],
                  "normalTime": [
                     {
                        "startTime": 0,
                        "endTime": 3600,
                        "isRequired": false,
                        "isLocked": true
                     }
                  ],
                  "attendanceTime": [
                     {
                        "startTime": 0,
                        "endTime": 3800,
                        "isRequired": false,
                        "isLocked": true
                     }
                  ],
                  "dayProfile": [
                     {
                        "id": "DAY",
                        "startTime": 46800,
                        "endTime": 61200,
                        "description": "Day Shift 13:00 - 17:00",
                        "isVariable" : true,
                        "foreColor": "000080",
                        "backColor": "00FF40",
                        "isRequired": false,
                        "isLocked": true
                     }
                  ], 
                  "requiredEmployees": [
                     {
                        "amount": 3,
                        "isRequired": false,
                        "isLocked": true
                     }
                  ],
                  "department": [
                     {
                        "id": "0000007215",
                        "description": "SAP-HR-department 15",
                        "isRequired": false,
                        "isLocked": true,
                        "isStrict": true
                     }
                  ],
                  "assignmentMethod": [
                     {
                     "method": "A",
                     "isRequired": false,
                     "isLocked": true
                     }
                  ],
                 "group": [
                    {
                       "id": "1",
                       "description": "BH1",
                       "isRequired": false,
                       "isLocked": true,
                       "isStrict": true
                    }
                 ],
                 "approvalGroup": [
                    {
                       "id": "01",
                       "description": "Kem Default",
                       "isRequired": true,
                       "isLocked": true
                    }
                 ],
                "maximumBids": [
                   {
                      "amount": 9,
                      "isRequired": false,
                      "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,
                   "qualification": [
                       {
                           "QualificationsRecId": 182528,
                           "description": "Line operator",
                           "primary": true,
                           "order": 1
                       }
                   ]
                }
                ]
             }
          ]
       },
       "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.