ProRoster - Get plan audit records

API Url

Use it to get plan audit records

GET

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{planId}/plan-audit

Permissions: user

Request headers

Field	Type	Description
Accept-Language`optional`	String	=en-GB Language use for localization.
X-Client`optional`	String	=Client type. Allowed values:`"Portal""Mobile""Admin"`
X-Role`optional`	Number	ProMark role (1: Employee, 2: User). Allowed values:`{12}`
X-WebPart-Id`optional`	Number	Unique web-part identifier.

Path parameters

Field	Type	Description
id	Number	The plan Id.

Query parameters

Field	Type	Description
from`optional`	Date	From requested date
to`optional`	Date	To requested date

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
forcedPublishes	Object[]	Collection of plan audit records.
date	Date	The date that the plan was published on.
id	Number	Object Id for .
name	String	First + last name of the person who published.
planDescription	String	Description of the plan
planId	Number	The Id of the plan.
publishedEmployeeInfo	Boolean	If True then the demands/absences were published.
publishedRoster	Boolean	If True then the ProRoster shifts were published.
publishedUntil	Date	The date that the plan is published until.
publishedVacantShifts	Boolean	If True then the vacant shifts were published.
userId	String	The Id of the user who published the plan.
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": {
         "forcedPublishes": [
             {
                 "id": 2163995151,
                 "userId": "FGN",
                 "planId": "2163995154",
                 "date": "2021-04-22",
                 "publishedUntil": "2021-04-22",
                 "planDescription": "plan 1",
                 "name": "Fares Nobani",
                 "publishedVacantShifts" : TRUE,
                 "publishedEmployeeInfo" : FALSE,
                 "publishedRoster" : 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.