GET v1/export/clients/{clientCode}/onboarding-plans

Retrieve Onboarding Plans by Client

Request Information

URI Parameters

Name	Description	Type	Additional information
clientCode		string	Required

Body Parameters

None.

Response Information

Resource Description

Collection of ExportOnboardingPlanDTO

Name	Type	Additional information
DivisionKey	DivisionKeyDTO	None.
Code	string	None.
Description	string	None.
IsDefault	boolean	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",
    "isDefault": true
  },
  {
    "divisionKey": {
      "companyCode": "sample string 1",
      "divisionCode": "sample string 2"
    },
    "code": "sample string 1",
    "description": "sample string 2",
    "isDefault": true
  }
]

text/xml

Sample:

<ArrayOfExportOnboardingPlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <ExportOnboardingPlanDTO>
    <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>
    <IsDefault>true</IsDefault>
  </ExportOnboardingPlanDTO>
  <ExportOnboardingPlanDTO>
    <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>
    <IsDefault>true</IsDefault>
  </ExportOnboardingPlanDTO>
</ArrayOfExportOnboardingPlanDTO>