Skip to content

Adding docs for car registration endpoint #200

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.

Sign up for GitHub

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

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Adding docs for car registration endpoint #200

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a1b41d3
Adding docs for car_reg endpoint
andycastleuk Nov 5, 2024
7908e76
Merge a1b41d330f0192b9f1fa67dd0b80a7c20bc72175 into 3e8c0c899f8f237ba…
andycastleuk Nov 5, 2024
4e3ca29
Update dist
github-actions[bot] Nov 5, 2024
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
View file
Open in desktop
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-11-04T15:18:17+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-11-05T12:59: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>
175 changes: 175 additions & 0 deletions docs/hxapi/carReg/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,175 @@
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<title></title>
<meta name="description" content="">
<link rel="stylesheet" href="/css/bootstrap/bootstrap.min.css">
<link rel="stylesheet" href="/css/main.css">
<link rel="stylesheet" href="/css/syntax.css">
<link rel="stylesheet" href="/css/search.css">
<link rel="stylesheet" href="/css/tabs.css">
<link rel="icon" type="image/png" href="https://d17s4kc6349e5h.cloudfront.net/holidayextras/assets/images/favicons/favicon_32.png" sizes="32x32"/>
<link rel="icon" type="image/png" href="https://d17s4kc6349e5h.cloudfront.net/holidayextras/assets/images/favicons/favicon_196.png" sizes="196x196"/>
<link rel="icon" type="image/png" href="https://d17s4kc6349e5h.cloudfront.net/holidayextras/assets/images/favicons/favicon_96.png" sizes="96x96"/>
<link rel="icon" type="image/png" href="https://d17s4kc6349e5h.cloudfront.net/holidayextras/assets/images/favicons/favicon_16.png" sizes="16x16"/>
</head>
<body>
<nav class="navbar navbar-default navbar-fixed-top">
<div class="container">
<div class="navbar-header">
<a class="navbar-brand" href="https://www.holidayextras.co.uk/"></a>
</div>
<a class="navbar-title pull-left" href="/">
Holiday Extras API
</a>
<form class="navbar-form navbar-right" id="search-form" method="get" action="/search">
<div class="input-group input-group-lg">
<input type="text" name="query" class="form-control" id="search-box" placeholder="Search for...">
<span class="input-group-btn">
<button class="btn btn-default" type="submit">Go!</button>
</span>
</div>
</form>
</div>
</nav>


<div class="container">
<main role="main">
<div class="panel-body">
<h1 id="car-registration">Car Registration</h1>

<p>Retrieve information about a UK registered vehicle.</p>

<h3 id="url">URL</h3>

<p>/car_reg/{registration}</p>

<h3 id="method">Method</h3>

<p>GET</p>

<h3 id="parameters">Parameters</h3>

<table>
<thead>
<tr>
<th>Name</th>
<th>Format</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>registration</td>
<td>String</td>
<td>Y</td>
</tr>
<tr>
<td>key</td>
<td>String</td>
<td>Y</td>
</tr>
</tbody>
</table>

<hr />

<h2 id="examples">Examples</h2>

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

<ul class="uk-tab" data-uk-switcher="{connect:'#05a355b1-f4f7-4756-a534-1e929f66890d'}">

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

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

</ul>

<ul id="05a355b1-f4f7-4756-a534-1e929f66890d" 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/car_reg/AMS1?key=mytestkey
</code></pre></div></div>
</li>

<li>
<div class="language-plaintext highlighter-rouge"><div class="highlight"><pre class="highlight"><code>https://api.holidayextras.co.uk/v1/car_reg/AMS1.js?key=mytestkey
</code></pre></div></div>
<p>Note the <code class="language-plaintext highlighter-rouge">.js</code> extension.</p>
</li>

</ul>

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

<ul class="uk-tab" data-uk-switcher="{connect:'#afecf52b-29ea-4a63-b515-30928d82c4cf'}">

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

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

</ul>

<ul id="afecf52b-29ea-4a63-b515-30928d82c4cf" 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">Result=</span><span class="s">"OK"</span><span class="nt">&gt;</span>
<span class="nt">&lt;Registration&gt;</span>AMS1<span class="nt">&lt;/Registration&gt;</span>
<span class="nt">&lt;CarMake&gt;</span>ROLLS ROYCE<span class="nt">&lt;/CarMake&gt;</span>
<span class="nt">&lt;CarModel&gt;</span>GHOST<span class="nt">&lt;/CarModel&gt;</span>
<span class="nt">&lt;CarColour&gt;</span>BLACK<span class="nt">&lt;/CarColour&gt;</span>
<span class="nt">&lt;Source&gt;</span>D<span class="nt">&lt;/Source&gt;</span>
<span class="nt">&lt;API_Header&gt;</span>
<span class="nt">&lt;Request&gt;</span>
<span class="nt">&lt;key&gt;</span>mytestkey<span class="nt">&lt;/key&gt;</span>
<span class="nt">&lt;v&gt;</span>1<span class="nt">&lt;/v&gt;</span>
<span class="nt">&lt;/Request&gt;</span>
<span class="nt">&lt;/API_Header&gt;</span>
<span class="nt">&lt;/API_Reply&gt;</span>
</code></pre></div></div>
</li>

