Skip to content

Commit

Permalink
Merge pull request #170 from holidayextras/filter
Browse files Browse the repository at this point in the history
Expand info for filtering
  • Loading branch information
hx-markterry authored Feb 8, 2024
2 parents c5359b8 + e3ad4b5 commit 67b17ca
Show file tree
Hide file tree
Showing 12 changed files with 161 additions and 160 deletions.
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-06T03:55:51+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-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.
</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:'#6556ad3a-e839-42bd-9b16-21c4deadb50a'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#bb77fa88-2201-4339-bd33-9eda502268da'}">

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

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

</ul>

<ul id="6556ad3a-e839-42bd-9b16-21c4deadb50a" class="uk-switcher uk-margin">
<ul id="bb77fa88-2201-4339-bd33-9eda502268da" 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
22 changes: 11 additions & 11 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:'#812fd731-4a0b-4807-90ac-58fe4dc5c785'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#206d9d11-e384-49d6-97d3-94080db4103c'}">

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

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

</ul>

<ul id="812fd731-4a0b-4807-90ac-58fe4dc5c785" class="uk-switcher uk-margin">
<ul id="206d9d11-e384-49d6-97d3-94080db4103c" 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 @@ -186,7 +186,7 @@ <h3 id="request-parameters">Request Parameters</h3>
<td>String</td>
<td>[A-Z]</td>
<td>N</td>
<td>Pass in values <code class="language-plaintext highlighter-rouge">filter=on_airport</code>, <code class="language-plaintext highlighter-rouge">filter=recommended</code> or <code class="language-plaintext highlighter-rouge">filter=meet_and_greet</code> to only show car parks meeting those criteria. You can filter by any field that comes back in the filter section of the API.</td>
<td>Pass in values <code class="language-plaintext highlighter-rouge">filter=on_airport</code>, <code class="language-plaintext highlighter-rouge">filter=recommended</code> or <code class="language-plaintext highlighter-rouge">filter=meet_and_greet</code> to only show car parks meeting those criteria. You can filter by any field that comes back in the filter section of the API. Only a single filter can be used at once.</td>
</tr>
<tr>
<td>fields</td>
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:'#13ca37c1-88d4-4248-b2cb-1d072290b566'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#c0d8046c-4aef-48d5-9e15-bb81127cb1fe'}">

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

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

</ul>

<ul id="13ca37c1-88d4-4248-b2cb-1d072290b566" class="uk-switcher uk-margin">
<ul id="c0d8046c-4aef-48d5-9e15-bb81127cb1fe" 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:'#e5eaeb09-15b7-4ca4-875d-89744b0ce2c2'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#1993e08f-cdff-4010-adb1-81ef7d681837'}">

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

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

</ul>

<ul id="e5eaeb09-15b7-4ca4-875d-89744b0ce2c2" class="uk-switcher uk-margin">
<ul id="1993e08f-cdff-4010-adb1-81ef7d681837" 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:'#b5d5c767-430f-41cd-b549-8add8dac55d9'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#a5269f79-a053-44c7-8c0f-5612baecf8bb'}">

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

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

</ul>

<ul id="b5d5c767-430f-41cd-b549-8add8dac55d9" class="uk-switcher uk-margin">
<ul id="a5269f79-a053-44c7-8c0f-5612baecf8bb" 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:'#c2214a2e-0a07-4f36-ae33-48586f6eab81'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#3f4bfca4-c50f-4e79-a7fe-c7ddf33c4801'}">

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

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

</ul>

<ul id="c2214a2e-0a07-4f36-ae33-48586f6eab81" class="uk-switcher uk-margin">
<ul id="3f4bfca4-c50f-4e79-a7fe-c7ddf33c4801" 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
2 changes: 1 addition & 1 deletion docs/hxapi/parking/av/carpark/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ <h3 id="request-parameters">Request Parameters</h3>
<td>String</td>
<td>[A-Z]</td>
<td>N</td>
<td>Pass in values <code class="language-plaintext highlighter-rouge">filter=on_airport</code>, <code class="language-plaintext highlighter-rouge">filter=recommended</code> or <code class="language-plaintext highlighter-rouge">filter=meet_and_greet</code> to only show car parks meeting those criteria. You can filter by any field that comes back in the filter section of the API.</td>
<td>Pass in values <code class="language-plaintext highlighter-rouge">filter=on_airport</code>, <code class="language-plaintext highlighter-rouge">filter=recommended</code> or <code class="language-plaintext highlighter-rouge">filter=meet_and_greet</code> to only show car parks meeting those criteria. You can filter by any field that comes back in the filter section of the API. Only a single filter can be used at once.</td>
</tr>
<tr>
<td>fields</td>
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:'#14e9fd59-8d5b-4469-8d71-ded18c7b3b69'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#2877d335-8c3c-4e89-8f71-6da6f6c9cf6e'}">

