ProRoster - Proschedule export plan

API Url

Use it to export ProRoster/Proschedule plan

GET

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{id}/export

Permissions: user

Path parameters

Field	Type	Description
id	Number	The plan unique identifier.

Query parameters

Field	Type	Description
dateFormat`optional`	Number	Date Format, possible values are 0 = "DMY":U / default 1 = "MDY":U 2 = "YMD":U Allowed values:`123`
dayCellInfo`optional`	String	Day cell information, Possible values: 0: 1: Absence / default if includeAbsences = TRUE 2: Day Profile 3: Shift 4: Home Department 5: Home Group 6: Attendance Profile 7: Attendance Time (calculated) 8: Cost (calculated) 9: Attendance Time Interval 10: Normal Time Interval / default if includeAbsences = FALSE 11: Hours per day. 12: Current Department 13: Current group. 14: Plan demand.
decimalPoint`optional`	Number	Decimal point separator, possible values are 0 = European / default 1 = American Allowed values:`01`
exportLike	Number	export like Possible values are: 0: ID / default 1: Short Description 2: Description 3: ID:Short Description 4: ID:Description Allowed values:`01234`
exportType`optional`	Number	Export type, possible values are: 0: Both (Assigned and unassigned plans) 1: UnAssigned only 2: Assigned only (default) Allowed values:`012`
filterId	Number	Filter identifier.
from	Date	From date
groupBy`optional`	Number	Group export by, Possible values are: 0: No Selection / default 4: department id 5: Employee group id 6: attendance profile id 12: current department Id 13: current employee group id Allowed values:`04561213`
includeAbsences`optional`	Boolean	TRUE = include absences in export. Default: FALSE
listSeparator`optional`	Number	List Separator, possible values are: 0 = ";":U / default 1 = ",":U, 2 = "~t":U Allowed values:`012`
to	Date	To date

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.

Error example:

{
   "response":
   {
      "errorCode":81,
      "errorMessage":"** Day in month is invalid. (81)"
   }
}