Skip to content

Commit ab62223

Browse files
stevomcallisterstevomcallister
committed
Deploying to gh-pages from @ ea7710f 🚀
1 parent abab076 commit ab62223

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+171
-33791
lines changed

‎api-changes-and-versioning.html

+3
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,9 @@
225225
<li>
226226
<a href="./documentation/api/index.html#v1-hmpps-reference-data"><span>/v1/hmpps/reference-data</span></a>
227227
</li>
228+
<li>
229+
<a href="./documentation/api/index.html#v1-hmpps-id-encodedhmppsid-nomis-number"><span>/v1/hmpps/id/{encodedHmppsId}/nomis-number</span></a>
230+
</li>
228231
<li>
229232
<a href="./documentation/api/index.html#v1-hmpps-id-nomis-number-encodednomisnumber"><span>/v1/hmpps/id/nomis-number/{encodedNomisNumber}</span></a>
230233
</li>

‎authentication.html

+3
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,9 @@
225225
<li>
226226
<a href="./documentation/api/index.html#v1-hmpps-reference-data"><span>/v1/hmpps/reference-data</span></a>
227227
</li>
228+
<li>
229+
<a href="./documentation/api/index.html#v1-hmpps-id-encodedhmppsid-nomis-number"><span>/v1/hmpps/id/{encodedHmppsId}/nomis-number</span></a>
230+
</li>
228231
<li>
229232
<a href="./documentation/api/index.html#v1-hmpps-id-nomis-number-encodednomisnumber"><span>/v1/hmpps/id/nomis-number/{encodedNomisNumber}</span></a>
230233
</li>

‎documentation/adr/index.html

+3
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,9 @@
225225
<li>
226226
<a href="../../documentation/api/index.html#v1-hmpps-reference-data"><span>/v1/hmpps/reference-data</span></a>
227227
</li>
228+
<li>
229+
<a href="../../documentation/api/index.html#v1-hmpps-id-encodedhmppsid-nomis-number"><span>/v1/hmpps/id/{encodedHmppsId}/nomis-number</span></a>
230+
</li>
228231
<li>
229232
<a href="../../documentation/api/index.html#v1-hmpps-id-nomis-number-encodednomisnumber"><span>/v1/hmpps/id/nomis-number/{encodedNomisNumber}</span></a>
230233
</li>

‎documentation/api/index.html

+152
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,9 @@
225225
<li>
226226
<a href="../../documentation/api/index.html#v1-hmpps-reference-data"><span>/v1/hmpps/reference-data</span></a>
227227
</li>
228+
<li>
229+
<a href="../../documentation/api/index.html#v1-hmpps-id-encodedhmppsid-nomis-number"><span>/v1/hmpps/id/{encodedHmppsId}/nomis-number</span></a>
230+
</li>
228231
<li>
229232
<a href="../../documentation/api/index.html#v1-hmpps-id-nomis-number-encodednomisnumber"><span>/v1/hmpps/id/nomis-number/{encodedNomisNumber}</span></a>
230233
</li>
@@ -3995,6 +3998,111 @@ <h4 id="v1-hmpps-reference-data-get-responses">Responses</h4>
39953998

39963999

39974000

