Get Charter Availability
Returns Charter availability for a Resource for the requested date range.
Request Profile Table
Element | @Attribute |
Description/Contents |
GetCharterAvailability / GetCharterAvailabilityRequest |
Root element of message. |
ResourceID |
The Resource you want to check availability against. |
DateFrom |
Availability from this date. |
DateTo |
Availability until this date. |
Scenario:
You want to know when ResourceID 170 is available between 24/1/2020 and 1/2/2020.
Example message:
<GetCharterAvailability>
<GetCharterAvailabilityRequest>
<ResourceID>170</ResourceID>
<DateFrom>2020-01-24</DateFrom>
<DateTo>2020-02-01</DateTo>
</GetCharterAvailabilityRequest>
</GetCharterAvailability>
Response Profile Table
Element | @Attribute |
Description/Contents |
GetCharterAvailabilityResponse / GetCharterAvailabilityResult |
Root element of message. |
Availabilities |
Collection of Availability objects. |
Availability |
Object representing the availability status of the resource for a specific date. |
@Date |
Availability date. |
@Available |
Indicates if the resource is available to be booked. |
Example message:
<GetCharterAvailabilityResponse xmlns="ResLink">
<GetCharterAvailabilityResult>
<Availabilities>
<Availability Date="2020-01-24T00:00:00" Available="true"/>
<Availability Date="2020-01-25T00:00:00" Available="true"/>
<Availability Date="2020-01-26T00:00:00" Available="true"/>
<Availability Date="2020-01-27T00:00:00" Available="false"/>
<Availability Date="2020-01-28T00:00:00" Available="false"/>
<Availability Date="2020-01-29T00:00:00" Available="false"/>
<Availability Date="2020-01-30T00:00:00" Available="false"/>
<Availability Date="2020-01-31T00:00:00" Available="false"/>
<Availability Date="2020-02-01T00:00:00" Available="true"/>
</Availabilities>
</GetCharterAvailabilityResult>
</GetCharterAvailabilityResponse>