<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="14e9fd59-8d5b-4469-8d71-ded18c7b3b69" class="uk-switcher uk-margin">
<ul id="2877d335-8c3c-4e89-8f71-6da6f6c9cf6e" 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:'#35704cad-28c9-46b1-8184-9d670815d5c3'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#dd180ca5-205e-434d-8445-68d032b427a7'}">

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

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

</ul>

<ul id="35704cad-28c9-46b1-8184-9d670815d5c3" class="uk-switcher uk-margin">
<ul id="dd180ca5-205e-434d-8445-68d032b427a7" 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:'#51280b93-613e-4f6f-a399-cde114da5eec'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#3b3b97b8-c6ee-4e23-b860-61c4e5871dbc'}">

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

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

</ul>

<ul id="51280b93-613e-4f6f-a399-cde114da5eec" class="uk-switcher uk-margin">
<ul id="3b3b97b8-c6ee-4e23-b860-61c4e5871dbc" 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:'#c2580c4c-6933-4abd-9fa4-5a4bf0e71e49'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#4a14b723-5766-4567-b080-2ec64b87d3d6'}">

<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="c2580c4c-6933-4abd-9fa4-5a4bf0e71e49" class="uk-switcher uk-margin">
<ul id="4a14b723-5766-4567-b080-2ec64b87d3d6" 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:'#83be2adb-985e-43b1-8a6b-22aef3adf53b'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#f8964f0b-bd38-499c-a008-02c169029369'}">

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

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

</ul>

<ul id="83be2adb-985e-43b1-8a6b-22aef3adf53b" class="uk-switcher uk-margin">
<ul id="f8964f0b-bd38-499c-a008-02c169029369" 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:'#d2088835-06e9-4c14-b6b1-3e239e304eaa'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#38b60cb3-1f37-419a-af12-f8826beda98c'}">

<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="d2088835-06e9-4c14-b6b1-3e239e304eaa" class="uk-switcher uk-margin">
<ul id="38b60cb3-1f37-419a-af12-f8826beda98c" 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:'#61719401-25e3-4c88-b398-4bbd54763437'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#3fa3602e-0f1d-4531-ac7b-ad5c1586ef47'}">

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

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

</ul>

<ul id="61719401-25e3-4c88-b398-4bbd54763437" class="uk-switcher uk-margin">
<ul id="3fa3602e-0f1d-4531-ac7b-ad5c1586ef47" 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:'#e7929aa1-6e42-41b8-bf3b-644cbd441ac0'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#a142eff7-2520-47cc-bca0-00df6803b0e2'}">

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

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

</ul>

<ul id="e7929aa1-6e42-41b8-bf3b-644cbd441ac0" class="uk-switcher uk-margin">
<ul id="a142eff7-2520-47cc-bca0-00df6803b0e2" 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:'#1f6eb995-d715-477a-b107-a719c4f8e510'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#7290da1d-2e75-48f8-9d47-90c973a5a86f'}">

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

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

</ul>

<ul id="1f6eb995-d715-477a-b107-a719c4f8e510" class="uk-switcher uk-margin">
<ul id="7290da1d-2e75-48f8-9d47-90c973a5a86f" 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:'#4c79c565-1904-4280-8c35-957844423a3e'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#ad60a9ac-6654-4c5e-ab31-739809f830fa'}">

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

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

</ul>

<ul id="4c79c565-1904-4280-8c35-957844423a3e" class="uk-switcher uk-margin">
<ul id="ad60a9ac-6654-4c5e-ab31-739809f830fa" 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:'#d4a0cde1-7a05-4285-955d-bf246f4e79af'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#ec208639-0b23-44ae-aa7c-b23ac940b03f'}">

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

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

</ul>

<ul id="d4a0cde1-7a05-4285-955d-bf246f4e79af" class="uk-switcher uk-margin">
<ul id="ec208639-0b23-44ae-aa7c-b23ac940b03f" 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
Loading

0 comments on commit 67b17ca

Please sign in to comment.