Sphinx.Api

<back to all web services

SearchSummaryAlternativeAvailability

This service is used to search the summary alternative availability using the supplied criteria

The following routes are available for this service:
GET/{brandCode}/{programCode}/availability/summaryalternative

To override the Content-type in your clients HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SearchSummaryAlternativeAvailability HTTP/1.1 
Host: sphinx-api-v2.dev.hotelplan.co.uk 
Content-Type: application/xml
Content-Length: length

<SearchSummaryAlternativeAvailability xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Availability">
  <AppNameString xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</AppNameString>
  <Ip xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</Ip>
  <MetaData xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </MetaData>
  <RequestId xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">00000000-0000-0000-0000-000000000000</RequestId>
  <RequestUrl xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</RequestUrl>
  <Version xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</Version>
  <BrandCode xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</BrandCode>
  <Index xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</Index>
  <ProgramCode xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</ProgramCode>
  <AccommodationPropertyType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </AccommodationPropertyType>
  <AccommodationRating xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:decimal>0</d2p1:decimal>
  </AccommodationRating>
  <Adults xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</Adults>
  <BoardBasis xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </BoardBasis>
  <Children xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</Children>
  <ExtraAgeBand xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </ExtraAgeBand>
  <ExtraProductType xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </ExtraProductType>
  <FreeText xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </FreeText>
  <From xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </From>
  <FromGroup xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </FromGroup>
  <GroupField xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</GroupField>
  <HasOfferCode xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">false</HasOfferCode>
  <IncludeExtras xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">false</IncludeExtras>
  <Infants xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</Infants>
  <Key xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </Key>
  <MaxPrice xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</MaxPrice>
  <MaxSaving xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</MaxSaving>
  <MinPrice xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</MinPrice>
  <MinSaving xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</MinSaving>
  <Months xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </Months>
  <Nights xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:int>0</d2p1:int>
  </Nights>
  <Offer xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</Offer>
  <Offers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </Offers>
  <PropertyCode xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </PropertyCode>
  <RoomQuantity xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</RoomQuantity>
  <RouteKey xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</RouteKey>
  <Self xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">false</Self>
  <SingleRoom xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">false</SingleRoom>
  <SortField xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">String</SortField>
  <SortOrder xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">Default</SortOrder>
  <To xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Model" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:To>
      <d2p1:ArrivalAirport>String</d2p1:ArrivalAirport>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Region>0</d2p1:Region>
      <d2p1:Resort>0</d2p1:Resort>
      <d2p1:ResortCode>String</d2p1:ResortCode>
    </d2p1:To>
  </To>
  <ToCountries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </ToCountries>
  <ToRegions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:int>0</d2p1:int>
  </ToRegions>
  <ToResortCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:string>String</d2p1:string>
  </ToResortCodes>
  <ToResorts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:int>0</d2p1:int>
  </ToResorts>
  <When xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </When>
  <WhenWindow xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </WhenWindow>
  <Years xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:dateTime>0001-01-01T00:00:00</d2p1:dateTime>
  </Years>
  <Page xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</Page>
  <PageSize xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</PageSize>
</SearchSummaryAlternativeAvailability>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ApiSearchResultsOfSummarySearchResultEFuAOULz xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto">
  <RequestId xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">00000000-0000-0000-0000-000000000000</RequestId>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <GroupFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base" />
  <SortFields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" i:nil="true" xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base" />
  <TotalPages xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</TotalPages>
  <TotalRecords xmlns="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Dto.Base">0</TotalRecords>
  <Items xmlns:d2p1="http://schemas.datacontract.org/2004/07/Api.Sphinx.Contract.Model" i:nil="true" />
</ApiSearchResultsOfSummarySearchResultEFuAOULz>