Salespoint Web Service

Salespoint

Click here for a complete list of operations.

GetEventOccasion

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/GetEventOccasion"

<?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>
    <GetEventOccasion xmlns="http://api.citybreak.com/">
      <occasionKey>string</occasionKey>
    </GetEventOccasion>
  </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>
    <GetEventOccasionResponse xmlns="http://api.citybreak.com/">
      <GetEventOccasionResult>
        <SeatSelectionMode>NotSet or MustBeAutoAssigned or CanBeAutoAssigned or NoAutoAssign</SeatSelectionMode>
        <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
        <OverviewImageUrl>string</OverviewImageUrl>
        <Hotspots>
          <Hotspot>
            <AvailableForSale>boolean</AvailableForSale>
            <Coordinates>string</Coordinates>
            <Description>string</Description>
            <SectionId>string</SectionId>
          </Hotspot>
          <Hotspot>
            <AvailableForSale>boolean</AvailableForSale>
            <Coordinates>string</Coordinates>
            <Description>string</Description>
            <SectionId>string</SectionId>
          </Hotspot>
        </Hotspots>
        <Sections>
          <Section>
            <Id>string</Id>
            <Name>string</Name>
            <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
          </Section>
          <Section>
            <Id>string</Id>
            <Name>string</Name>
            <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
          </Section>
        </Sections>
        <Areas>
          <Area>
            <Id>string</Id>
            <Name>string</Name>
            <SectionId>string</SectionId>
          </Area>
          <Area>
            <Id>string</Id>
            <Name>string</Name>
            <SectionId>string</SectionId>
          </Area>
        </Areas>
        <Categories>
          <PriceCategory>
            <Id>string</Id>
            <Name>string</Name>
          </PriceCategory>
          <PriceCategory>
            <Id>string</Id>
            <Name>string</Name>
          </PriceCategory>
        </Categories>
        <TicketCategories>
          <TicketCategory>
            <AreaId>string</AreaId>
            <ExternalId>string</ExternalId>
            <Name>string</Name>
            <Currency>string</Currency>
            <Price>decimal</Price>
            <Description>string</Description>
            <SectionId>string</SectionId>
            <PriceCategoryId>string</PriceCategoryId>
            <BookKey>string</BookKey>
            <AvailableSeats>int</AvailableSeats>
            <ConsecutiveSeats>int</ConsecutiveSeats>
            <TicketsPerUnit>int</TicketsPerUnit>
            <MaximumNumberOfTickets>int</MaximumNumberOfTickets>
            <MinimumNumberOfTickets>int</MinimumNumberOfTickets>
            <SortOrder>int</SortOrder>
          </TicketCategory>
          <TicketCategory>
            <AreaId>string</AreaId>
            <ExternalId>string</ExternalId>
            <Name>string</Name>
            <Currency>string</Currency>
            <Price>decimal</Price>
            <Description>string</Description>
            <SectionId>string</SectionId>
            <PriceCategoryId>string</PriceCategoryId>
            <BookKey>string</BookKey>
            <AvailableSeats>int</AvailableSeats>
            <ConsecutiveSeats>int</ConsecutiveSeats>
            <TicketsPerUnit>int</TicketsPerUnit>
            <MaximumNumberOfTickets>int</MaximumNumberOfTickets>
            <MinimumNumberOfTickets>int</MinimumNumberOfTickets>
            <SortOrder>int</SortOrder>
          </TicketCategory>
        </TicketCategories>
        <Start>dateTime</Start>
        <End>dateTime</End>
        <ArenaCode>string</ArenaCode>
        <ArenaName>string</ArenaName>
        <EventIdentifier>string</EventIdentifier>
      </GetEventOccasionResult>
    </GetEventOccasionResponse>
  </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>
    <GetEventOccasion xmlns="http://api.citybreak.com/">
      <occasionKey>string</occasionKey>
    </GetEventOccasion>
  </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>
    <GetEventOccasionResponse xmlns="http://api.citybreak.com/">
      <GetEventOccasionResult>
        <SeatSelectionMode>NotSet or MustBeAutoAssigned or CanBeAutoAssigned or NoAutoAssign</SeatSelectionMode>
        <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
        <OverviewImageUrl>string</OverviewImageUrl>
        <Hotspots>
          <Hotspot>
            <AvailableForSale>boolean</AvailableForSale>
            <Coordinates>string</Coordinates>
            <Description>string</Description>
            <SectionId>string</SectionId>
          </Hotspot>
          <Hotspot>
            <AvailableForSale>boolean</AvailableForSale>
            <Coordinates>string</Coordinates>
            <Description>string</Description>
            <SectionId>string</SectionId>
          </Hotspot>
        </Hotspots>
        <Sections>
          <Section>
            <Id>string</Id>
            <Name>string</Name>
            <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
          </Section>
          <Section>
            <Id>string</Id>
            <Name>string</Name>
            <AvailableTicketStatus>NotSet or Available or FewAvailable or SoldOutInSaleChannel or SoldOut</AvailableTicketStatus>
          </Section>
        </Sections>
        <Areas>
          <Area>
            <Id>string</Id>
            <Name>string</Name>
            <SectionId>string</SectionId>
          </Area>
          <Area>
            <Id>string</Id>
            <Name>string</Name>
            <SectionId>string</SectionId>
          </Area>
        </Areas>
        <Categories>
          <PriceCategory>
            <Id>string</Id>
            <Name>string</Name>
          </PriceCategory>
          <PriceCategory>
            <Id>string</Id>
            <Name>string</Name>
          </PriceCategory>
        </Categories>
        <TicketCategories>
          <TicketCategory>
            <AreaId>string</AreaId>
            <ExternalId>string</ExternalId>
            <Name>string</Name>
            <Currency>string</Currency>
            <Price>decimal</Price>
            <Description>string</Description>
            <SectionId>string</SectionId>
            <PriceCategoryId>string</PriceCategoryId>
            <BookKey>string</BookKey>
            <AvailableSeats>int</AvailableSeats>
            <ConsecutiveSeats>int</ConsecutiveSeats>
            <TicketsPerUnit>int</TicketsPerUnit>
            <MaximumNumberOfTickets>int</MaximumNumberOfTickets>
            <MinimumNumberOfTickets>int</MinimumNumberOfTickets>
            <SortOrder>int</SortOrder>
          </TicketCategory>
          <TicketCategory>
            <AreaId>string</AreaId>
            <ExternalId>string</ExternalId>
            <Name>string</Name>
            <Currency>string</Currency>
            <Price>decimal</Price>
            <Description>string</Description>
            <SectionId>string</SectionId>
            <PriceCategoryId>string</PriceCategoryId>
            <BookKey>string</BookKey>
            <AvailableSeats>int</AvailableSeats>
            <ConsecutiveSeats>int</ConsecutiveSeats>
            <TicketsPerUnit>int</TicketsPerUnit>
            <MaximumNumberOfTickets>int</MaximumNumberOfTickets>
            <MinimumNumberOfTickets>int</MinimumNumberOfTickets>
            <SortOrder>int</SortOrder>
          </TicketCategory>
        </TicketCategories>
        <Start>dateTime</Start>
        <End>dateTime</End>
        <ArenaCode>string</ArenaCode>
        <ArenaName>string</ArenaName>
        <EventIdentifier>string</EventIdentifier>
      </GetEventOccasionResult>
    </GetEventOccasionResponse>
  </soap12:Body>
</soap12:Envelope>