GET v1/ats/export/companies/{companyCode}/divisions

Retrieve Divisions by Company Code

Request Information

URI Parameters

Name	Description	Type	Additional information
companyCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportDivisionDTO

Name	Type	Additional information
DivisionId	GlobalEntityKeyOfIDivision	None.
DBA	string	None.
DivisionStatus	DivisionStatus	None.
TerminationDate	date	None.
DivisionKey	DivisionKeyDTO	None.
CompanyLegalName	string	None.
DivisionName	string	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "divisionId": "<empty>",
    "dba": "sample string 1",
    "divisionStatus": "Active",
    "terminationDate": "0001-02-03",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "companyLegalName": "sample string 2",
    "divisionName": "sample string 3"
  },
  {
    "divisionId": "<empty>",
    "dba": "sample string 1",
    "divisionStatus": "Active",
    "terminationDate": "0001-02-03",
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "companyLegalName": "sample string 2",
    "divisionName": "sample string 3"
  }
]

text/xml

Sample:

<ArrayOfExportDivisionDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportDivisionDTO>
    <CompanyLegalName>sample string 2</CompanyLegalName>
    <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>
    <DivisionName>sample string 3</DivisionName>
    <DBA>sample string 1</DBA>
    <DivisionId 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>
    </DivisionId>
    <DivisionStatus>Active</DivisionStatus>
    <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>
  </ExportDivisionDTO>
  <ExportDivisionDTO>
    <CompanyLegalName>sample string 2</CompanyLegalName>
    <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>
    <DivisionName>sample string 3</DivisionName>
    <DBA>sample string 1</DBA>
    <DivisionId 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>
    </DivisionId>
    <DivisionStatus>Active</DivisionStatus>
    <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>
  </ExportDivisionDTO>
</ArrayOfExportDivisionDTO>