POST api/viator/availability

Determines whether an excursion is available at a specified date

Request Information

URI Parameters

None.

Body Parameters

An instance of the AvailabilityRequestDTO.

Cyberlogic.eTourism.Mappings.Viator.Dto.Availability.Request.AvailabilityRequestDTO
NameDescriptionTypeAdditional information
requestType

string

None.
data

Cyberlogic.eTourism.Mappings.Viator.Dto.Availability.Request.AvailabilityRequestData

None.

Request Formats

application/json, text/json

Sample: 
{
  "requestType": "sample string 1",
  "data": {
    "ApiKey": "sample string 1",
    "ResellerId": "sample string 2",
    "SupplierId": "sample string 3",
    "ExternalReference": "sample string 4",
    "Timestamp": "sample string 5",
    "StartDate": "sample string 6",
    "EndDate": "sample string 7",
    "DeltaOnly": "sample string 8",
    "SupplierProductCode": "sample string 9",
    "TourOptions": {
      "SupplierOptionCode": "sample string 1",
      "SupplierOptionName": "sample string 2",
      "Option": [
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Name": "sample string 1",
          "Value": "sample string 2"
        }
      ]
    },
    "AvailabilityHold": {
      "Expiry": "sample string 1"
    },
    "TravellerMix": {
      "Adult": "sample string 1",
      "Child": "sample string 2",
      "Youth": "sample string 3",
      "Infant": "sample string 4",
      "Senior": "sample string 5",
      "Total": "sample string 6"
    }
  }
}

text/html

Sample: 
{"requestType":"sample string 1","data":{"ApiKey":"sample string 1","ResellerId":"sample string 2","SupplierId":"sample string 3","ExternalReference":"sample string 4","Timestamp":"sample string 5","StartDate":"sample string 6","EndDate":"sample string 7","DeltaOnly":"sample string 8","SupplierProductCode":"sample string 9","TourOptions":{"SupplierOptionCode":"sample string 1","SupplierOptionName":"sample string 2","Option":[{"Name":"sample string 1","Value":"sample string 2"},{"Name":"sample string 1","Value":"sample string 2"}]},"AvailabilityHold":{"Expiry":"sample string 1"},"TravellerMix":{"Adult":"sample string 1","Child":"sample string 2","Youth":"sample string 3","Infant":"sample string 4","Senior":"sample string 5","Total":"sample string 6"}}}

application/xml, text/xml

Sample: 
<AvailabilityRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Viator.Dto.Availability.Request">
  <data>
    <ApiKey>sample string 1</ApiKey>
    <AvailabilityHold>
      <Expiry>sample string 1</Expiry>
    </AvailabilityHold>
    <DeltaOnly>sample string 8</DeltaOnly>
    <EndDate>sample string 7</EndDate>
    <ExternalReference>sample string 4</ExternalReference>
    <ResellerId>sample string 2</ResellerId>
    <StartDate>sample string 6</StartDate>
    <SupplierId>sample string 3</SupplierId>
    <SupplierProductCode>sample string 9</SupplierProductCode>
    <Timestamp>sample string 5</Timestamp>
    <TourOptions>
      <Option xmlns:d4p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Viator.Dto.Availability">
        <d4p1:AvailabilityOptionDTO>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:AvailabilityOptionDTO>
        <d4p1:AvailabilityOptionDTO>
          <d4p1:Name>sample string 1</d4p1:Name>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:AvailabilityOptionDTO>
      </Option>
      <SupplierOptionCode>sample string 1</SupplierOptionCode>
      <SupplierOptionName>sample string 2</SupplierOptionName>
    </TourOptions>
    <TravellerMix xmlns:d3p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Viator.Dto.Shared">
      <d3p1:Adult>sample string 1</d3p1:Adult>
      <d3p1:Child>sample string 2</d3p1:Child>
      <d3p1:Infant>sample string 4</d3p1:Infant>
      <d3p1:Senior>sample string 5</d3p1:Senior>
      <d3p1:Total>sample string 6</d3p1:Total>
      <d3p1:Youth>sample string 3</d3p1:Youth>
    </TravellerMix>
  </data>
  <requestType>sample string 1</requestType>
</AvailabilityRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An AvailabilityResponseDTO object.

Cyberlogic.eTourism.Mappings.Viator.Dto.Availability.Response.AvailabilityResponseDTO
NameDescriptionTypeAdditional information
responseType

string

None.
data

Cyberlogic.eTourism.Mappings.Viator.Dto.Availability.Response.AvailabilityResponseData

None.

Response Formats

application/json, text/json

