ProRoster - Get all assigned demands in a plan.

API Url

Use it for returning the assigned demands in a plan.

GET

http://localhost:16010/ProMarkREST/rest/ProRoster/plans/{id}/assigned-demands

Permissions: user

Path parameters

Field	Type	Description
fields`optional`	String	List of fields with comma delimiter to include in the response.
from`optional`	Date	The start date of the period.
Number		id The id of the plan.
to`optional`	Date	The end date of the period.

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.
assignedDemands	Object[]
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.
backColor	String	BackGround color in HEX without #.
baseDemandId	Number	The Id of the base demand from which the demand was created.
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.
date	Date	The date of the assigned demand.
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.
demandId	Number	The Id of the plan demand the assigned demand originates from.
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.
description	String	Description of the demand.
empId	String	The Id of the employee assigned to a demand.
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.
id	Number	The unique id of the assigned demand.
isPublished	Boolean	False = the assigned demand is not published. True = the assigned demand is published.
isTask	Boolean	True if demand is task, false if not.
name	String	The name of the 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.
notes`optional`	Object[]
id`optional`	Number	Id of the note.
text`optional`	String	Message itself.
planId	Number	The Id of the plan.
version	Number	Version number of the assigned demand.
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": {
             "assignedDemands": [
                 {
                     "id": 2154019413,
                     "empId": "893",
                     "date": "2021-09-29",
                     "baseDemandId": 2163133262,
                     "demandId": 1234567890,
                     "planId": 2153977956,
                     "name": "BaseDemandDeTestBlah",
                     "description": "same",
                     "foreColor": "678DB6",
                     "backColor": "678DB6",
                     "version": 1,
                     "isPublished": false,
                     "normalTime": [
                         {
                             "isRequired": false,
                             "isLocked": false
                         }
                     ],
                     "dayProfile": [
                         {
                             "startTime": 0,
                             "endTime": 0,
                             "description": "",
                             "isVariable": false,
                             "foreColor": "",
                             "backColor": "",
                             "isRequired": false,
                             "isLocked": false
                         }
                     ],
                     "department": [
                         {
                             "description": "",
                             "isRequired": false,
                             "isLocked": false
                         }
                     ],
                     "group": [
                         {
                             "description": "",
                             "isRequired": false,
                             "isLocked": false
                         }
                     ],
                     "approvalGroup": [
                         {
                             "description": "",
                             "isRequired": false,
                             "isLocked": false
                         }
                     ],
                     "category": [
                         {
                             "description": "",
                             "isRequired": false,
                             "isLocked": false
                         }
                     ],
                     "ignoreDayProfile": [
                       {
                           "value": true,
                           "isLocked": true
                       }
                    ]            
                 }
             ]
         },
         "errorCode": 0,
         "errorMessage": ""
     }
 }

Error 4xx

Field	Type	Description
response	Object	Main object containing the response data.
errorCode	Number	Error code.
errorMessage	String	Error description.