Returns availability for trips that fit the specified request criteria, including availability numbers and rates.
| Element | @Attribute |
Description/Contents |
| GetAvailability_RQ |
Root element of message. |
| Agent |
Element indicating an agent.
To specify an agent you can just provide either the ID, or the GUID. If both are provided ResLink will make a check to see if the GUID and ID match in the database and will error if they don't. |
| @ID (optional) |
The agent ID to set up commissions and costs. |
| @GUID (optional) |
The agent GUID to set up commissions and costs. |
| RunID (optional) |
The run you want to check availability against. If this is zero the method will check availability against whatever is listed according to ResourceID. |
| ResourceID (optional) |
The boat you want to check availability against. If this is zero the method will check availability against whatever is listed in resource types. |
| NumberOfPassengers (optional) |
Restrict to the number of passengers that can be booked. Leaving at zero will get availability regardless of how many passengers. |
| PackageClassTypesOnly |
When true, only package class types will be shown. When false, all class types will be returned. |
| DateFrom |
Availability from this date. |
| DateTo |
Availability until this date. |
| ResourceTypes (optional) |
Element indicating a list of resource types, in which you want to check availability against the boats of these types. If this is not set the method will check availability against all boats. |
| ResourceTypeItem |
Element indicating a resource type. |
| @ID |
The ID of the resource type. |
| @Description (optional) |
The description of the resource type. This is ignored. |
| ResLinkClassType (optional) |
Restrict to availability for a specific ResLinkClassType |
You want to know when "SV Kiana" (resource ID of 1) is available between 03/10/2007 and 10/10/2007.
| Element | @Attribute |
Description/Contents |
| GetAvailability_RS |
Root element of message. |
| Availabilities |
Element indicating a list of availability runs. |
| Availability |
Element indicating an availability run. |
| @ID |
The ID of the run. |
| @AvailablePax |
Number of passengers that can be booked. |
| @DateStart |
Start of the run. |
| @DateEnd |
End of the run. |
| @CanBook |
Indicates if the run can be booked. |
| Resource |
Element indicating the resource of the run. |
| @ID |
The ID of the resource. |
| @Description |
The description of the resource. |
| ResourceType |
Element indicating the resource type for the resource above. |
| @ID |
The ID of the resource type. |
| @Description |
The description of the resource type. |
| Services |
Element indicating a list of services that are applicable for each passenger on the resource |
| Service |
Element indicating a service that is applicable for each passenger. Note: these services are payable on arrival at the supplier |
| @ProductCode |
Product Code for the service |
| @Description |
Service description |
| @Price |
Price of the service |
| @Currency |
Currency Code |
| RunClassTypes |
Element indicating a list of class types for the run. |
| RunClassType |
Element indicating the class type of the run. A class type can be a type of room. |
| @ClassTypeID |
The ID of the class type. |
| @AvailableCount |
Number of passengers that this class type can have. |
| @RackRate |
Rate of the class type. |
| @NetRate |
Rate of the class type minus any commission. |
| @Description |
Description of the class type. |
| @Currency |
Currency Code. |
| @IsStandyByRate |
Indicates if the effective Rate is a Standby Rate |
| @OriginalRackRate |
Original Rack Rate of the class type (for informative purposes) |
| @NetRate |
Original Net Rate of the class type (for informative purposes) |
| @AccommodationNights |
Number of accommodation nights. |
| Capacity |
Element indicating the capacity of the class type. |
| @Min |
Minimum the class type can hold. |
| @Max |
Maximum the class type can hold. |
| Rates |
Collection of Rate elements |
| Rate |
Element representing a Rate for a specified number of pax |
| @Quantity |
Number of Pax |
| @RackRate |
Rack Rate |
| @NetRate |
Net Rate |
| @Currency |
Currency Code |
| @IsStandyByRate |
Indicates if the effective Rate is a Standby Rate |
| @OriginalRackRate |
Original Rack Rate of the class type (for informative purposes) |
| @NetRate |
Original Net Rate of the class type (for informative purposes) |
| Commission |
Deprecated - use RunClassType Rates instead
Element indicating the agent's commission data for the run. |
| @Value |
How much the commission is. |
| @Type |
The commission can either be an actual monetary amount ($) or a percentage (%). |