GetAuthorizationList

Overview

Retrieve a list of all of the Account Authorizations for your Developer Key

Request

Field Name

Data Type

Description

localID

int

Optional. If a localID is included in the request, only the authorization record which corresponds to the specified CA Account will be returned. Omit this to retrieve all authorization records.

Response

Field Name

Data Type

Description

GetAuthorizationListResult

APIResult<AuthorizationResponse[]>

If the Status property of the return object is set to Success, then the ResultData property will be set to an array of objects containing the list of Authorizations and their state.

Notes

  • * Indicates a REQUIRED Field ... Fields that are NOT required may be set to a null value or left out of a manually built SOAP packet

Sample XML Requests

Without localID parameter


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://api.channeladvisor.com/webservices/">
   <soapenv:Header>
      <web:APICredentials>
         <web:DeveloperKey>DeveloperKey</web:DeveloperKey>
         <web:Password>Password</web:Password>
      </web:APICredentials>
   </soapenv:Header>
   <soapenv:Body>
      <web:GetAuthorizationList />
   </soapenv:Body>
</soapenv:Envelope>

With localID parameter


<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://api.channeladvisor.com/webservices/">
   <soapenv:Header>
      <web:APICredentials>
         <web:DeveloperKey>DeveloperKey</web:DeveloperKey>
         <web:Password>Password</web:Password>
      </web:APICredentials>
   </soapenv:Header>
   <soapenv:Body>
      <web:GetAuthorizationList>
         <web:localID>99999999</web:localID>
      </web:GetAuthorizationList>
   </soapenv:Body>
</soapenv:Envelope>

References