ProRoster - Get planning properties

API Url

Use it for loading planning settings for the logged in user.

GET

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

Permissions: user

Success 200

Field	Type	Description
displayAttPlan	Boolean
displayInfoDayOff	Boolean
displayLineOne	Number	Default 0 if not sent.
displayLineTwo	Number	Default 2 if not sent.
displayShiftLineOne	Number	Default 0 if not sent.
displayShiftLineTwo	Number	Default 0 if not sent.
employeeAccounts	String
employeeInfo	String
showEmpAvailability	Boolean
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
properties	Object	List of planning settings.
editOnAssignDemand	Boolean	True = Edit the demand before manning it.
editOnCreateDemand	Boolean	True = Edit the demand before saving it.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Request example:

{
   "response": {
      "data": {
         "properties": [
            {
               "editOnCreateDemand": false,
               "editOnAssignDemand": false,
               "displayLineOne": 0,
               "displayLineTwo": 2,
               "displayShiftLineOne": 0,
               "displayShiftLineTwo": 0,
               "employeeInfo": "",
               "employeeAccounts: "",
               "displayAttPlan" : true,
               "displayInfoDayOff" : true,
               "showEmpAvailability" : false
            }
         ]
      }
   }   
}

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.