GET v1/ams/{externalPartner}/export/divisions/{divisionId}/employees?showLinkConflictsOnly={showLinkConflictsOnly}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalPartner

ExternalPartners

Required

divisionId

string

Required

showLinkConflictsOnly

boolean

Default value is True

Body Parameters

None.

Response Information

Resource Description

AMSEmployeeHeaderResultDTO
NameDescriptionTypeAdditional information
Internals

Collection of AMSEmployeeHeaderDTO

None.

Externals

Collection of AMSEmployeeHeaderDTO

None.

Response Formats

application/json, text/json

Sample:
{
  "internals": [
    {
      "divisionKey": "<empty>",
      "employeeKey": "<empty>",
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2",
      "externalKey": "sample string 3",
      "employeeNumber": "sample string 4",
      "status": "Active",
      "firstName": "sample string 5",
      "middleInitial": "sample string 6",
      "lastName": "sample string 7",
      "email": "sample string 8",
      "homePhone": "sample string 9",
      "hireDate": "0001-02-03",
      "syncStatus": "None",
      "comparisonStatus": "None"
    },
    {
      "divisionKey": "<empty>",
      "employeeKey": "<empty>",
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2",
      "externalKey": "sample string 3",
      "employeeNumber": "sample string 4",
      "status": "Active",
      "firstName": "sample string 5",
      "middleInitial": "sample string 6",
      "lastName": "sample string 7",
      "email": "sample string 8",
      "homePhone": "sample string 9",
      "hireDate": "0001-02-03",
      "syncStatus": "None",
      "comparisonStatus": "None"
    }
  ],
  "externals": [
    {
      "divisionKey": "<empty>",
      "employeeKey": "<empty>",
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2",
      "externalKey": "sample string 3",
      "employeeNumber": "sample string 4",
      "status": "Active",
      "firstName": "sample string 5",
      "middleInitial": "sample string 6",
      "lastName": "sample string 7",
      "email": "sample string 8",
      "homePhone": "sample string 9",
      "hireDate": "0001-02-03",
      "syncStatus": "None",
      "comparisonStatus": "None"
    },
    {
      "divisionKey": "<empty>",
      "employeeKey": "<empty>",
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2",
      "externalKey": "sample string 3",
      "employeeNumber": "sample string 4",
      "status": "Active",
      "firstName": "sample string 5",
      "middleInitial": "sample string 6",
      "lastName": "sample string 7",
      "email": "sample string 8",
      "homePhone": "sample string 9",
      "hireDate": "0001-02-03",
      "syncStatus": "None",
      "comparisonStatus": "None"
    }
  ]
}

text/xml

