Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update transfers/index.md #175

Open
wants to merge 22 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/feed.xml
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="/feed.xml" rel="self" type="application/atom+xml" /><link href="/" rel="alternate" type="text/html" /><updated>2024-02-08T18:41:38+00:00</updated><id>/feed.xml</id><title type="html">Holiday Extras API</title><subtitle>Documentation to give to partners who would like to integrate with our API.
<?xml version="1.0" encoding="utf-8"?><feed xmlns="http://www.w3.org/2005/Atom" ><generator uri="https://jekyllrb.com/" version="3.9.3">Jekyll</generator><link href="/feed.xml" rel="self" type="application/atom+xml" /><link href="/" rel="alternate" type="text/html" /><updated>2024-02-26T09:25:16+00:00</updated><id>/feed.xml</id><title type="html">Holiday Extras API</title><subtitle>Documentation to give to partners who would like to integrate with our API.
</subtitle></feed>
4 changes: 2 additions & 2 deletions docs/hxapi/carhire/availability/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -61,15 +61,15 @@ <h2 id="request">Request</h2>
</code></pre></div></div>

<p>Example request:</p>
<ul class="uk-tab" data-uk-switcher="{connect:'#bb77fa88-2201-4339-bd33-9eda502268da'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#4ab39f0b-6e7d-4979-89fc-8348e78da07c'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="bb77fa88-2201-4339-bd33-9eda502268da" class="uk-switcher uk-margin">
<ul id="4ab39f0b-6e7d-4979-89fc-8348e78da07c" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/v1/sandbox/carHire/products?key=1&amp;From=06NOV16&amp;ArrivalTime=1200&amp;To=13NOV&amp;DepartTime=1600&amp;PickupLocation=FL965&amp;DropoffLocation=FL965&amp;DateOfBirth=1990-10-13
Expand Down
20 changes: 10 additions & 10 deletions docs/hxapi/parking/av/airport/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -57,15 +57,15 @@ <h3 id="endpoint">Endpoint</h3>

<p>For example, for London Gatwick the endpoint is:</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#206d9d11-e384-49d6-97d3-94080db4103c'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#bf8bac53-dda1-4005-b7ff-9c7571a9368b'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="206d9d11-e384-49d6-97d3-94080db4103c" class="uk-switcher uk-margin">
<ul id="bf8bac53-dda1-4005-b7ff-9c7571a9368b" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/v1/carpark/LGW
Expand Down Expand Up @@ -452,15 +452,15 @@ <h2 id="worked-examples">Worked Examples</h2>

<h3 id="uk-products-availability-request">UK Products Availability Request</h3>

<ul class="uk-tab" data-uk-switcher="{connect:'#c0d8046c-4aef-48d5-9e15-bb81127cb1fe'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#678f2c83-8f3d-497e-8c43-1381b04dfaf0'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="c0d8046c-4aef-48d5-9e15-bb81127cb1fe" class="uk-switcher uk-margin">
<ul id="678f2c83-8f3d-497e-8c43-1381b04dfaf0" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/carpark/LGW?ABTANumber=YourABTANumber&amp;Password=YourPassword&amp;Initials=YourInitials&amp;key=YourKey&amp;token=YourToken&amp;ArrivalDate=2020-01-07&amp;ArrivalTime=1200&amp;DepartDate=2020-01-08&amp;DepartTime=1200&amp;NumberOfPax=1
Expand All @@ -479,15 +479,15 @@ <h3 id="uk-products-availability-response">UK Products Availability Response</h3

<p>NB: This is a shortened example compiled from a full availability response.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#1993e08f-cdff-4010-adb1-81ef7d681837'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#2d40202c-4b73-4670-b55e-a356eefc7193'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="1993e08f-cdff-4010-adb1-81ef7d681837" class="uk-switcher uk-margin">
<ul id="2d40202c-4b73-4670-b55e-a356eefc7193" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down Expand Up @@ -715,15 +715,15 @@ <h3 id="uk-products-availability-response">UK Products Availability Response</h3

<h3 id="european-products-availability-request">European Products Availability Request</h3>

