Dashboard > ChannelAdvisor Developer Network > ChannelAdvisor Developer Network > Ping
Log In   View a printable version of the current page.
Added by Rick Watson, last edited by Rick Watson on Mar 24, 2007  (view change)
Labels: 
(None)


  

Overview

Every service provided by ChannelAdvisor exposes a "Ping" method. This should be the first method you use when you connect to any service, to make sure that your connectivity and credentials are working properly.

Request

There are no parameters required in this request.

Response

Field Name
Data Type Description
PingResult APIResult<string>
This method returns a type named APIResultOfString. See more information on APIResult. If successful, the ResultData field will contain the value "OK".

Sample XML

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
               xmlns:xsd="http://www.w3.org/2001/XMLSchema"
               xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">

  <soap:Header>

    <APICredentials xmlns="http://api.channeladvisor.com/webservices/">

      <DeveloperKey>string</DeveloperKey>

      <Password>string</Password>

    </APICredentials>

  </soap:Header>

  <soap:Body>

    <Ping xmlns="http://api.channeladvisor.com/webservices/" />

  </soap:Body>

</soap:Envelope>

SOAP Request Example

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

SOAP Response Example

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <soap:Body>
      <PingResponse xmlns="http://api.channeladvisor.com/webservices/">
         <PingResult>
            <Status>Success</Status>
            <MessageCode>0</MessageCode>
            <ResultData>OK</ResultData>
         </PingResult>
      </PingResponse>
   </soap:Body>
</soap:Envelope>

SOAP Response Failed Example

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
   <soap:Body>
      <soap:Fault>
         <faultcode>soap:Server</faultcode>
         <faultstring>Server was unable to process request. Authentication failed.</faultstring>
         <detail/>
      </soap:Fault>
   </soap:Body>
</soap:Envelope>

References

Powered by Atlassian Confluence, the Enterprise Wiki. (Version: 2.5.1 Build:#806 May 06, 2007) - Bug/feature request - Contact Administrators