SelfService - Request new absence
API Url
Used in Self-service for requesting a new absence.
http://localhost:16010/ProMarkREST/rest/SelfService/absences
Permissions: user
Parameter
| Field | Type | Description |
|---|---|---|
| request | Object | Main object containing the request data. |
| data | Object | Object containg data to be uploaded. |
| absences | Object[] | Object containing the absence requests. |
acceptBeforeoptional | Date | Date until you want the request to be accepted. |
| attendanceDate | Date | Shift attendance date. |
commentoptional | String | Comment on the absence request. |
contactoptional | String | Contact person. |
| dayProfileId | String | The day profile ID of the shift. |
| empId | String | The employee ID. Owner of the shift. |
| reasons | Object[] | The absence reasons. |
| code | String | The absence reason code. |
hoursoptional | Number | The absence time expressed in seconds. It's not needed if reason code is set-up as being percent of normal time. |
| type | Number | Absence type (1: All-day, 2: Anytime, 3: Before Clock-in, 4: After Clock-out, 5: All-shift). 1-5 |
Request example:
{"request": {"data": {"absences": [{"empId": "414","attendanceDate": "2017-06-07","dayProfileId": "SH1","acceptBefore": "2017-06-06","comment": "Doctor appointment in the morning","reasons": [{"type": 3,"code": "DR","hours": 7200}]}]}}}
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| statusCode | Number | Status code of the request (0: Vacant shift, 1: Waiting for manager, 2: Wating for employee, 3: Approved by employee, waiting for manager/approver, 4: Approved by employee, waiting for 2nd manager/approver, 5: Rejected by employee, 6: Rejected by manager/approver, 7: Approved by manager/approver, 8: Approved, 99: Request was deleted). 0-99 |
| statusMessage | String | Status message of the request. |
messageoptional | Object | Object containing response messages. |
| code | Number | Message code. |
| text | String | Message text. |
| type | String | Type of message. "warning""info" |
Success example:
HTTP/1.1 200 OK{"response": {"data": {"statusCode": 1,"statusMessage": "Absence request sent. Waiting for manager approval."},"errorCode": 0"errorMessage": ""}}
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:
HTTP/1.1 200 OK{"response": {"data": {},"errorCode": 10"errorMessage": "An open self service request already exists for employee John Doe"}}