POST api/integration/ziplingo/rep

Gets additional representative information.

Request Information

URI Parameters

None.

Body Parameters

The payload.

ZipLingoGetRepInfoRequest
NameDescriptionTypeAdditional information
RepIDs

The list of order IDs to retrieve the information.

 Collection of integer

None.

Request Formats

application/xml, text/xml

Sample: 
<ZipLingoGetRepInfoRequest>
  <RepIDs>
    <Int32>1</Int32>
    <Int32>2</Int32>
  </RepIDs>
</ZipLingoGetRepInfoRequest>

application/json, text/json

Sample: 
{
  "RepIDs": [
    1,
    2
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedFormatter' to write type 'ZipLingoGetRepInfoRequest'.

Response Information

Resource Description

Collection of ZipLingoRepInfoResponse
NameDescriptionTypeAdditional information
RepID

The rep identifier.

 integer

None.
ZipLingoOptIn

Indicates whether the rep is opt-in or not to ZipLingo.

 boolean

None.

Response Formats

application/xml, text/xml

Sample: 
<ListOfZipLingoRepInfoResponse>
  <ZipLingoRepInfoResponse>
    <RepID>1</RepID>
    <ZipLingoOptIn>True</ZipLingoOptIn>
  </ZipLingoRepInfoResponse>
  <ZipLingoRepInfoResponse>
    <RepID>1</RepID>
    <ZipLingoOptIn>True</ZipLingoOptIn>
  </ZipLingoRepInfoResponse>
</ListOfZipLingoRepInfoResponse>

application/json, text/json

Sample: 
[
  {
    "RepID": 1,
    "ZipLingoOptIn": true
  },
  {
    "RepID": 1,
    "ZipLingoOptIn": true
  }
]