Celebrations - Get celebrations
API Url
Get celebrations
GET
http://localhost:16010/ProMarkREST/web/General/celebrations
Permissions: user
Query parameters
| Field | Type | Description |
|---|---|---|
typeoptional | String | Type of celebration type=seniority type=birthday |
Success 200
| Field | Type | Description |
|---|---|---|
| response | Object | Main object containing the response data. |
| data | Object | Object containing the requested data. |
| employees | String[] | A list of employees that celebrate upcoming birthdays or employment dates |
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": {"employees": [{"avatarURI": ,"empNo": ,"empId": ,"fisrtName":,"surName":,"initials":,"dateOfBirth":,"dateOfEmployment":}]}}}
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. |