The following documentation is also available in these formats:
API Reference v1.0
/docs/asyncapi
get
Responses
| Status | Description | Schema |
|---|
| 200 |
OK
{
}
|
|
/context/{reportId}
get
Probation case information related to the pre-sentence report
Creating a pre-sentence report requires details of the relevant
probation case. This information provides context around the case and specific
details of the person’s location, offence and current circumstances. Providing
these details as a single context API enables the pre-sentence service to
remove the need to access the case record and key the information into the
Pre-Sentence service manually
Parameters
| Parameter | In | Type | Required | Description |
|---|
| reportId |
path |
string |
true |
|
Responses
| Status | Description | Schema |
|---|
| 200 |
OK
{
"crn": "string",
"name": {
"forename": "string",
"surname": "string",
"middleName": "string"
},
"dateOfBirth": "string",
"pnc": "string",
"address": {
"noFixedAbode": "boolean",
"buildingName": "string",
"addressNumber": "string",
"streetName": "string",
"town": "string",
"district": "string",
"county": "string",
"postcode": "string"
},
"mainOffence": {
"description": "string"
},
"otherOffences": [
{
"description": "string"
}
],
"court": {
"name": "string",
"localJusticeArea": {
"name": "string"
}
}
}
|
PreSentenceReportContext
|
Schemas
Address
| Name | Type | Required | Description | Schema |
|---|
| noFixedAbode |
boolean |
true |
|
|
| buildingName |
string |
false |
|
|
| addressNumber |
string |
false |
|
|
| streetName |
string |
false |
|
|
| town |
string |
false |
|
|
| district |
string |
false |
|
|
| county |
string |
false |
|
|
| postcode |
string |
false |
|
|
Court
| Name | Type | Required | Description | Schema |
|---|
| name |
string |
true |
|
|
| localJusticeArea |
object |
true |
|
LocalJusticeArea
|
LocalJusticeArea
| Name | Type | Required | Description | Schema |
|---|
| name |
string |
true |
|
|
Name
| Name | Type | Required | Description | Schema |
|---|
| forename |
string |
true |
|
|
| surname |
string |
true |
|
|
| middleName |
string |
false |
|
|
Offence
| Name | Type | Required | Description | Schema |
|---|
| description |
string |
true |
|
|
PreSentenceReportContext
| Name | Type | Required | Description | Schema |
|---|
| crn |
string |
true |
|
|
| name |
object |
true |
|
Name
|
| dateOfBirth |
string |
true |
|
|
| pnc |
string |
false |
|
|
| address |
object |
false |
|
Address
|
| mainOffence |
object |
true |
|
Offence
|
| otherOffences |
array |
false |
|
Offence
|
| court |
object |
true |
|
Court
|