<ul class="uk-tab" data-uk-switcher="{connect:'#a5269f79-a053-44c7-8c0f-5612baecf8bb'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#236e883a-888d-4e09-b820-376f63045a42'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="a5269f79-a053-44c7-8c0f-5612baecf8bb" class="uk-switcher uk-margin">
<ul id="236e883a-888d-4e09-b820-376f63045a42" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/carpark/MUC?ABTANumber=YourABTANumber&amp;Password=YourPassword&amp;Initials=YourInitials&amp;key=YourKey&amp;token=YourToken&amp;ArrivalDate=2017-12-01&amp;ArrivalTime=1200&amp;DepartDate=2017-12-08&amp;DepartTime=1200&amp;NumberOfPax=1&amp;System=ABG&amp;lang=en
Expand All @@ -742,15 +742,15 @@ <h3 id="european-products-availability-response">European Products Availability

<p>NB: This is a shortened example compiled from a full availability response.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#3f4bfca4-c50f-4e79-a7fe-c7ddf33c4801'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#6284469b-16b9-4188-8b06-4d8a3750e76e'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="3f4bfca4-c50f-4e79-a7fe-c7ddf33c4801" class="uk-switcher uk-margin">
<ul id="6284469b-16b9-4188-8b06-4d8a3750e76e" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down
28 changes: 14 additions & 14 deletions docs/hxapi/productlibrary/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ <h2 id="available-fields">Available Fields</h2>

<p>The available fields vary by product type. For each product type there is a recommended list of fields which should be requested to get the information required to effectively sell the product.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#2877d335-8c3c-4e89-8f71-6da6f6c9cf6e'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#3eca98a2-90df-4c68-9759-ecb7af1e6bb6'}">

<li class="uk-active"><a href="#">Parking</a></li>

Expand All @@ -105,7 +105,7 @@ <h2 id="available-fields">Available Fields</h2>

</ul>

<ul id="2877d335-8c3c-4e89-8f71-6da6f6c9cf6e" class="uk-switcher uk-margin">
<ul id="3eca98a2-90df-4c68-9759-ecb7af1e6bb6" class="uk-switcher uk-margin">

<li>
<h4 id="recommended">Recommended</h4>
Expand Down Expand Up @@ -976,7 +976,7 @@ <h3 id="example-1---default-response">Example 1 - Default Response</h3>

<h4 id="request">Request</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#dd180ca5-205e-434d-8445-68d032b427a7'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#c1f2c771-d49f-4ace-968f-e10e98cced9b'}">

<li class="uk-active"><a href="#">Live (XML)</a></li>

Expand All @@ -988,7 +988,7 @@ <h4 id="request">Request</h4>

</ul>

<ul id="dd180ca5-205e-434d-8445-68d032b427a7" class="uk-switcher uk-margin">
<ul id="c1f2c771-d49f-4ace-968f-e10e98cced9b" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/v1/product/LGW4/lite?token=000015778&amp;key=mytestkey
Expand Down Expand Up @@ -1016,15 +1016,15 @@ <h4 id="request">Request</h4>

<h4 id="response">Response</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#3b3b97b8-c6ee-4e23-b860-61c4e5871dbc'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#c9f7a46e-59fb-4d6a-8f8f-47624038dedd'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="3b3b97b8-c6ee-4e23-b860-61c4e5871dbc" class="uk-switcher uk-margin">
<ul id="c9f7a46e-59fb-4d6a-8f8f-47624038dedd" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down Expand Up @@ -1411,7 +1411,7 @@ <h3 id="example-2---restricted-field-list">Example 2 - Restricted field list</h3

<h4 id="request-1">Request</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#4a14b723-5766-4567-b080-2ec64b87d3d6'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#915d7a0e-f892-43ab-ad9a-e695819d2290'}">

<li class="uk-active"><a href="#">Live (XML)</a></li>

Expand All @@ -1423,7 +1423,7 @@ <h4 id="request-1">Request</h4>

</ul>

<ul id="4a14b723-5766-4567-b080-2ec64b87d3d6" class="uk-switcher uk-margin">
<ul id="915d7a0e-f892-43ab-ad9a-e695819d2290" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/v1/product/LGW4/lite?token=000015778&amp;key=mytestkey&amp;fields=name,longitude,latitude
Expand Down Expand Up @@ -1451,15 +1451,15 @@ <h4 id="request-1">Request</h4>

<h4 id="response-1">Response</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#f8964f0b-bd38-499c-a008-02c169029369'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#de40622e-deb7-4856-a36e-8f254dc33bf5'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="f8964f0b-bd38-499c-a008-02c169029369" class="uk-switcher uk-margin">
<ul id="de40622e-deb7-4856-a36e-8f254dc33bf5" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down Expand Up @@ -1520,7 +1520,7 @@ <h4 id="request-2">Request</h4>