4001+
<h2 id="v1-hmpps-id-encodedhmppsid-nomis-number">/v1/hmpps/id/{encodedHmppsId}/nomis-number</h2>
4002+
4003+
<h3 id="v1-hmpps-id-encodedhmppsid-nomis-number-get">get</h3>
4004+
4005+
<p><em>Return NOMS number for a given hmpps Id</em></p>
4006+
4007+
4008+
<p>Accepts a HMPPS Id (hmppsId) and looks up the corresponding NOMS number.</p>
4009+
4010+
4011+
4012+
4013+
<h4 id="v1-hmpps-id-encodedhmppsid-nomis-number-get-parameters">Parameters</h4>
4014+
<table>
4015+
<thead>
4016+
<tr><th>Parameter</th><th>In</th><th>Type</th><th>Required</th><th>Description</th></tr>
4017+
</thead>
4018+
<tbody>
4019+
4020+
<tr>
4021+
<td>encodedHmppsId</td>
4022+
<td>path</td>
4023+
<td>string</td>
4024+
<td>true</td>
4025+
<td>
4026+
4027+
</td>
4028+
</tr>
4029+
4030+
</tbody>
4031+
</table>
4032+
4033+
4034+
4035+
4036+
<h4 id="v1-hmpps-id-encodedhmppsid-nomis-number-get-responses">Responses</h4>
4037+
<table>
4038+
<thead>
4039+
<tr><th>Status</th><th>Description</th><th>Schema</th></tr>
4040+
</thead>
4041+
<tbody>
4042+
4043+
<tr>
4044+
<td>200</td>
4045+
<td>
4046+
<p>OK</p>
4047+
4048+
4049+
4050+
<pre><code>{
4051+
"data": {
4052+
"nomisNumber": "string"
4053+
}
4054+
}</code></pre>
4055+
4056+
</td>
4057+
<td>
4058+
<a href='#schema-dataresponsenomisnumber'>DataResponseNomisNumber</a>
4059+
</td>
4060+
</tr>
4061+
4062+
<tr>
4063+
<td>404</td>
4064+
<td>
4065+
<p>NOMS number could not be found.</p>
4066+
4067+
4068+
4069+
<pre><code>{
4070+
"data": {
4071+
"nomisNumber": "string"
4072+
}
4073+
}</code></pre>
4074+
4075+
</td>
4076+
<td>
4077+
<a href='#schema-dataresponsenomisnumber'>DataResponseNomisNumber</a>
4078+
</td>
4079+
</tr>
4080+
4081+
<tr>
4082+
<td>400</td>
4083+
<td>
4084+
<p>Invalid hmppsId.</p>
4085+
4086+
4087+
4088+
<pre><code>{
4089+
"data": {
4090+
"nomisNumber": "string"
4091+
}
4092+
}</code></pre>
4093+
4094+
</td>
4095+
<td>
4096+
<a href='#schema-dataresponsenomisnumber'>DataResponseNomisNumber</a>
4097+
</td>
4098+
</tr>
4099+
4100+
</tbody>
4101+
</table>
4102+
4103+
4104+
4105+
39984106
<h2 id="v1-hmpps-id-nomis-number-encodednomisnumber">/v1/hmpps/id/nomis-number/{encodedNomisNumber}</h2>
39994107

40004108
<h3 id="v1-hmpps-id-nomis-number-encodednomisnumber-get">get</h3>
@@ -9638,6 +9746,50 @@ <h3 id="schema-upstreamapierror">UpstreamApiError</h3>
96389746
</tbody>
96399747
</table>
96409748

9749+
<h3 id="schema-dataresponsenomisnumber">DataResponseNomisNumber</h3>
9750+
9751+
9752+
<table class='schema-dataresponsenomisnumber'>
9753+
<thead>
9754+
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th><th>Schema</th></tr>
9755+
</thead>
9756+
<tbody>
9757+
9758+
<tr>
9759+
<td>data</td>
9760+
<td>object</td>
9761+
<td>true</td>
9762+
<td></td>
9763+
<td>
9764+
<a href='#schema-nomisnumber'>NomisNumber</a>
9765+
</td>
9766+
</tr>
9767+
9768+
</tbody>
9769+
</table>
9770+
9771+
<h3 id="schema-nomisnumber">NomisNumber</h3>
9772+
9773+
9774+
<table class='schema-nomisnumber'>
9775+
<thead>
9776+
<tr><th>Name</th><th>Type</th><th>Required</th><th>Description</th><th>Schema</th></tr>
9777+
</thead>
9778+
<tbody>
9779+
9780+
<tr>
9781+
<td>nomisNumber</td>
9782+
<td>string</td>
9783+
<td>false</td>
9784+
<td></td>
9785+
<td>
9786+
9787+
</td>
9788+
</tr>
9789+
9790+
</tbody>
9791+
</table>
9792+
96419793
<h3 id="schema-dataresponsehmppsid">DataResponseHmppsId</h3>
96429794

96439795

‎documentation/get-started/index.html

+3
Original file line numberDiff line numberDiff line change
@@ -225,6 +225,9 @@
225225
<li>
226226
<a href="../../documentation/api/index.html#v1-hmpps-reference-data"><span>/v1/hmpps/reference-data</span></a>
227227
</li>
228+
<li>
229+
<a href="../../documentation/api/index.html#v1-hmpps-id-encodedhmppsid-nomis-number"><span>/v1/hmpps/id/{encodedHmppsId}/nomis-number</span></a>
230+
</li>
228231
<li>
229232
<a href="../../documentation/api/index.html#v1-hmpps-id-nomis-number-encodednomisnumber"><span>/v1/hmpps/id/nomis-number/{encodedNomisNumber}</span></a>
230233
</li>

0 commit comments

Comments
 (0)