Celebrations - Get celebrations

API Url

Get celebrations

GET
http://localhost:16010/ProMarkREST/web/General/celebrations

Permissions: user

Query parameters

FieldTypeDescription
typeoptionalString

Type of celebration type=seniority type=birthday

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    employeesString[]

A list of employees that celebrate upcoming birthdays or employment dates

  messageoptionalObject

Object containing response messages.

    codeNumber

Message code.

    textString

Message text.

    typeString

Type of message.

Allowed values:"warning""info"

Success example:

HTTP/1.1 200 OK
{
"response": {
"data": {
"employees": [
{
"avatarURI": ,
"empNo": ,
"empId": ,
"fisrtName":,
"surName":,
"initials":,
"dateOfBirth":,
"dateOfEmployment":
}
]
}
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.