The following documentation is also available in these formats:
API Reference v1.0
/case-details/{crn}/{eventNumber}
get
Probation case information for the Effective Proposals Framework service
Accepts the probation identifier (CRN) and Delius Event number
and returns a data structure giving background information on the probation case
for use in the Effective Proposals Framework system. The information is used to
reduce the need for the EPF user to re-key information already held in Delius.
<p>Requires `PROBATION_API__EPF__CASE_DETAIL`.</p>
Parameters
| Parameter | In | Type | Required | Description |
|---|
| crn |
path |
string |
true |
|
| eventNumber |
path |
integer |
true |
|
Responses
| Status | Description | Schema |
|---|
| 200 |
OK
{
"nomsId": "string",
"name": {
"forename": "string",
"middleName": "string",
"surname": "string"
},
"dateOfBirth": "string",
"gender": "string",
"courtAppearance": {
"date": "string",
"court": {
"name": "string"
}
},
"sentence": {
"expectedReleaseDate": "string"
},
"responsibleProvider": {
"code": "string",
"name": "string"
},
"ogrsScore": "integer",
"rsrScore": "number",
"age": "integer",
"ageAtRelease": "integer"
}
|
CaseDetails
|
| 404 |
A case with the provided CRN does not exist in Delius.
Note: this could be the result of a merge or a deletion.
{
"nomsId": "string",
"name": {
"forename": "string",
"middleName": "string",
"surname": "string"
},
"dateOfBirth": "string",
"gender": "string",
"courtAppearance": {
"date": "string",
"court": {
"name": "string"
}
},
"sentence": {
"expectedReleaseDate": "string"
},
"responsibleProvider": {
"code": "string",
"name": "string"
},
"ogrsScore": "integer",
"rsrScore": "number",
"age": "integer",
"ageAtRelease": "integer"
}
|
CaseDetails
|
Schemas
Appearance
| Name | Type | Required | Description | Schema |
|---|
| date |
string |
true |
|
|
| court |
object |
true |
|
Court
|
CaseDetails
| Name | Type | Required | Description | Schema |
|---|
| nomsId |
string |
false |
|
|
| name |
object |
true |
|
Name
|
| dateOfBirth |
string |
true |
|
|
| gender |
string |
true |
|
|
| courtAppearance |
object |
false |
|
Appearance
|
| sentence |
object |
false |
|
Sentence
|
| responsibleProvider |
object |
false |
|
Provider
|
| ogrsScore |
integer |
false |
|
|
| rsrScore |
number |
false |
|
|
| age |
integer |
true |
|
|
| ageAtRelease |
integer |
false |
|
|
Court
| Name | Type | Required | Description | Schema |
|---|
| name |
string |
true |
|
|
Name
| Name | Type | Required | Description | Schema |
|---|
| forename |
string |
true |
|
|
| middleName |
string |
false |
|
|
| surname |
string |
true |
|
|
Provider
| Name | Type | Required | Description | Schema |
|---|
| code |
string |
true |
|
|
| name |
string |
true |
|
|
Sentence
| Name | Type | Required | Description | Schema |
|---|
| expectedReleaseDate |
string |
false |
|
|