Get Employees List

Returns an api_EmployeesListingResult array of your Vorex Account employees, with the ability to filter by employee name, department, job title, location and username.

Request

URL	https://vorexlogin.com/GetEmployeesList

Type	Params	Values
HEAD	WSUserCredentials	Object
PARAM	name	string
PARAM	departmentName	string
PARAM	jobTitle	string
PARAM	location	string
PARAM	userNames	string
PARAM	outputMessage	OUTPUT String

WSUserCredentials - A custom authentication SOAP header object consisting of:
- UserName
- Password
- CompanyName
name - Specify the name value by which to filter employees based on their first name or last name. If Null or Empty ("") this will be ignored.
departmentName - Specify the department(s) value(s) by which to filter employees based on. For multiple departments you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
jobTitle - Specify the Job Titles(s) value(s) by which to filter employees based on. For multiple Job Titles you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
location - Specify the branches(s) value(s) by which to filter employees based on. For multiple branches (locations) you have to separate by Comma (,). If Null or Empty ("") this will be ignored.
userNames - Specify the username(s) value(s) by which to filter employees based on. For multiple usernames you have to separate by Comma (,). If Null or Empty ("") this will be ignored.

Example Request

POST /WS/OpenAPI.asmx HTTP/1.1
Host: vorexlogin.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://vorexlogin.com/GetEmployeesList"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <WSUserCredentials xmlns="https://vorexlogin.com/">
      <UserName>string</UserName>
      <Password>string</Password>
      <CompanyName>string</CompanyName>
    </WSUserCredentials>
  </soap:Header>
  <soap:Body>
    <GetEmployeesList xmlns="https://vorexlogin.com/">
      <name>string</name>
      <departmentName>string</departmentName>
      <jobTitle>string</jobTitle>
      <location>string</location>
      <userNames>string</userNames>
    </GetEmployeesList>
  </soap:Body>
</soap:Envelope>

Response

Status

Response

Success

GetEmployeesListResult:

Array of api_EmployeesListingResult:
- UserId (int)
- UserName (string)
- EmployeeName (string)
- MiddleName (string)
- Manager (string)
- EmployementType (string)
- Gender (string)
- MaritalStatus (string)
- IsActive (boolean)
- Description (string)
- CreatedOn (dateTime)
- ModifiedOn (dateTime)
- EmailAddress (string)
- EmployeeId (string)
- JobTitle (string)
- Department (string)
- HireDate (dateTime)
- TerminationDate (dateTime)
- BranchName (dateTime)

outputMessage:

Empty String

Failure

GetEmployeesListResult:

Returns Null

outputMessage:

"An Error has Occurred while processing the request."

Example Response

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetEmployeesListResponse xmlns="https://vorexlogin.com/">
      <GetEmployeesListResult>
        <api_EmployeesListingResult>
          <UserId>int</UserId>
          <UserName>string</UserName>
          <EmployeName>string</EmployeName>
          <MiddleName>string</MiddleName>
          <Manager>string</Manager>
          <EmploymentType>string</EmploymentType>
          <Gender>string</Gender>
          <MaritalStatus>string</MaritalStatus>
          <IsActive>boolean</IsActive>
          <Description>string</Description>
          <CreatedOn>dateTime</CreatedOn>
          <ModifiedOn>dateTime</ModifiedOn>
          <EmailAddress>string</EmailAddress>
          <EmployeeId>string</EmployeeId>
          <JobTitle>string</JobTitle>
          <Department>string</Department>
          <HireDate>dateTime</HireDate>
          <TerminationDate>dateTime</TerminationDate>
          <BranchName>string</BranchName>
        </api_EmployeesListingResult>
      <outputMessage>string</outputMessage>
    </GetEmployeesListResponse>
  </soap:Body>
</soap:Envelope>