GET Api/Employees

Retrieves a list of all active employees within the current business.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

A list of employees.

Collection of ChappReport.Site.Areas.Api.Models.V1.EmployeeV1Model

Name	Description	Type	Additional information
Id	The id of the employee	integer	None.
Firstname	The first name of the employee.	string	None.
Lastname	The last name of the employee.	string	None.
Executor	Indicates whether the employee is marked as being an executor.	boolean	None.
Manager		boolean	None.
Operator	Indicates whether the employee is marked as being an operator.	boolean	None.
Email	The email of the employee.	string	None.
Token	The client login token (if generated).	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "Firstname": "Felix",
    "Lastname": "Smith",
    "Executor": true,
    "Manager": false,
    "Operator": true,
    "Email": "felix.smith@chapps.com"
  },
  {
    "Id": 2,
    "Firstname": "Samantha",
    "Lastname": "Boucique",
    "Executor": true,
    "Manager": false,
    "Operator": false,
    "Email": "Samantha.Boucique@chapps.com",
    "Token": "80e3caf5-f1c4-4e4c-ae6a-7b534af70057"
  }
]

application/xml, text/xml

Sample:

<ArrayOfEmployeeV1Model xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ChappReport.Site.Areas.Api.Models.V1">
  <EmployeeV1Model>
    <Email>felix.smith@chapps.com</Email>
    <Executor>true</Executor>
    <Firstname>Felix</Firstname>
    <Id>1</Id>
    <Lastname>Smith</Lastname>
    <Manager>false</Manager>
    <Operator>true</Operator>
    <Token i:nil="true" />
  </EmployeeV1Model>
  <EmployeeV1Model>
    <Email>Samantha.Boucique@chapps.com</Email>
    <Executor>true</Executor>
    <Firstname>Samantha</Firstname>
    <Id>2</Id>
    <Lastname>Boucique</Lastname>
    <Manager>false</Manager>
    <Operator>false</Operator>
    <Token>80e3caf5-f1c4-4e4c-ae6a-7b534af70057</Token>
  </EmployeeV1Model>
</ArrayOfEmployeeV1Model>