GET api/Employee?AuthenticationGUID={AuthenticationGUID}&CompanyID={CompanyID}&FirstName={FirstName}&LastName={LastName}&Email={Email}
Returns an Array of Employee Lookup Information matching the data provided
Request Information
Parameters
Name | Description | Additional information |
---|---|---|
AuthenticationGUID |
The Authentication GUID provided to you by your Account Manager |
Define this parameter in the request URI. |
CompanyID |
The EHX Company ID |
Define this parameter in the request URI. |
FirstName |
The employee's first Name |
Define this parameter in the request URI. |
LastName |
The employee's last name |
Define this parameter in the request URI. |
The employee's email address |
Define this parameter in the request URI. |
Response Information
Response body formats
application/json, text/json
Sample:
[ { "CompanyID": 1, "Email": "sample string 2", "EmployeeID": 3, "FirstName": "sample string 4", "LastName": "sample string 5", "Status": "sample string 6" }, { "CompanyID": 1, "Email": "sample string 2", "EmployeeID": 3, "FirstName": "sample string 4", "LastName": "sample string 5", "Status": "sample string 6" }, { "CompanyID": 1, "Email": "sample string 2", "EmployeeID": 3, "FirstName": "sample string 4", "LastName": "sample string 5", "Status": "sample string 6" } ]
application/xml, text/xml
Sample:
<ArrayOfMainAPI.EmployeeLookupClass xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EFAPIWeb"> <MainAPI.EmployeeLookupClass> <CompanyID>1</CompanyID> <Email>sample string 2</Email> <EmployeeID>3</EmployeeID> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Status>sample string 6</Status> </MainAPI.EmployeeLookupClass> <MainAPI.EmployeeLookupClass> <CompanyID>1</CompanyID> <Email>sample string 2</Email> <EmployeeID>3</EmployeeID> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Status>sample string 6</Status> </MainAPI.EmployeeLookupClass> <MainAPI.EmployeeLookupClass> <CompanyID>1</CompanyID> <Email>sample string 2</Email> <EmployeeID>3</EmployeeID> <FirstName>sample string 4</FirstName> <LastName>sample string 5</LastName> <Status>sample string 6</Status> </MainAPI.EmployeeLookupClass> </ArrayOfMainAPI.EmployeeLookupClass>