GetEmployeesAllData
GetEmployeesAllData
Description:
Fetches all employee complete details for given company that the requester is authorized to view and if, showInActive is passed as true then also gets employee with status Leaver else skip those employee records.
Request:
https://dev02-api-gateway.moorepay.co.uk/workers/v1/Worker/GetEmployeesAllData/{companyId}?showInActive={showInActive}
Request headers:
|
Name |
Required |
Type |
Description |
|
Authorization |
Yes |
string |
access token |
Request parameters:
|
Name |
In |
Required |
Type |
Description |
|
companyId |
template |
true |
string |
string[2] |
|
showInActive |
template |
true |
boolean |
Only true or false can be passed |
Response example:
Response: 200 OK
{
"payrollCompanyCode": "string",
"idNumber": "string",
"hrEmployeeId": "string",
"title": "string",
"surname": "string",
"firstForename": "string",
"secondForename": "string",
"addressLine1": "string",
"addressLine2": "string",
"addressLine3": "string",
"addressLine4": "string",
"postCode": "string",
"country": "string",
"dateOfBirth": "string",
"niNumber": "string",
"payType": "string",
"bankAccountNum": "string",
"sortCode": "string",
"bacsACName": "string",
"buildingSocRollNo": "string",
"bankAccountNo2": "string",
"sortCode2": "string",
"bacsACName2": "string",
"buildingSocRollNo2": "string",
"positionID": "string",
"grade": "string",
"payslipPostOption": "string",
"partFull": "string",
"costCentre": "string",
"department": "string",
"occupationCode": 0.0,
"payPoint": "string",
"refField1": "string",
"refField2": "string",
"empActualWrkngPattern": "string",
"sspDaysPerWeek": 0.0,
"startDate": "string",
"basicHours": 0.0,
"contractDays": 0.0,
"workPhoneNo": "string",
"extension": "string",
"workMobilePhone": "string",
"homePhoneNumber": "string",
"personalMobileNumber": "string",
"personalMobileNumber2": "string",
"otherContactNumber": "string",
"personalEmailAddress": "string",
"businessEmailAddress": "string",
"maritalStatus": "string",
"gender": "string",
"leaveDate": "string",
"leaveReasonCode": 0.0,
"employeeStatus": "string",
}
Response: 400 Bad Request
Bad Request
Response: 401 Unauthorized
Unauthorized
Response: 404 Not Found
Not Found
Response: 405 Method Not Allowed
Method Not Allowed
Response: 500 Internal Server Error
Internal Server Error
Created with the Personal Edition of HelpNDoc: Easily convert your WinHelp HLP help files to CHM with HelpNDoc's step-by-step guide