Sample:
<AMSEmployeeHeaderResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <Externals>
    <AMSEmployeeHeaderDTO>
      <CompanyCode>sample string 1</CompanyCode>
      <ComparisonStatus>None</ComparisonStatus>
      <DivisionCode>sample string 2</DivisionCode>
      <DivisionKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
        <d4p1:_entityKey>
          <d4p1:_hasValue>false</d4p1:_hasValue>
          <d4p1:_value>00000000-0000-0000-0000-000000000000</d4p1:_value>
        </d4p1:_entityKey>
      </DivisionKey>
      <Email>sample string 8</Email>
      <EmployeeKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
        <d4p1:_entityKey>
          <d4p1:_hasValue>false</d4p1:_hasValue>
          <d4p1:_value>00000000-0000-0000-0000-000000000000</d4p1:_value>
        </d4p1:_entityKey>
      </EmployeeKey>
      <EmployeeNumber>sample string 4</EmployeeNumber>
      <ExternalKey>sample string 3</ExternalKey>
      <FirstName>sample string 5</FirstName>
      <HireDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
        <d4p1:Year>1</d4p1:Year>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Day>3</d4p1:Day>
      </HireDate>
      <HomePhone>sample string 9</HomePhone>
      <LastName>sample string 7</LastName>
      <MiddleInitial>sample string 6</MiddleInitial>
      <Status>Active</Status>
      <SyncStatus>None</SyncStatus>
    </AMSEmployeeHeaderDTO>
    <AMSEmployeeHeaderDTO>
      <CompanyCode>sample string 1</CompanyCode>
      <ComparisonStatus>None</ComparisonStatus>
      <DivisionCode>sample string 2</DivisionCode>
      <DivisionKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
        <d4p1:_entityKey>
          <d4p1:_hasValue>false</d4p1:_hasValue>
          <d4p1:_value>00000000-0000-0000-0000-000000000000</d4p1:_value>
        </d4p1:_entityKey>
      </DivisionKey>
      <Email>sample string 8</Email>
      <EmployeeKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
        <d4p1:_entityKey>
          <d4p1:_hasValue>false</d4p1:_hasValue>
          <d4p1:_value>00000000-0000-0000-0000-000000000000</d4p1:_value>
        </d4p1:_entityKey>
      </EmployeeKey>
      <EmployeeNumber>sample string 4</EmployeeNumber>
      <ExternalKey>sample string 3</ExternalKey>
      <FirstName>sample string 5</FirstName>
      <HireDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
        <d4p1:Year>1</d4p1:Year>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Day>3</d4p1:Day>
      </HireDate>
      <HomePhone>sample string 9</HomePhone>
      <LastName>sample string 7</LastName>
      <MiddleInitial>sample string 6</MiddleInitial>
      <Status>Active</Status>
      <SyncStatus>None</SyncStatus>
    </AMSEmployeeHeaderDTO>
  </Externals>
  <Internals>
    <AMSEmployeeHeaderDTO>
      <CompanyCode>sample string 1</CompanyCode>
      <ComparisonStatus>None</ComparisonStatus>
      <DivisionCode>sample string 2</DivisionCode>
      <DivisionKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
        <d4p1:_entityKey>
          <d4p1:_hasValue>false</d4p1:_hasValue>
          <d4p1:_value>00000000-0000-0000-0000-000000000000</d4p1:_value>
        </d4p1:_entityKey>
      </DivisionKey>
      <Email>sample string 8</Email>
      <EmployeeKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
        <d4p1:_entityKey>
          <d4p1:_hasValue>false</d4p1:_hasValue>
          <d4p1:_value>00000000-0000-0000-0000-000000000000</d4p1:_value>
        </d4p1:_entityKey>
      </EmployeeKey>
      <EmployeeNumber>sample string 4</EmployeeNumber>
      <ExternalKey>sample string 3</ExternalKey>
      <FirstName>sample string 5</FirstName>
      <HireDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
        <d4p1:Year>1</d4p1:Year>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Day>3</d4p1:Day>
      </HireDate>
      <HomePhone>sample string 9</HomePhone>
      <LastName>sample string 7</LastName>
      <MiddleInitial>sample string 6</MiddleInitial>
      <Status>Active</Status>
      <SyncStatus>None</SyncStatus>
    </AMSEmployeeHeaderDTO>
    <AMSEmployeeHeaderDTO>
      <CompanyCode>sample string 1</CompanyCode>
      <ComparisonStatus>None</ComparisonStatus>
      <DivisionCode>sample string 2</DivisionCode>
      <DivisionKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
        <d4p1:_entityKey>
          <d4p1:_hasValue>false</d4p1:_hasValue>
          <d4p1:_value>00000000-0000-0000-0000-000000000000</d4p1:_value>
        </d4p1:_entityKey>
      </DivisionKey>
      <Email>sample string 8</Email>
      <EmployeeKey xmlns:d4p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.Data.Shared.Keys">
        <d4p1:_entityKey>
          <d4p1:_hasValue>false</d4p1:_hasValue>
          <d4p1:_value>00000000-0000-0000-0000-000000000000</d4p1:_value>
        </d4p1:_entityKey>
      </EmployeeKey>
      <EmployeeNumber>sample string 4</EmployeeNumber>
      <ExternalKey>sample string 3</ExternalKey>
      <FirstName>sample string 5</FirstName>
      <HireDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/EntireOne.Shared.Dates">
        <d4p1:Year>1</d4p1:Year>
        <d4p1:Month>2</d4p1:Month>
        <d4p1:Day>3</d4p1:Day>
      </HireDate>
      <HomePhone>sample string 9</HomePhone>
      <LastName>sample string 7</LastName>
      <MiddleInitial>sample string 6</MiddleInitial>
      <Status>Active</Status>
      <SyncStatus>None</SyncStatus>
    </AMSEmployeeHeaderDTO>
  </Internals>
</AMSEmployeeHeaderResultDTO>