<p>Requests for German products return a different set of fields. Explanation of fields not currently available.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#38b60cb3-1f37-419a-af12-f8826beda98c'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#5451688d-9690-4e72-a5ef-ba4639728a2a'}">

<li class="uk-active"><a href="#">Live (XML)</a></li>

Expand All @@ -1532,7 +1532,7 @@ <h4 id="request-2">Request</h4>

</ul>

<ul id="38b60cb3-1f37-419a-af12-f8826beda98c" class="uk-switcher uk-margin">
<ul id="5451688d-9690-4e72-a5ef-ba4639728a2a" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/v1/product/FRA0?key=mytestkey
Expand Down Expand Up @@ -1560,15 +1560,15 @@ <h4 id="request-2">Request</h4>

<h4 id="response-2">Response</h4>

<ul class="uk-tab" data-uk-switcher="{connect:'#3fa3602e-0f1d-4531-ac7b-ad5c1586ef47'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#3df168cb-57f4-4e0b-9de7-db62972d0368'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="3fa3602e-0f1d-4531-ac7b-ad5c1586ef47" class="uk-switcher uk-margin">
<ul id="3df168cb-57f4-4e0b-9de7-db62972d0368" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="cp">&lt;?xml version="1.0"?&gt;</span>
Expand Down
16 changes: 8 additions & 8 deletions docs/hxapi/transfers/av/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -847,15 +847,15 @@ <h3 id="worked-examples">Worked Examples</h3>
<h4 id="airport-to-tti">Airport to TTI</h4>
<h5 id="request">Request</h5>

<ul class="uk-tab" data-uk-switcher="{connect:'#a142eff7-2520-47cc-bca0-00df6803b0e2'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#63421323-600d-4e10-a1af-00f7895d6d86'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="a142eff7-2520-47cc-bca0-00df6803b0e2" class="uk-switcher uk-margin">
<ul id="63421323-600d-4e10-a1af-00f7895d6d86" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https:///api.holidayextras.co.uk/v1/transfers/search?ABTANumber=YourABTANumber&amp;Password=YourABTANumber&amp;Initials=YourInitials&amp;key=YourKey&amp;token=YourToken&amp;PickUp=ALC&amp;PickUpType=IATA&amp;DropOffType=TTI&amp;DropOff=10147575&amp;FromDate=2022-03-16&amp;FromTime=1115&amp;ReturnDate=2022-03-23&amp;ReturnTime=1115&amp;Adults=2&amp;OutFlight=U28605&amp;ReturnFlight=U28602
Expand All @@ -874,15 +874,15 @@ <h5 id="response">Response</h5>

<p>NB: This is a shortened example compiled from a full availability response.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#7290da1d-2e75-48f8-9d47-90c973a5a86f'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#d16a4ac0-2763-4833-9230-e1dc7fcce3f1'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="7290da1d-2e75-48f8-9d47-90c973a5a86f" class="uk-switcher uk-margin">
<ul id="d16a4ac0-2763-4833-9230-e1dc7fcce3f1" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;API_Reply</span> <span class="na">Product=</span><span class="s">"Transfers"</span> <span class="na">RequestCode=</span><span class="s">"1"</span> <span class="na">Result=</span><span class="s">"OK"</span> <span class="na">cached=</span><span class="s">"1"</span> <span class="na">expires=</span><span class="s">"2021-12-07 13:06:41"</span><span class="nt">&gt;</span>
Expand Down Expand Up @@ -1117,15 +1117,15 @@ <h5 id="response">Response</h5>

