GET v1/export/companies/{companyCode}/employee-statuses

Retrieve Employee Statuses by Company

Request Information

URI Parameters

NameDescriptionTypeAdditional information
companyCode

string

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportEmployeeStatusDTO
NameDescriptionTypeAdditional information
DivisionKey

DivisionKeyDTO

None.

Code

string

None.

Description

string

None.

EmployeeStatus

EmployeeStatus

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "code": "sample string 1",
    "description": "sample string 2",
    "employeeStatus": "Active"
  },
  {
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "code": "sample string 1",
    "description": "sample string 2",
    "employeeStatus": "Active"
  }
]

text/xml

Sample:
<ArrayOfExportEmployeeStatusDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportEmployeeStatusDTO>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <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>
    <EmployeeStatus>Active</EmployeeStatus>
  </ExportEmployeeStatusDTO>
  <ExportEmployeeStatusDTO>
    <Code>sample string 1</Code>
    <Description>sample string 2</Description>
    <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>
    <EmployeeStatus>Active</EmployeeStatus>
  </ExportEmployeeStatusDTO>
</ArrayOfExportEmployeeStatusDTO>