POST v1/export/companies/{companyCode}/divisions/{divisionCode}/employee-personals/bySSNs?scope={scope}

Retrieve Employee Personal Headers by Division

Request Information

URI Parameters

Name	Type	Additional information
companyCode	string	Required
divisionCode	string	Required
scope	OrganizationScope	Required

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 ExportEmployeePersonalHeaderDTO

Name	Type	Additional information
PersonalId	integer	None.
LastName	string	None.
FirstName	string	None.
MiddleInitial	character	None.
SSN	string	None.
BirthDate	date	None.
PrimaryLanguage	Language	None.
DivisionKey	DivisionKeyDTO	None.
EmployeeKey	GlobalEntityKeyOfIEmployee	None.
EmployeeNumber	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "personalId": 1,
    "lastName": "sample string 2",
    "firstName": "sample string 3",
    "middleInitial": "A",
    "ssn": "sample string 5",
    "birthDate": "0001-02-03",
    "primaryLanguage": "en",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 6"
  },
  {
    "personalId": 1,
    "lastName": "sample string 2",
    "firstName": "sample string 3",
    "middleInitial": "A",
    "ssn": "sample string 5",
    "birthDate": "0001-02-03",
    "primaryLanguage": "en",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "employeeKey": "<empty>",
    "employeeNumber": "sample string 6"
  }
]

text/xml

Sample:

<ArrayOfExportEmployeePersonalHeaderDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeePersonalHeaderDTO>
    <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 6</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>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 2</LastName>
    <MiddleInitial>65</MiddleInitial>
    <PersonalId>1</PersonalId>
    <PrimaryLanguage>en</PrimaryLanguage>
    <SSN>sample string 5</SSN>
  </ExportEmployeePersonalHeaderDTO>
  <ExportEmployeePersonalHeaderDTO>
    <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 6</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>
    <FirstName>sample string 3</FirstName>
    <LastName>sample string 2</LastName>
    <MiddleInitial>65</MiddleInitial>
    <PersonalId>1</PersonalId>
    <PrimaryLanguage>en</PrimaryLanguage>
    <SSN>sample string 5</SSN>
  </ExportEmployeePersonalHeaderDTO>
</ArrayOfExportEmployeePersonalHeaderDTO>