Salespoint Web Service

Salespoint

Click here for a complete list of operations.

GetEventOverview

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 /Salespoint.asmx HTTP/1.1
Host: api.citybreak.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://api.citybreak.com/GetEventOverview"

<?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>
    <GetEventOverview xmlns="http://api.citybreak.com/">
      <producttypegroupId>int</producttypegroupId>
      <searchSpan>
        <Start>dateTime</Start>
        <End>dateTime</End>
      </searchSpan>
      <onlyBookable>boolean</onlyBookable>
      <selectedCity>string</selectedCity>
      <moduleId>string</moduleId>
    </GetEventOverview>
  </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>
    <GetEventOverviewResponse xmlns="http://api.citybreak.com/">
      <GetEventOverviewResult>
        <Created>dateTime</Created>
        <ProducttypegroupId>int</ProducttypegroupId>
        <Arenas>
          <ArenaMapping>
            <Code>string</Code>
            <Name>string</Name>
            <City>string</City>
          </ArenaMapping>
          <ArenaMapping>
            <Code>string</Code>
            <Name>string</Name>
            <City>string</City>
          </ArenaMapping>
        </Arenas>
        <OccasionSummaries>
          <OccasionSummary>
            <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
            <ArenaCode>string</ArenaCode>
            <Start>dateTime</Start>
            <End>dateTime</End>
            <MaxPrice>decimal</MaxPrice>
            <MinPrice>decimal</MinPrice>
            <Currency>string</Currency>
            <MaxAvailableSeats>int</MaxAvailableSeats>
            <MaxConsecutiveSeats>int</MaxConsecutiveSeats>
            <EventId>int</EventId>
            <Id>int</Id>
            <RateCode xsi:nil="true" />
            <OccasionKey>string</OccasionKey>
          </OccasionSummary>
          <OccasionSummary>
            <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
            <ArenaCode>string</ArenaCode>
            <Start>dateTime</Start>
            <End>dateTime</End>
            <MaxPrice>decimal</MaxPrice>
            <MinPrice>decimal</MinPrice>
            <Currency>string</Currency>
            <MaxAvailableSeats>int</MaxAvailableSeats>
            <MaxConsecutiveSeats>int</MaxConsecutiveSeats>
            <EventId>int</EventId>
            <Id>int</Id>
            <RateCode xsi:nil="true" />
            <OccasionKey>string</OccasionKey>
          </OccasionSummary>
        </OccasionSummaries>
        <Events>
          <EventMapping>
            <Id>int</Id>
            <Name>string</Name>
          </EventMapping>
          <EventMapping>
            <Id>int</Id>
            <Name>string</Name>
          </EventMapping>
        </Events>
        <AvailableRateCodes>
          <EventRateCode>
            <RateCodeId>int</RateCodeId>
            <RateCodeName>string</RateCodeName>
          </EventRateCode>
          <EventRateCode>
            <RateCodeId>int</RateCodeId>
            <RateCodeName>string</RateCodeName>
          </EventRateCode>
        </AvailableRateCodes>
      </GetEventOverviewResult>
    </GetEventOverviewResponse>
  </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 /Salespoint.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>
    <GetEventOverview xmlns="http://api.citybreak.com/">
      <producttypegroupId>int</producttypegroupId>
      <searchSpan>
        <Start>dateTime</Start>
        <End>dateTime</End>
      </searchSpan>
      <onlyBookable>boolean</onlyBookable>
      <selectedCity>string</selectedCity>
      <moduleId>string</moduleId>
    </GetEventOverview>
  </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>
    <GetEventOverviewResponse xmlns="http://api.citybreak.com/">
      <GetEventOverviewResult>
        <Created>dateTime</Created>
        <ProducttypegroupId>int</ProducttypegroupId>
        <Arenas>
          <ArenaMapping>
            <Code>string</Code>
            <Name>string</Name>
            <City>string</City>
          </ArenaMapping>
          <ArenaMapping>
            <Code>string</Code>
            <Name>string</Name>
            <City>string</City>
          </ArenaMapping>
        </Arenas>
        <OccasionSummaries>
          <OccasionSummary>
            <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
            <ArenaCode>string</ArenaCode>
            <Start>dateTime</Start>
            <End>dateTime</End>
            <MaxPrice>decimal</MaxPrice>
            <MinPrice>decimal</MinPrice>
            <Currency>string</Currency>
            <MaxAvailableSeats>int</MaxAvailableSeats>
            <MaxConsecutiveSeats>int</MaxConsecutiveSeats>
            <EventId>int</EventId>
            <Id>int</Id>
            <RateCode xsi:nil="true" />
            <OccasionKey>string</OccasionKey>
          </OccasionSummary>
          <OccasionSummary>
            <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
            <ArenaCode>string</ArenaCode>
            <Start>dateTime</Start>
            <End>dateTime</End>
            <MaxPrice>decimal</MaxPrice>
            <MinPrice>decimal</MinPrice>
            <Currency>string</Currency>
            <MaxAvailableSeats>int</MaxAvailableSeats>
            <MaxConsecutiveSeats>int</MaxConsecutiveSeats>
            <EventId>int</EventId>
            <Id>int</Id>
            <RateCode xsi:nil="true" />
            <OccasionKey>string</OccasionKey>
          </OccasionSummary>
        </OccasionSummaries>
        <Events>
          <EventMapping>
            <Id>int</Id>
            <Name>string</Name>
          </EventMapping>
          <EventMapping>
            <Id>int</Id>
            <Name>string</Name>
          </EventMapping>
        </Events>
        <AvailableRateCodes>
          <EventRateCode>
            <RateCodeId>int</RateCodeId>
            <RateCodeName>string</RateCodeName>
          </EventRateCode>
          <EventRateCode>
            <RateCodeId>int</RateCodeId>
            <RateCodeName>string</RateCodeName>
          </EventRateCode>
        </AvailableRateCodes>
      </GetEventOverviewResult>
    </GetEventOverviewResponse>
  </soap12:Body>
</soap12:Envelope>