POST v1/lms/export/companies/{companyCode}/employees?asOf={asOf}&optionalEmployeeStatus={optionalEmployeeStatus}

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
asOf	date	None.
optionalEmployeeStatus	EmployeeStatus	None.

Body Parameters

Collection of string

Request Formats

application/json, text/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

text/xml

Sample:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of LMSEmployeeDTO

Name	Type	Additional information
PersonalId	EntityKeyOfIEmployeePersonalAndInt32	None.
LastName	string	None.
MiddleInitial	character	None.
FirstName	string	None.
SSN	string	None.
EmployeeStatus	EmployeeStatus	None.
HireDate	date	None.
RehireDate	date	None.
TerminationDate	date	None.
EmployeeType	FullOrPartTime	None.
PayGroup	string	None.
LocationCode	string	None.
ShiftCode	string	None.
CostCenter1	string	None.
CostCenter2	string	None.
CostCenter3	string	None.
CostCenter4	string	None.
CostCenter5	string	None.
JobTitle	string	None.
BirthDate	date	None.
Gender	Gender	None.
Email	string	None.
HomePhone	string	None.
WorkPhone	string	None.
MobilePhone	string	None.
ModifiedOn	date	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "personalId": "<empty>",
    "lastName": "sample string 1",
    "middleInitial": "A",
    "firstName": "sample string 3",
    "ssn": "sample string 4",
    "employeeStatus": "Active",
    "hireDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "employeeType": "FullTime",
    "payGroup": "sample string 5",
    "locationCode": "sample string 6",
    "shiftCode": "sample string 7",
    "costCenter1": "sample string 8",
    "costCenter2": "sample string 9",
    "costCenter3": "sample string 10",
    "costCenter4": "sample string 11",
    "costCenter5": "sample string 12",
    "jobTitle": "sample string 13",
    "birthDate": "0001-02-03",
    "gender": "Male",
    "email": "sample string 14",
    "homePhone": "sample string 15",
    "workPhone": "sample string 16",
    "mobilePhone": "sample string 17",
    "modifiedOn": "2025-04-11T18:08:41.1438516Z",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 19"
  },
  {
    "personalId": "<empty>",
    "lastName": "sample string 1",
    "middleInitial": "A",
    "firstName": "sample string 3",
    "ssn": "sample string 4",
    "employeeStatus": "Active",
    "hireDate": "0001-02-03",
    "rehireDate": "0001-02-03",
    "terminationDate": "0001-02-03",
    "employeeType": "FullTime",
    "payGroup": "sample string 5",
    "locationCode": "sample string 6",
    "shiftCode": "sample string 7",
    "costCenter1": "sample string 8",
    "costCenter2": "sample string 9",
    "costCenter3": "sample string 10",
    "costCenter4": "sample string 11",
    "costCenter5": "sample string 12",
    "jobTitle": "sample string 13",
    "birthDate": "0001-02-03",
    "gender": "Male",
    "email": "sample string 14",
    "homePhone": "sample string 15",
    "workPhone": "sample string 16",
    "mobilePhone": "sample string 17",
    "modifiedOn": "2025-04-11T18:08:41.1438516Z",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 19"
  }
]

text/xml

Sample:

<ArrayOfLMSEmployeeDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <LMSEmployeeDTO>
    <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 19</EmployeeNumber>
    <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>
    <CostCenter1>sample string 8</CostCenter1>
    <CostCenter2>sample string 9</CostCenter2>
    <CostCenter3>sample string 10</CostCenter3>
    <CostCenter4>sample string 11</CostCenter4>
    <CostCenter5>sample string 12</CostCenter5>
    <Email>sample string 14</Email>
    <EmployeeStatus>Active</EmployeeStatus>
    <EmployeeType>FullTime</EmployeeType>
    <FirstName>sample string 3</FirstName>
    <Gender>Male</Gender>
    <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>
    <HomePhone>sample string 15</HomePhone>
    <JobTitle>sample string 13</JobTitle>
    <LastName>sample string 1</LastName>
    <LocationCode>sample string 6</LocationCode>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 17</MobilePhone>
    <ModifiedOn>2025-04-11T14:08:41.1438516-04:00</ModifiedOn>
    <PayGroup>sample string 5</PayGroup>
    <PersonalId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </PersonalId>
    <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>
    <ShiftCode>sample string 7</ShiftCode>
    <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>
    <WorkPhone>sample string 16</WorkPhone>
  </LMSEmployeeDTO>
  <LMSEmployeeDTO>
    <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 19</EmployeeNumber>
    <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>
    <CostCenter1>sample string 8</CostCenter1>
    <CostCenter2>sample string 9</CostCenter2>
    <CostCenter3>sample string 10</CostCenter3>
    <CostCenter4>sample string 11</CostCenter4>
    <CostCenter5>sample string 12</CostCenter5>
    <Email>sample string 14</Email>
    <EmployeeStatus>Active</EmployeeStatus>
    <EmployeeType>FullTime</EmployeeType>
    <FirstName>sample string 3</FirstName>
    <Gender>Male</Gender>
    <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>
    <HomePhone>sample string 15</HomePhone>
    <JobTitle>sample string 13</JobTitle>
    <LastName>sample string 1</LastName>
    <LocationCode>sample string 6</LocationCode>
    <MiddleInitial>65</MiddleInitial>
    <MobilePhone>sample string 17</MobilePhone>
    <ModifiedOn>2025-04-11T14:08:41.1438516-04:00</ModifiedOn>
    <PayGroup>sample string 5</PayGroup>
    <PersonalId xmlns:d3p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
      <d3p1:_hasValue>false</d3p1:_hasValue>
      <d3p1:_value>0</d3p1:_value>
    </PersonalId>
    <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>
    <ShiftCode>sample string 7</ShiftCode>
    <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>
    <WorkPhone>sample string 16</WorkPhone>
  </LMSEmployeeDTO>
</ArrayOfLMSEmployeeDTO>