OnlineWs Web Service

OnlineWs

Click here for a complete list of operations.

GetGuideInstances

Get the guide instances that are available for a certain guide you have access to.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /OnlineWS.asmx HTTP/1.1
Host: api.citybreak.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.citybreak.com/GetGuideInstances"

<?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:Body>
    <GetGuideInstances xmlns="http://api.citybreak.com/">
      <guideId>int</guideId>
    </GetGuideInstances>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?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:Body>
    <GetGuideInstancesResponse xmlns="http://api.citybreak.com/">
      <GetGuideInstancesResult>
        <OnlineInstance>
          <GuideId>int</GuideId>
          <GuideInstance>long</GuideInstance>
          <Name>string</Name>
        </OnlineInstance>
        <OnlineInstance>
          <GuideId>int</GuideId>
          <GuideInstance>long</GuideInstance>
          <Name>string</Name>
        </OnlineInstance>
      </GetGuideInstancesResult>
    </GetGuideInstancesResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /OnlineWS.asmx HTTP/1.1
Host: api.citybreak.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetGuideInstances xmlns="http://api.citybreak.com/">
      <guideId>int</guideId>
    </GetGuideInstances>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetGuideInstancesResponse xmlns="http://api.citybreak.com/">
      <GetGuideInstancesResult>
        <OnlineInstance>
          <GuideId>int</GuideId>
          <GuideInstance>long</GuideInstance>
          <Name>string</Name>
        </OnlineInstance>
        <OnlineInstance>
          <GuideId>int</GuideId>
          <GuideInstance>long</GuideInstance>
          <Name>string</Name>
        </OnlineInstance>
      </GetGuideInstancesResult>
    </GetGuideInstancesResponse>
  </soap12:Body>
</soap12:Envelope>