GetBasicNewStarterTemplate


Description:

Generates sample request for post basic new starter details API for given Company and EmployeeId that the requester is authorized to view.


Request:

https://dev02-api-gateway.moorepay.co.uk/workers/v1/Worker/GetBasicNewStarterTemplate/{companyId}[?employeeId][&hrEmployeeId]


Request headers:

Name

Required

Type

Description

Authorization

Yes

string

access token


Request parameters:

Name

In

Required

Type

Description

companyId

template

true

string

 string[2]

employeeId

query

false

string

 string[6]

hrEmployeeId

query

false

string

HR Employee Id


Response example:


Response: 200 OK

{

  "payrollCompanyCode": "string",

  "idNumber": "string",

  "hrEmployeeId": "string",

  "title": "string",

  "surname": "string",

  "firstForename": "string",

  "addressLine1": "string",

  "addressLine2": "string",

  "country": "string",

  "dateOfBirth": "string",

  "startDate": "string",

  "maritalStatus": "string",

  "gender": "string",

  "annualSalary": 0,

  "personalMobileNumber": "string",

  "personalEmailAddress": "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: Create cross-platform Qt Help files