POST v1/setup/{externalPartner}/credentials/divisions/{divisionId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
externalPartner

ExternalPartners

Required

divisionId

string

Required

Body Parameters

PartnerCredentialDTO
NameDescriptionTypeAdditional information
Username

string

None.

Password

string

None.

ApplicationKey

string

None.

AdditionalData

Collection of DynamicFieldValueDTO

None.

Request Formats

application/json, text/json

Sample:
{
  "username": "sample string 1",
  "password": "sample string 2",
  "applicationKey": "sample string 3",
  "additionalData": [
    {
      "code": "sample string 1",
      "value": {}
    },
    {
      "code": "sample string 1",
      "value": {}
    }
  ]
}

text/xml

Sample:
<PartnerCredentialDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BDBPayroll.Integration.Data.Models">
  <AdditionalData xmlns:d2p1="http://schemas.datacontract.org/2004/07/BDBPayroll.Services.DTO.Models">
    <d2p1:DynamicFieldValueDTO>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Value />
    </d2p1:DynamicFieldValueDTO>
    <d2p1:DynamicFieldValueDTO>
      <d2p1:Code>sample string 1</d2p1:Code>
      <d2p1:Value />
    </d2p1:DynamicFieldValueDTO>
  </AdditionalData>
  <ApplicationKey>sample string 3</ApplicationKey>
  <Password>sample string 2</Password>
  <Username>sample string 1</Username>
</PartnerCredentialDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:
true

text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>