POST api/integration/ziplingo/customer

Gets additional customer information.

Request Information

URI Parameters

None.

Body Parameters

The payload.

ZipLingoGetCustomerInfoRequest
NameDescriptionTypeAdditional information
CustomerIDs

The list of customer IDs to retrieve the information..

 Collection of integer

None.

Request Formats

application/xml, text/xml

Sample: 
<ZipLingoGetCustomerInfoRequest>
  <CustomerIDs>
    <Int32>1</Int32>
    <Int32>2</Int32>
  </CustomerIDs>
</ZipLingoGetCustomerInfoRequest>

application/json, text/json

Sample: 
{
  "CustomerIDs": [
    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 'ZipLingoGetCustomerInfoRequest'.

Response Information

Resource Description

Collection of ZipLingoCustomerInfoResponse
NameDescriptionTypeAdditional information
CustomerID

The customer identifier.

 integer

None.
ZipLingoOptIn

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

 boolean

None.

Response Formats

application/xml, text/xml

Sample: 
<ListOfZipLingoCustomerInfoResponse>
  <ZipLingoCustomerInfoResponse>
    <CustomerID>1</CustomerID>
    <ZipLingoOptIn>True</ZipLingoOptIn>
  </ZipLingoCustomerInfoResponse>
  <ZipLingoCustomerInfoResponse>
    <CustomerID>1</CustomerID>
    <ZipLingoOptIn>True</ZipLingoOptIn>
  </ZipLingoCustomerInfoResponse>
</ListOfZipLingoCustomerInfoResponse>

application/json, text/json

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