Sample: 
{
  "responseType": "sample string 1",
  "data": {
    "ApiKey": "sample string 1",
    "ResellerId": "sample string 2",
    "SupplierId": "sample string 3",
    "ExternalReference": "sample string 4",
    "Timestamp": "sample string 5",
    "RequestStatus": {
      "Status": "sample string 1",
      "Error": {
        "ErrorCode": "sample string 1",
        "ErrorMessage": "sample string 2",
        "ErrorDetails": "sample string 3"
      }
    },
    "SupplierProductCode": "sample string 6",
    "TourAvailability": [
      {
        "Date": "sample string 1",
        "AvailabilityStatus": {
          "Status": "sample string 1"
        },
        "TourOptions": {
          "Option": [
            {
              "Name": "sample string 1",
              "Value": "sample string 2"
            },
            {
              "Name": "sample string 1",
              "Value": "sample string 2"
            }
          ]
        }
      },
      {
        "Date": "sample string 1",
        "AvailabilityStatus": {
          "Status": "sample string 1"
        },
        "TourOptions": {
          "Option": [
            {
              "Name": "sample string 1",
              "Value": "sample string 2"
            },
            {
              "Name": "sample string 1",
              "Value": "sample string 2"
            }
          ]
        }
      }
    ]
  }
}

text/html

Sample: 
{"responseType":"sample string 1","data":{"ApiKey":"sample string 1","ResellerId":"sample string 2","SupplierId":"sample string 3","ExternalReference":"sample string 4","Timestamp":"sample string 5","RequestStatus":{"Status":"sample string 1","Error":{"ErrorCode":"sample string 1","ErrorMessage":"sample string 2","ErrorDetails":"sample string 3"}},"SupplierProductCode":"sample string 6","TourAvailability":[{"Date":"sample string 1","AvailabilityStatus":{"Status":"sample string 1"},"TourOptions":{"Option":[{"Name":"sample string 1","Value":"sample string 2"},{"Name":"sample string 1","Value":"sample string 2"}]}},{"Date":"sample string 1","AvailabilityStatus":{"Status":"sample string 1"},"TourOptions":{"Option":[{"Name":"sample string 1","Value":"sample string 2"},{"Name":"sample string 1","Value":"sample string 2"}]}}]}}

application/xml, text/xml

Sample: 
<AvailabilityResponseDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Viator.Dto.Availability.Response">
  <data>
    <ApiKey>sample string 1</ApiKey>
    <ExternalReference>sample string 4</ExternalReference>
    <RequestStatus>
      <Error>
        <ErrorCode>sample string 1</ErrorCode>
        <ErrorDetails>sample string 3</ErrorDetails>
        <ErrorMessage>sample string 2</ErrorMessage>
      </Error>
      <Status>sample string 1</Status>
    </RequestStatus>
    <ResellerId>sample string 2</ResellerId>
    <SupplierId>sample string 3</SupplierId>
    <SupplierProductCode>sample string 6</SupplierProductCode>
    <Timestamp>sample string 5</Timestamp>
    <TourAvailability>
      <TourAvailability>
        <AvailabilityStatus xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Viator.Dto.Availability">
          <d5p1:Status>sample string 1</d5p1:Status>
        </AvailabilityStatus>
        <Date>sample string 1</Date>
        <TourOptions>
          <Option xmlns:d6p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Viator.Dto.Availability">
            <d6p1:AvailabilityOptionDTO>
              <d6p1:Name>sample string 1</d6p1:Name>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:AvailabilityOptionDTO>
            <d6p1:AvailabilityOptionDTO>
              <d6p1:Name>sample string 1</d6p1:Name>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:AvailabilityOptionDTO>
          </Option>
        </TourOptions>
      </TourAvailability>
      <TourAvailability>
        <AvailabilityStatus xmlns:d5p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Viator.Dto.Availability">
          <d5p1:Status>sample string 1</d5p1:Status>
        </AvailabilityStatus>
        <Date>sample string 1</Date>
        <TourOptions>
          <Option xmlns:d6p1="http://schemas.datacontract.org/2004/07/Cyberlogic.eTourism.Mappings.Viator.Dto.Availability">
            <d6p1:AvailabilityOptionDTO>
              <d6p1:Name>sample string 1</d6p1:Name>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:AvailabilityOptionDTO>
            <d6p1:AvailabilityOptionDTO>
              <d6p1:Name>sample string 1</d6p1:Name>
              <d6p1:Value>sample string 2</d6p1:Value>
            </d6p1:AvailabilityOptionDTO>
          </Option>
        </TourOptions>
      </TourAvailability>
    </TourAvailability>
  </data>
  <responseType>sample string 1</responseType>
</AvailabilityResponseDTO>