<h4 id="airport-to-postal-address">Airport to Postal Address</h4>
<h5 id="request-1">Request</h5>
<ul class="uk-tab" data-uk-switcher="{connect:'#ad60a9ac-6654-4c5e-ab31-739809f830fa'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#446d6352-0d11-46e8-90ef-386e83b0cf76'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="ad60a9ac-6654-4c5e-ab31-739809f830fa" class="uk-switcher uk-margin">
<ul id="446d6352-0d11-46e8-90ef-386e83b0cf76" class="uk-switcher uk-margin">

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https:///api.holidayextras.co.uk/v1/transfers/search?ABTANumber=YourABTANumber&amp;Password=YourABTANumber&amp;Initials=YourInitials&amp;key=YourKey&amp;token=YourToken&amp;PickUp=ALC&amp;PickUpType=IATA&amp;DropOffType=postal-address&amp;DropOffName=Hotel%20Rural%20Castillo%20De%20Biar&amp;DropOffAddress[0]=Carretera%20de%20Banyeres&amp;DropOffAddress[1]=s/n&amp;DropOffTown=%20Biar&amp;DropOffCounty=Alicante&amp;DropOffPostcode=03410&amp;DropOffCountryCode=ES&amp;DropOffLongitude=-0.76832006&amp;DropOffLatitude=38.63852215&amp;Adults=2&amp;FromDate=2022-03-16&amp;FromTime=1115&amp;ReturnDate=2022-03-23&amp;ReturnTime=1115&amp;OutFlight=U28605&amp;ReturnFlight=U28602
Expand All @@ -1144,15 +1144,15 @@ <h5 id="response-1">Response</h5>

<p>NB: This is a shortened example compiled from a full availability response.</p>

<ul class="uk-tab" data-uk-switcher="{connect:'#ec208639-0b23-44ae-aa7c-b23ac940b03f'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#6d37af47-f60d-4f05-9dfe-8d36e587096d'}">

<li class="uk-active"><a href="#">XML</a></li>

<li><a href="#">JSON</a></li>

</ul>

<ul id="ec208639-0b23-44ae-aa7c-b23ac940b03f" class="uk-switcher uk-margin">
<ul id="6d37af47-f60d-4f05-9dfe-8d36e587096d" class="uk-switcher uk-margin">

<li>
<div class="language-xml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nt">&lt;API_Reply</span> <span class="na">Product=</span><span class="s">"Transfers"</span> <span class="na">RequestCode=</span><span class="s">"1"</span> <span class="na">Result=</span><span class="s">"OK"</span> <span class="na">cached=</span><span class="s">"1"</span> <span class="na">expires=</span><span class="s">"2021-12-07 16:31:35"</span><span class="nt">&gt;</span>
Expand Down
8 changes: 8 additions & 0 deletions docs/hxapi/transfers/bkg/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,14 @@ <h3 id="endpoint">Endpoint</h3>
<p>The endpoint to use is:</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/v1/transfers/[CODE]
</code></pre></div></div>
<p>Where <code class="language-plaintext highlighter-rouge">[CODE]</code> is the product code received in the availability request of the product you want to book.</p>

<p>Here is an example for the following Availability response:</p>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>&lt;Code&gt;TBHT1169922&lt;/Code&gt;
&lt;BookingURL&gt;/transfers/TBHT1169922&lt;/BookingURL&gt;
...
</code></pre></div></div>
<p>Your Make Booking request will have the following URL: https://api.holidayextras.co.uk/v1/transfers/TBHT1169922</p>

<h3 id="request-parameters">Request Parameters</h3>

Expand Down
10 changes: 9 additions & 1 deletion docs/hxapi/transfers/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ <h2 id="transfer-endpoints">Transfer Endpoints</h2>

<p>When using the Transfer endpoints below, you will be able to search using various types of location data which will represent the transfers pickup and dropoff points. Currently, the API will accept IATA Codes, TTI Codes and Postcodes (Postcodes can be used for UK Transfers).</p>

<p>You will need a token to call the api. To get the user token use the existing endpoint: <a href="https://docs.holidayextras.co.uk/hxapi/usertoken/">Get Token</a>.</p>

<table>
<thead>
<tr>
Expand All @@ -65,10 +67,16 @@ <h2 id="transfer-endpoints">Transfer Endpoints</h2>
<td><a href="bkg">https://api.holidayextras.co.uk/v1/transfers/[TransferCode]</a></td>
<td>POST</td>
</tr>
<tr>
<td>Amend Booking</td>
<td>not supported</td>
<td>-</td>
</tr>
</tbody>
</table>

<p>To View and Cancel your existing bookings, this can be done using the generic product based <a href="/hxapi/viewamendcancel/view/">View Booking</a> and <a href="/hxapi/viewamendcancel/cancel/">Cancel Booking</a> endpoints.</p>
<p>To <strong>View</strong> and <strong>Cancel</strong> your existing bookings, this can be done using the generic product based <a href="/hxapi/viewamendcancel/view/">View Booking</a> and <a href="/hxapi/viewamendcancel/cancel/">Cancel Booking</a> endpoints.</p>


</div>

Expand Down
Loading