General - Get all employees

API Url

Used to get all employees.

GET

http://localhost:16010/ProMarkREST/web/General/employees

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.

Query parameters

Field	Type	Description
absenceType`optional`	String	Absence type (1: All-day, 2: Anytime, 3: Before Clock-in, 4: After Clock-out, 5: All-shift). Only if expand='absences'.
empId`optional`	String	Comma separated list of employee IDs.
expand`optional`	String	Expand employee info. Allowed values:`"status""jobStatus""absences"`
fields`optional`	String	Comma delimited list of fields to get.
filter`optional`	String	JSON containing filter fields, their values and conditions.
from`optional`	Date	Start date for absences, Default: TODAY.
noSchema`optional`	Boolean	true = The schema property/object will not be returned. Default is false.
skip`optional`	Number	Number of records to skip. Used for pagination.
sortBy`optional`	String	String with fields to sort on (descending,ascending), where a descending sort is prefixed by minus: -
statusType`optional`	Number[1-6]	Attendance Type 1: All employees 2: Employees that has clocked in 3: Employees that hasn't clocked in but should have 4: Employees that hasn't clocked in 5: Employees that are absent 6: Registration missing.
take`optional`	Number	Number of records to get. Used for pagination.
to`optional`	Date	End date for absences, Default : TODAY.

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
data	Object	Object containing the requested data.
employees	Object[]	Collection with employee data.
absences`optional`	Object[]	Collection of absence intervals.
approvalStatus`optional`	Number	Approval status of the registration (0: No approval needed, 1: Pending approval, 2: Approved, 3: Rejected).
attendanceDate	Date	Attendance date of absence.
backColor`optional`	String	The reason background color.
code	String	The reason code (identifier).
description	String	The reason description.
empId	String	The employee ID.
endTime`optional`	Number	End time of interval for category setup.
foreColor`optional`	String	The reason foreground color.
hours`optional`	Number	The absence time expressed in seconds. It's not needed if reason code is set-up as being percent of normal time or star-end setup.
id	String	Unique identifier for the absence object.
startTime`optional`	Number	Start time of interval for category setup.
type	Number	Absence type (1: All-day, 2: Anytime, 3: Before Clock-in, 4: After Clock-out, 5: All-shift). Size range: `1-5`
address1`optional`	String	Address1
address2`optional`	String	Address2
address3`optional`	String	Address3
approvalDesc`optional`	String	Approval group description.
approvalId`optional`	String	Approval group identifier.
attendanceProfileDesc`optional`	String	Attendance profile description.
attendanceProfileId`optional`	String	Attendance profile identifier.
avatarURI	String	Employee avatar.
cardNo`optional`	String	Card number.
categoryDesc`optional`	String	Category description.
categoryId`optional`	String	Category identifier.
city`optional`	String	City
countryCode`optional`	String	Country Code
dateOfBirth	Date	Employee birthday.
dateOfEmp	Date	Date of employment.
deptDesc`optional`	String	Employee actual department description.
deptId`optional`	String	Employee actual department Id.
divisionDesc`optional`	String	Division description.
divisionId`optional`	String	Division identifier.
email`optional`	String	Email address.
email2`optional`	String	Email address 2
empId	String	Employee Id.
empNo	String	Employee number.
firstName	String	Employee first name.
firstReg`optional`	date	First registration date
gender`optional`	String	Gender
groupDesc`optional`	String	Employee actual group description.
groupId`optional`	String	Employee actual group id.
homeDeptDesc`optional`	String	Employee home department description.
homeDeptId`optional`	String	Employee home department Id.
homeGroupDesc`optional`	String	Employee home group description.
homeGroupId`optional`	String	Employee home group id.
homePhone`optional`	String	Home Phone.
info1`optional`	String	Employee note1
info2`optional`	String	Employee note2
info3`optional`	String	Employee note3
info4`optional`	String	Employee note4
info5`optional`	String	Employee note5
initials	String	Employee initials.
jobDescription`optional`	String	Job description.
jobStatus`optional`	Object[]	Job related status.
operationDesc	String	Operation description.
operationId	String	Operation Id.
orderDesc	String	Order description.
orderId	String	Order Id.
managerId`optional`	String	Manager id
managerName`optional`	String	Manager name
mobilePhone	String	Employee phone number.
payrollDesc`optional`	String	Payroll profile description.
payrollId`optional`	String	Payroll profile identifier.
periodProfileDesc`optional`	String	Period profile description.
periodProfileId`optional`	String	Period profile identifier.
postalCode`optional`	String	Postal code
province`optional`	String	Province
sortNo	String	Sort number.
status	Number[0-11]	Employee status (0: Clock-in, 1: Clock-in late, 2: Clock-in early, 3:Clock-out early, 4: Missing clock-in, 5: Absent, 6: Non-scheduled day, 7: Clock-out early with absence, 8: Clock-in late with absence, 9: Not present, 10: Implicit clock-in, 11: Implicit clock-out).
statusInfo	String	Employee status info.
statusText	String	Employee status description.
surname	String	Employee last name.
workPhone`optional`	String	work Phone.
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example without expand:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "employees": [
           {
              "empNo": "1",
              "sortNo": "!!!!!!!!!1", 
              "firstName": "John test",
              "surname": "Doex Test",
              "initials": "DT",
              "deptId": "01",
              "deptDesc": "KEM ~\"Default~\"",
              "groupId": "BH3",
              "groupDesc": "3, Haslund Group 3",
              "mobile": "99999",
              "dateOfBirth": "1955-02-28",
              "dateOfEmployment": "2006-10-01",
              "email": "test@mark-info.com",
              "avatarURI": "/rest/Resources/employees/414/avatar?eTag=721567206000"
           }
         ]
      },
      "erorCode": 0,
      "errorMessage": ""
   }
}

