GET v1/exclusion-monitoring/export/clients/{clientCode}/employees?asOf={asOf}

Retrieve Employees By Client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required
asOf		date	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ExclusionMonitoringEmployeeDTO

Name	Type	Additional information
EmployeeStatus	EmployeeStatus	None.
HireDate	date	None.
TerminationDate	date	None.
RehireDate	date	None.
LastName	string	None.
FirstName	string	None.
MiddleInitial	character	None.
SSN	string	None.
BirthDate	date	None.
AddressLine1	string	None.
AddressLine2	string	None.
City	string	None.
State	string	None.
ZipCode	string	None.
ClientCode	string	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "employeeStatus": "Active",
    "hireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "lastName": "sample string 1",
    "firstName": "sample string 2",
    "middleInitial": "A",
    "ssn": "sample string 4",
    "birthDate": "0001-02-03",
    "addressLine1": "sample string 5",
    "addressLine2": "sample string 6",
    "city": "sample string 7",
    "state": "sample string 8",
    "zipCode": "sample string 9",
    "clientCode": "sample string 10",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 11"
  },
  {
    "employeeStatus": "Active",
    "hireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "lastName": "sample string 1",
    "firstName": "sample string 2",
    "middleInitial": "A",
    "ssn": "sample string 4",
    "birthDate": "0001-02-03",
    "addressLine1": "sample string 5",
    "addressLine2": "sample string 6",
    "city": "sample string 7",
    "state": "sample string 8",
    "zipCode": "sample string 9",
    "clientCode": "sample string 10",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 11"
  }
]

text/xml

Sample:

<ArrayOfExclusionMonitoringEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExclusionMonitoringEmployeeDTO>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <EmployeeKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </EmployeeKey>
    <EmployeeNumber>sample string 11</EmployeeNumber>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <BirthDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </BirthDate>
    <City>sample string 7</City>
    <ClientCode>sample string 10</ClientCode>
    <EmployeeStatus>Active</EmployeeStatus>
    <FirstName>sample string 2</FirstName>
    <HireDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </HireDate>
    <LastName>sample string 1</LastName>
    <MiddleInitial>65</MiddleInitial>
    <RehireDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </RehireDate>
    <SSN>sample string 4</SSN>
    <State>sample string 8</State>
    <TerminationDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </TerminationDate>
    <ZipCode>sample string 9</ZipCode>
  </ExclusionMonitoringEmployeeDTO>
  <ExclusionMonitoringEmployeeDTO>
    <DivisionKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
      <d3p1:CompanyCode>sample string 1</d3p1:CompanyCode>
      <d3p1:DivisionCode>sample string 2</d3p1:DivisionCode>
    </DivisionKey>
    <EmployeeKey xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_entityKey>
        <d3p1:_hasValue>false</d3p1:_hasValue>
        <d3p1:_value>00000000-0000-0000-0000-000000000000</d3p1:_value>
      </d3p1:_entityKey>
    </EmployeeKey>
    <EmployeeNumber>sample string 11</EmployeeNumber>
    <AddressLine1>sample string 5</AddressLine1>
    <AddressLine2>sample string 6</AddressLine2>
    <BirthDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </BirthDate>
    <City>sample string 7</City>
    <ClientCode>sample string 10</ClientCode>
    <EmployeeStatus>Active</EmployeeStatus>
    <FirstName>sample string 2</FirstName>
    <HireDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </HireDate>
    <LastName>sample string 1</LastName>
    <MiddleInitial>65</MiddleInitial>
    <RehireDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </RehireDate>
    <SSN>sample string 4</SSN>
    <State>sample string 8</State>
    <TerminationDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
      <d3p1:Year>1</d3p1:Year>
      <d3p1:Month>2</d3p1:Month>
      <d3p1:Day>3</d3p1:Day>
    </TerminationDate>
    <ZipCode>sample string 9</ZipCode>
  </ExclusionMonitoringEmployeeDTO>
</ArrayOfExclusionMonitoringEmployeeDTO>