GET api/employer

Get all Employers.

Requires Authorisation

The api request must supply authenticated token in a custom variable in the request header. The custom variable name is configured in web.config. The default name of the custom variable is “X-Fern-Token”.

Requires Api License and User Access

The api requires license and user permission for API ID, GETapi/employer. The user permission can be defined on User Settings screen in Abacus. For license, please contact Fern manager.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Response Codes

Success Status:

OK (200), please see resource description below.

Failed Status(es):

Resource Description

Returns an array of all employees.

Collection of EmployerDto

Name	Description	Type	Additional information
EmployerID	Unique Identifier of Employer.	integer
CompanyName	Name of the Company.	string	Required
ContactName	Contact Name for the Employer.	string
PhoneNumber	Contact Number for the Employer.	string
RegNumber	Unique registration number of the company.	string
NumberOfEmployees	Number of Employees.	integer
MainOfficeID	Employer reference to the main office (if this is a branch office of another employer).	integer
MailOfficeID	Mail address of the Office.	integer

Response Formats

application/json, text/json

Sample:

[
  {
    "employerID": 1,
    "companyName": "sample string 1",
    "contactName": "sample string 2",
    "phoneNumber": "sample string 3",
    "regNumber": "sample string 4",
    "numberOfEmployees": 1,
    "mainOfficeID": 1,
    "mailOfficeID": 1
  },
  {
    "employerID": 1,
    "companyName": "sample string 1",
    "contactName": "sample string 2",
    "phoneNumber": "sample string 3",
    "regNumber": "sample string 4",
    "numberOfEmployees": 1,
    "mainOfficeID": 1,
    "mailOfficeID": 1
  }
]

application/xml, text/xml

Sample:

<ArrayOfEmployerDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Fern.Abacus.ObjectModel.Dto">
  <EmployerDto>
    <CompanyName>sample string 1</CompanyName>
    <ContactName>sample string 2</ContactName>
    <EmployerID>1</EmployerID>
    <MailOfficeID>1</MailOfficeID>
    <MainOfficeID>1</MainOfficeID>
    <NumberOfEmployees>1</NumberOfEmployees>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RegNumber>sample string 4</RegNumber>
  </EmployerDto>
  <EmployerDto>
    <CompanyName>sample string 1</CompanyName>
    <ContactName>sample string 2</ContactName>
    <EmployerID>1</EmployerID>
    <MailOfficeID>1</MailOfficeID>
    <MainOfficeID>1</MainOfficeID>
    <NumberOfEmployees>1</NumberOfEmployees>
    <PhoneNumber>sample string 3</PhoneNumber>
    <RegNumber>sample string 4</RegNumber>
  </EmployerDto>
</ArrayOfEmployerDto>