ProRoster - Manage company absences

API Url

Used for suppressing and unsuppressing a company absence

PUT

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{planId}/company-absences

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
planId	Number	Plan id.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
companyAbsences	Object[]
backColor	String	Background color
code	String	Absence code
date	Date	Absence date
description	String	Absence description
empId	String	Employee Id
foreColor	String	Foreground color
isDeleted	Boolean	TRUE if the change is deleted
isHolidayWithWork	Boolean	TRUE if the absenc is Holiday with work
isPublished	Boolean	TRUE if the absence is published
isSuppressed	Boolean	TRUE if the absence will be suppressed FALSE if the absence will be unsuppressed
shortDescription	String	Absence short description

Request example:

{
    "request": {
        "data": {
            "companyAbsences": [
                {
                    "empId": "4695",
                    "date": "2023-10-27",
                    "code": "A",
                    "description": "A-Bank Holidays",
                    "shortDescription": "Bank Hol.",
                    "backColor": "B7FFB7",
                    "foreColor": "008000",
                    "isCompanyAbs": true,
                    "isPublished": true,
                    "isDeleted": false,
                    "isSuppressed": false,
                    "isHolidayWithWork": true
                    
                }
            ]
        }
    }
}

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.
data	Object	Object containing the requested data (empty).
errorCode	Number	Error code.
errorMessage	String	Error description.