<li>
<div class="language-json highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="p">{</span><span class="w">
</span><span class="nl">"API_Reply"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"Registration"</span><span class="p">:</span><span class="w"> </span><span class="s2">"AMS1"</span><span class="p">,</span><span class="w">
</span><span class="nl">"CarMake"</span><span class="p">:</span><span class="w"> </span><span class="s2">"ROLLS ROYCE"</span><span class="p">,</span><span class="w">
</span><span class="nl">"CarModel"</span><span class="p">:</span><span class="w"> </span><span class="s2">"GHOST"</span><span class="p">,</span><span class="w">
</span><span class="nl">"CarColour"</span><span class="p">:</span><span class="w"> </span><span class="s2">"BLACK"</span><span class="p">,</span><span class="w">
</span><span class="nl">"Source"</span><span class="p">:</span><span class="w"> </span><span class="s2">"D"</span><span class="p">,</span><span class="w">
</span><span class="nl">"ATTRIBUTES"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"Result"</span><span class="p">:</span><span class="w"> </span><span class="s2">"OK"</span><span class="w">
</span><span class="p">},</span><span class="w">
</span><span class="nl">"API_Header"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"Request"</span><span class="p">:</span><span class="w"> </span><span class="p">{</span><span class="w">
</span><span class="nl">"key"</span><span class="p">:</span><span class="w"> </span><span class="s2">"mytestkey"</span><span class="p">,</span><span class="w">
</span><span class="nl">"v"</span><span class="p">:</span><span class="w"> </span><span class="mi">1</span><span class="p">,</span><span class="w">
</span><span class="nl">"format"</span><span class="p">:</span><span class="w"> </span><span class="s2">"js"</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span><span class="p">}</span><span class="w">
</span></code></pre></div></div>
</li>

</ul>


</div>

</main>
</div>
<script src="/js/code-snippets.js"></script>
<script src="/js/tabs.js"></script>
<!-- Google Tag Manager -->
<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':
new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],
j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=
'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);
})(window,document,'script','dataLayer','GTM-PTPVDF7');</script>
<!-- End Google Tag Manager -->
</body>
</html>
4 changes: 2 additions & 2 deletions docs/hxapi/carhire/availability/index.html
View file
Open in desktop
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:'#d7038f4f-2385-4a6a-b71c-e8ae5bacafe2'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#34dbff9f-bd2a-46dd-b8ef-db881629bad5'}">

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

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

</ul>

<ul id="d7038f4f-2385-4a6a-b71c-e8ae5bacafe2" class="uk-switcher uk-margin">
<ul id="34dbff9f-bd2a-46dd-b8ef-db881629bad5" 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
5 changes: 5 additions & 0 deletions docs/hxapi/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,11 @@ <h2 id="non-product-specific-guides">Non-Product Specific Guides</h2>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="/hxapi/carReg">Car registration</a></td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td><a href="/hxapi/upgrade">Upgrade Availability</a></td>
<td>Yes</td>
Expand Down
20 changes: 10 additions & 10 deletions docs/hxapi/parking/av/airport/index.html
View file
Open in desktop
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:'#8a7b51fa-1771-4b7d-a0ba-1a3991444ee4'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#d162e3f6-1164-4489-83ee-2708345e39f9'}">

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

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

</ul>

<ul id="8a7b51fa-1771-4b7d-a0ba-1a3991444ee4" class="uk-switcher uk-margin">
<ul id="d162e3f6-1164-4489-83ee-2708345e39f9" 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:'#922b5b61-4046-4510-b9fe-8e16f7e08d9e'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#e51ea9ef-41a2-4eb7-ba4a-d2f54fbe3ace'}">

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

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

</ul>

<ul id="922b5b61-4046-4510-b9fe-8e16f7e08d9e" class="uk-switcher uk-margin">
<ul id="e51ea9ef-41a2-4eb7-ba4a-d2f54fbe3ace" 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:'#a0ee9866-589f-4a90-a1cb-79ae7798689a'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#8cc0cec7-6b62-4ef7-aae3-8d480720818c'}">

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

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

</ul>

<ul id="a0ee9866-589f-4a90-a1cb-79ae7798689a" class="uk-switcher uk-margin">
<ul id="8cc0cec7-6b62-4ef7-aae3-8d480720818c" 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:'#9d566b11-041e-48ca-a95f-d17ebf25b1c4'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#392d373b-6d39-4aed-9904-01d3fd4dd40e'}">

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

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

</ul>

<ul id="9d566b11-041e-48ca-a95f-d17ebf25b1c4" class="uk-switcher uk-margin">
<ul id="392d373b-6d39-4aed-9904-01d3fd4dd40e" 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:'#e7803539-00a4-45ff-a3b5-163b32732398'}">
<ul class="uk-tab" data-uk-switcher="{connect:'#e6fa279b-5298-4705-a4db-65932c5827e8'}">

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

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

</ul>

<ul id="e7803539-00a4-45ff-a3b5-163b32732398" class="uk-switcher uk-margin">
<ul id="e6fa279b-5298-4705-a4db-65932c5827e8" 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
Loading