POST v1/copy/benefit-plans?importAction={importAction}

Copy Division Benefit Plans

Request Information

URI Parameters

Name	Description	Type	Additional information
importAction	The import action.	ImportAction	Default value is Insert

Body Parameters

The items to copy.

Collection of CopyDivisionBenefitPlanDTO

Name	Type	Additional information
SourcePlanName	string	Required
TargetOptionalPlanName	string	None.
TargetOptionalPlanDescription	string	None.
SourceCompanyCode	string	None.
SourceDivisionCode	string	None.
TargetCompanyCode	string	None.
TargetDivisionCode	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "sourcePlanName": "sample string 1",
    "targetOptionalPlanName": "sample string 2",
    "targetOptionalPlanDescription": "sample string 3",
    "sourceCompanyCode": "sample string 4",
    "sourceDivisionCode": "sample string 5",
    "targetCompanyCode": "sample string 6",
    "targetDivisionCode": "sample string 7"
  },
  {
    "sourcePlanName": "sample string 1",
    "targetOptionalPlanName": "sample string 2",
    "targetOptionalPlanDescription": "sample string 3",
    "sourceCompanyCode": "sample string 4",
    "sourceDivisionCode": "sample string 5",
    "targetCompanyCode": "sample string 6",
    "targetDivisionCode": "sample string 7"
  }
]

text/xml

Sample:

<ArrayOfCopyDivisionBenefitPlanDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.ServiceContracts.Data.Models">
  <CopyDivisionBenefitPlanDTO>
    <SourceCompanyCode>sample string 4</SourceCompanyCode>
    <SourceDivisionCode>sample string 5</SourceDivisionCode>
    <TargetCompanyCode>sample string 6</TargetCompanyCode>
    <TargetDivisionCode>sample string 7</TargetDivisionCode>
    <SourcePlanName>sample string 1</SourcePlanName>
    <TargetOptionalPlanDescription>sample string 3</TargetOptionalPlanDescription>
    <TargetOptionalPlanName>sample string 2</TargetOptionalPlanName>
  </CopyDivisionBenefitPlanDTO>
  <CopyDivisionBenefitPlanDTO>
    <SourceCompanyCode>sample string 4</SourceCompanyCode>
    <SourceDivisionCode>sample string 5</SourceDivisionCode>
    <TargetCompanyCode>sample string 6</TargetCompanyCode>
    <TargetDivisionCode>sample string 7</TargetDivisionCode>
    <SourcePlanName>sample string 1</SourcePlanName>
    <TargetOptionalPlanDescription>sample string 3</TargetOptionalPlanDescription>
    <TargetOptionalPlanName>sample string 2</TargetOptionalPlanName>
  </CopyDivisionBenefitPlanDTO>
</ArrayOfCopyDivisionBenefitPlanDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

The results of the import.

ImportResultDTO

Name	Type	Additional information
NewRecords	integer	None.
UpdatedRecords	integer	None.
Errors	Collection of ImportErrorDTO	None.
NewRecordKeys	Collection of ImportKeyDTO	None.
UpdatedRecordKeys	Collection of ImportKeyDTO	None.
ImportKey	GlobalEntityKeyOfIImportSubmission	None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.