POST apiwba/bap/getpartnerbysystem

Request Information

URI Parameters

None.

Body Parameters

GetPartnersBySystemInput
NameDescriptionTypeAdditional information
System

string

None.

Username

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "System": "sample string 1",
  "Username": "sample string 2",
  "Password": "sample string 3"
}

application/xml, text/xml

Sample:
<GetPartnersBySystemInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Model">
  <Password xmlns="http://schemas.datacontract.org/2004/07/Entities.Common">sample string 3</Password>
  <Username xmlns="http://schemas.datacontract.org/2004/07/Entities.Common">sample string 2</Username>
  <System>sample string 1</System>
</GetPartnersBySystemInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

GetPartnersBySystemResult
NameDescriptionTypeAdditional information
Data

Collection of PartnersBySystemInputInfo

None.

ProcessErrorType

integer

None.

ProcessErrorDescription

string

None.

Response Formats

application/json, text/json

Sample:
{
  "Data": [
    {
      "System": "sample string 1",
      "PartnerID": 2,
      "ParentID": 3,
      "PartnerName": "sample string 4"
    },
    {
      "System": "sample string 1",
      "PartnerID": 2,
      "ParentID": 3,
      "PartnerName": "sample string 4"
    }
  ],
  "ProcessErrorType": 1,
  "ProcessErrorDescription": "sample string 2"
}

application/xml, text/xml

Sample:
<GetPartnersBySystemResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Model">
  <ProcessErrorDescription xmlns="http://schemas.datacontract.org/2004/07/Entities.Common">sample string 2</ProcessErrorDescription>
  <ProcessErrorType xmlns="http://schemas.datacontract.org/2004/07/Entities.Common">1</ProcessErrorType>
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/DataAccess.Entities.BAP">
    <d2p1:PartnersBySystemInputInfo>
      <d2p1:ParentID>3</d2p1:ParentID>
      <d2p1:PartnerID>2</d2p1:PartnerID>
      <d2p1:PartnerName>sample string 4</d2p1:PartnerName>
      <d2p1:System>sample string 1</d2p1:System>
    </d2p1:PartnersBySystemInputInfo>
    <d2p1:PartnersBySystemInputInfo>
      <d2p1:ParentID>3</d2p1:ParentID>
      <d2p1:PartnerID>2</d2p1:PartnerID>
      <d2p1:PartnerName>sample string 4</d2p1:PartnerName>
      <d2p1:System>sample string 1</d2p1:System>
    </d2p1:PartnersBySystemInputInfo>
  </Data>
</GetPartnersBySystemResult>