ProRoster - Update planning settings

API Url

Use it for updating planning settings for the current user.

PUT

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

Permissions: user

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
properties	Object	List of planning settings.
displayAttPlan	Boolean
displayInfoDayOff	Boolean
displayLineOne	Number
displayLineTwo	Number
displayShiftLineOne	Number
displayShiftLineTwo	Number
editOnAssignDemand	Boolean	True = Edit the demand before manning it.
editOnCreateDemand	Boolean	True = Edit the demand before saving it.
employeeAccounts	String
employeeInfo	String
showEmpAvailability	Boolean

Request example:

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

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.
errorCode	Number	Error code.
errorMessage	String	Error description.