Success example with expand=status,jobStatus,absences,schema:

HTTP/1.1 200 OK 
{
   "response": {
      "data": {
         "employees": [
          {
              "empNo": "1",
              "empId": "85",
              "sortNo": "!!!!!!!!!1",
              "firstName": "John test",
              "surname": "Doex Test",
              "initials": "DT",
              "deptId": "SBI",
              "deptDesc": "Department, Hudson Bay",
              "groupId": "BH3",
              "groupDesc": "3, Haslund Group 3",
              "mobilePhone": "99999",
              "dateOfBirth": "1955-02-28",
              "dateOfEmp": "2006-10-01",
              "emailAddr": "test@mark-info.com",
              "status": 0,
              "statusInfo": "27/02/2012 12:28",
              "statusText": "Present",
              "jobDescription": "bbbb",
              "jobStatus": [
                  {
                      "orderId": "010101",
                      "orderDesc": "Main order 1",
                      "operationId": "OOO1",
                      "operationDesc": "Painting"
                  }
              ],
              "absences": [
                  {
                      "id": "2153931200~\u00011~\u00010",
                      "attendanceDate": "2018-03-07",
                      "type": 1,
                      "code": "02",
                      "description": "Reason-02",
                      "backColor": "808000",
                      "foreColor": "FFFF00",
                      "hours": 28800,
                      "startTime": 28800,
                      "endTime": 57600
                  },
                  {
                      "id": "2153938630~\u00013~\u00010",
                      "attendanceDate": "2018-03-09",
                      "type": 3,
                      "code": "HVBS",
                      "description": "Sickness",
                      "backColor": "FF0000",
                      "foreColor": "FFFF00",
                      "hours": 7200
                  }
              ]
          },
          {
              "empNo": "3",
              "empId": "89",
              "sortNo": "!!!!!!!!!3",
              "firstName": "3",
              "surname": "3",
              "initials": "BHH",
              "deptId": "BH",
              "deptDesc": "Bo Haslund",
              "groupId": "BH1",
              "groupDesc": "1, Haslund Group 1",
              "mobilePhone": "004577628898",
              "dateOfBirth": "2006-07-01",
              "dateOfEmp": "2006-06-02",
              "emailAddr": "",
              "status": 5,
              "statusInfo": "Doctor appointment",
              "statusText": "Absent",
              "avatarURI": "/rest/Resources/employees/414/avatar?eTag=721567206000"
          }
         ],
         "schema": {
          "objectName": "employees",
          "id": "empId",
          "text": "firstName surname",
          "fields": {
              "empNo": {
                  "type": "string",
                  "title": "No."
              },
              "empId": {
                  "type": "string",
                  "title": "ID"
              },
              "firstName": {
                  "type": "string",
                  "title": "First name"
              },
              "surname": {
                  "type": "string",
                  "title": "Surname"
              },
              "initials": {
                  "type": "string",
                  "title": "Initials"
              }
          }
      }
      },
      "erorCode": 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 404 Not found
{
   "response": {
      "errorCode": 5,
      "errorMessage": "No employees"
   }
}