Salespoint Web Service

Salespoint

Click here for a complete list of operations.

SearchNonPlacement

Do a non placement search. No room configuration is supplied. The proxies returned are used to retrieve the result that should be displayed.

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

<?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>
    <SearchNonPlacement xmlns="http://api.citybreak.com/">
      <start>dateTime</start>
      <end>dateTime</end>
      <filter>
        <ProducttypeGroupIds>
          <int>int</int>
          <int>int</int>
        </ProducttypeGroupIds>
        <AnonymousRatecodes>boolean</AnonymousRatecodes>
        <FilterClassificationsIds>boolean</FilterClassificationsIds>
        <ClassificationIds>
          <ArrayOfInt>
            <int>int</int>
            <int>int</int>
          </ArrayOfInt>
          <ArrayOfInt>
            <int>int</int>
            <int>int</int>
          </ArrayOfInt>
        </ClassificationIds>
        <GeoNodeId>
          <int>int</int>
          <int>int</int>
        </GeoNodeId>
        <FilterGeoId>boolean</FilterGeoId>
        <PackageLightId>int</PackageLightId>
        <PackageLightCategoryIds>
          <int>int</int>
          <int>int</int>
        </PackageLightCategoryIds>
        <ProductGroupTypes>
          <int>int</int>
          <int>int</int>
        </ProductGroupTypes>
        <ProducttypeCategoryType>int</ProducttypeCategoryType>
        <ProducttypeIds>
          <int>int</int>
          <int>int</int>
        </ProducttypeIds>
        <ProducttypeType>
          <int>int</int>
          <int>int</int>
        </ProducttypeType>
        <IncludeMatchlessAll>boolean</IncludeMatchlessAll>
        <IncludeMatchlessPriority>boolean</IncludeMatchlessPriority>
        <Attributes>long</Attributes>
        <FilterAttributes>boolean</FilterAttributes>
        <ObjectNumber>string</ObjectNumber>
        <FirstBookableDate>dateTime</FirstBookableDate>
        <ProducttypeCategoryTypes>
          <int>int</int>
          <int>int</int>
        </ProducttypeCategoryTypes>
        <PromotionCodes>
          <string>string</string>
          <string>string</string>
        </PromotionCodes>
        <AreaDefinition>
          <Longitude>double</Longitude>
          <Latitude>double</Latitude>
          <RadiusInMeter>int</RadiusInMeter>
        </AreaDefinition>
      </filter>
      <useresellerdiscount>boolean</useresellerdiscount>
    </SearchNonPlacement>
  </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>
    <SearchNonPlacementResponse xmlns="http://api.citybreak.com/">
      <SearchNonPlacementResult>
        <SearchId>int</SearchId>
        <Products>
          <ProxyProduct>
            <Id>int</Id>
            <Name>string</Name>
            <MinPop>int</MinPop>
            <MaxPop>int</MaxPop>
            <GroupReferenceId>int</GroupReferenceId>
            <GroupReferenceDescriptionId>int</GroupReferenceDescriptionId>
            <Attributes>long</Attributes>
            <GeoReferences xsi:nil="true" />
            <Classifications xsi:nil="true" />
            <Location xsi:nil="true" />
            <ProducttypeType>int</ProducttypeType>
            <Placements xsi:nil="true" />
            <DescriptionId xsi:nil="true" />
            <TrSummary xsi:nil="true" />
            <AdditionalPackagePrice>double</AdditionalPackagePrice>
            <AdditionalPackagePriceSpecified>boolean</AdditionalPackagePriceSpecified>
            <Priority>boolean</Priority>
            <PrioritySpecified>boolean</PrioritySpecified>
          </ProxyProduct>
          <ProxyProduct>
            <Id>int</Id>
            <Name>string</Name>
            <MinPop>int</MinPop>
            <MaxPop>int</MaxPop>
            <GroupReferenceId>int</GroupReferenceId>
            <GroupReferenceDescriptionId>int</GroupReferenceDescriptionId>
            <Attributes>long</Attributes>
            <GeoReferences xsi:nil="true" />
            <Classifications xsi:nil="true" />
            <Location xsi:nil="true" />
            <ProducttypeType>int</ProducttypeType>
            <Placements xsi:nil="true" />
            <DescriptionId xsi:nil="true" />
            <TrSummary xsi:nil="true" />
            <AdditionalPackagePrice>double</AdditionalPackagePrice>
            <AdditionalPackagePriceSpecified>boolean</AdditionalPackagePriceSpecified>
            <Priority>boolean</Priority>
            <PrioritySpecified>boolean</PrioritySpecified>
          </ProxyProduct>
        </Products>
        <ProductGroups>
          <ProxyProductGroup>
            <Id>int</Id>
            <Name>string</Name>
            <Attributes>long</Attributes>
            <GeoReferences xsi:nil="true" />
            <Classifications xsi:nil="true" />
            <Location xsi:nil="true" />
            <ProducttypeGroupType>int</ProducttypeGroupType>
            <Placements xsi:nil="true" />
            <DescriptionId xsi:nil="true" />
            <Rating>int</Rating>
            <TrSummary xsi:nil="true" />
            <AdditionalPackagePrice>double</AdditionalPackagePrice>
            <AdditionalPackagePriceSpecified>boolean</AdditionalPackagePriceSpecified>
            <SellerOrganizationId>int</SellerOrganizationId>
            <Priority>boolean</Priority>
            <PrioritySpecified>boolean</PrioritySpecified>
          </ProxyProductGroup>
          <ProxyProductGroup>
            <Id>int</Id>
            <Name>string</Name>
            <Attributes>long</Attributes>
            <GeoReferences xsi:nil="true" />
            <Classifications xsi:nil="true" />
            <Location xsi:nil="true" />
            <ProducttypeGroupType>int</ProducttypeGroupType>
            <Placements xsi:nil="true" />
            <DescriptionId xsi:nil="true" />
            <Rating>int</Rating>
            <TrSummary xsi:nil="true" />
            <AdditionalPackagePrice>double</AdditionalPackagePrice>
            <AdditionalPackagePriceSpecified>boolean</AdditionalPackagePriceSpecified>
            <SellerOrganizationId>int</SellerOrganizationId>
            <Priority>boolean</Priority>
            <PrioritySpecified>boolean</PrioritySpecified>
          </ProxyProductGroup>
        </ProductGroups>
      </SearchNonPlacementResult>
    </SearchNonPlacementResponse>
  </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>
    <SearchNonPlacement xmlns="http://api.citybreak.com/">
      <start>dateTime</start>
      <end>dateTime</end>
      <filter>
        <ProducttypeGroupIds>
          <int>int</int>
          <int>int</int>
        </ProducttypeGroupIds>
        <AnonymousRatecodes>boolean</AnonymousRatecodes>
        <FilterClassificationsIds>boolean</FilterClassificationsIds>
        <ClassificationIds>
          <ArrayOfInt>
            <int>int</int>
            <int>int</int>
          </ArrayOfInt>
          <ArrayOfInt>
            <int>int</int>
            <int>int</int>
          </ArrayOfInt>
        </ClassificationIds>
        <GeoNodeId>
          <int>int</int>
          <int>int</int>
        </GeoNodeId>
        <FilterGeoId>boolean</FilterGeoId>
        <PackageLightId>int</PackageLightId>
        <PackageLightCategoryIds>
          <int>int</int>
          <int>int</int>
        </PackageLightCategoryIds>
        <ProductGroupTypes>
          <int>int</int>
          <int>int</int>
        </ProductGroupTypes>
        <ProducttypeCategoryType>int</ProducttypeCategoryType>
        <ProducttypeIds>
          <int>int</int>
          <int>int</int>
        </ProducttypeIds>
        <ProducttypeType>
          <int>int</int>
          <int>int</int>
        </ProducttypeType>
        <IncludeMatchlessAll>boolean</IncludeMatchlessAll>
        <IncludeMatchlessPriority>boolean</IncludeMatchlessPriority>
        <Attributes>long</Attributes>
        <FilterAttributes>boolean</FilterAttributes>
        <ObjectNumber>string</ObjectNumber>
        <FirstBookableDate>dateTime</FirstBookableDate>
        <ProducttypeCategoryTypes>
          <int>int</int>
          <int>int</int>
        </ProducttypeCategoryTypes>
        <PromotionCodes>
          <string>string</string>
          <string>string</string>
        </PromotionCodes>
        <AreaDefinition>
          <Longitude>double</Longitude>
          <Latitude>double</Latitude>
          <RadiusInMeter>int</RadiusInMeter>
        </AreaDefinition>
      </filter>
      <useresellerdiscount>boolean</useresellerdiscount>
    </SearchNonPlacement>
  </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>
    <SearchNonPlacementResponse xmlns="http://api.citybreak.com/">
      <SearchNonPlacementResult>
        <SearchId>int</SearchId>
        <Products>
          <ProxyProduct>
            <Id>int</Id>
            <Name>string</Name>
            <MinPop>int</MinPop>
            <MaxPop>int</MaxPop>
            <GroupReferenceId>int</GroupReferenceId>
            <GroupReferenceDescriptionId>int</GroupReferenceDescriptionId>
            <Attributes>long</Attributes>
            <GeoReferences xsi:nil="true" />
            <Classifications xsi:nil="true" />
            <Location xsi:nil="true" />
            <ProducttypeType>int</ProducttypeType>
            <Placements xsi:nil="true" />
            <DescriptionId xsi:nil="true" />
            <TrSummary xsi:nil="true" />
            <AdditionalPackagePrice>double</AdditionalPackagePrice>
            <AdditionalPackagePriceSpecified>boolean</AdditionalPackagePriceSpecified>
            <Priority>boolean</Priority>
            <PrioritySpecified>boolean</PrioritySpecified>
          </ProxyProduct>
          <ProxyProduct>
            <Id>int</Id>
            <Name>string</Name>
            <MinPop>int</MinPop>
            <MaxPop>int</MaxPop>
            <GroupReferenceId>int</GroupReferenceId>
            <GroupReferenceDescriptionId>int</GroupReferenceDescriptionId>
            <Attributes>long</Attributes>
            <GeoReferences xsi:nil="true" />
            <Classifications xsi:nil="true" />
            <Location xsi:nil="true" />
            <ProducttypeType>int</ProducttypeType>
            <Placements xsi:nil="true" />
            <DescriptionId xsi:nil="true" />
            <TrSummary xsi:nil="true" />
            <AdditionalPackagePrice>double</AdditionalPackagePrice>
            <AdditionalPackagePriceSpecified>boolean</AdditionalPackagePriceSpecified>
            <Priority>boolean</Priority>
            <PrioritySpecified>boolean</PrioritySpecified>
          </ProxyProduct>
        </Products>
        <ProductGroups>
          <ProxyProductGroup>
            <Id>int</Id>
            <Name>string</Name>
            <Attributes>long</Attributes>
            <GeoReferences xsi:nil="true" />
            <Classifications xsi:nil="true" />
            <Location xsi:nil="true" />
            <ProducttypeGroupType>int</ProducttypeGroupType>
            <Placements xsi:nil="true" />
            <DescriptionId xsi:nil="true" />
            <Rating>int</Rating>
            <TrSummary xsi:nil="true" />
            <AdditionalPackagePrice>double</AdditionalPackagePrice>
            <AdditionalPackagePriceSpecified>boolean</AdditionalPackagePriceSpecified>
            <SellerOrganizationId>int</SellerOrganizationId>
            <Priority>boolean</Priority>
            <PrioritySpecified>boolean</PrioritySpecified>
          </ProxyProductGroup>
          <ProxyProductGroup>
            <Id>int</Id>
            <Name>string</Name>
            <Attributes>long</Attributes>
            <GeoReferences xsi:nil="true" />
            <Classifications xsi:nil="true" />
            <Location xsi:nil="true" />
            <ProducttypeGroupType>int</ProducttypeGroupType>
            <Placements xsi:nil="true" />
            <DescriptionId xsi:nil="true" />
            <Rating>int</Rating>
            <TrSummary xsi:nil="true" />
            <AdditionalPackagePrice>double</AdditionalPackagePrice>
            <AdditionalPackagePriceSpecified>boolean</AdditionalPackagePriceSpecified>
            <SellerOrganizationId>int</SellerOrganizationId>
            <Priority>boolean</Priority>
            <PrioritySpecified>boolean</PrioritySpecified>
          </ProxyProductGroup>
        </ProductGroups>
      </SearchNonPlacementResult>
    </SearchNonPlacementResponse>
  </soap12:Body>
</soap12:Envelope>