General - Get attendance profile for an employee

API Url

Used for loading attendance profile for an employee in a specific date.

GET
http://localhost:16010/ProMarkREST/rest/General/employees/{empId}/attendance-profiles

Permissions: user

Request headers

FieldTypeDescription
Accept-LanguageoptionalString

=en-GB Language use for localization.

X-ClientoptionalString

=Client type.

Allowed values:"Portal""Mobile""Admin"
X-RoleoptionalNumber

ProMark role (1: Employee, 2: User).

Allowed values:{12}
X-WebPart-IdoptionalNumber

Unique web-part identifier.

Query parameters

FieldTypeDescription
dateoptionalDate

The date for which the attendance profile is retrieved (default is today).

Success 200

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data.

    attendanceProfilesObject[]

Collection of attendance profiles.

      dateDate

Attendance profile date.

      descriptionString

Attendance profile description.

      empIdString

Employee ID.

      empNoString

Employee No.

      idString

Attendance profile Id.

  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": {
"attendanceProfiles": [
{
"empId": "1083",
"id": "HLCMD",
"description": "HLC Midday shift",
"date": "2019-07-24"
}
]
},
"errorCode": 0,
"errorMessage": ""
}
}

Error 4xx

FieldTypeDescription
responseObject

Main object containing the response data.

  dataObject

Object containing the requested data (empty).

  errorCodeNumber

Error code.

  errorMessageString

Error description.