API Reference

The following documentation is also available in these formats:

API Reference v1.0

/nomis-case-note/{crn}

post

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status	Description	Schema
201	Created

/appointments/{crn}

get

Parameters

Parameter	In	Type	Required
crn	path	string	true
startDate	query	string	true
endDate	query	string	true
page	query	integer	true
size	query	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "results": [ { "type": { "code": "string", "description": "string" }, "dateTime": "string", "duration": "PT30M", "staff": { "code": "string", "name": { "forename": "string", "surname": "string" }, "email": "string", "telephone": "string" }, "location": { "code": "string", "description": "string", "address": { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string" }, "telephoneNumber": "string" }, "description": "string", "outcome": { "code": "string", "description": "string" } } ], "totalElements": "integer", "totalPages": "integer", "page": "integer", "size": "integer" }	ResultSetAppointment

{
  "results": [
    {
      "type": {
        "code": "string",
        "description": "string"
      },
      "dateTime": "string",
      "duration": "PT30M",
      "staff": {
        "code": "string",
        "name": {
          "forename": "string",
          "surname": "string"
        },
        "email": "string",
        "telephone": "string"
      },
      "location": {
        "code": "string",
        "description": "string",
        "address": {
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "district": "string",
          "town": "string",
          "county": "string",
          "postcode": "string"
        },
        "telephoneNumber": "string"
      },
      "description": "string",
      "outcome": {
        "code": "string",
        "description": "string"
      }
    }
  ],
  "totalElements": "integer",
  "totalPages": "integer",
  "page": "integer",
  "size": "integer"
}

ResultSetAppointment

post

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status	Description	Schema
201	Created

/probation-cases/{nomsId}/crn

get

Parameters

Parameter	In	Type	Required	Description
nomsId	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "crn": "string" }`	CaseIdentifiers

{
  "crn": "string"
}

CaseIdentifiers

/probation-cases/{crn}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "crn": "string", "name": { "forename": "string", "surname": "string" }, "dateOfBirth": "string", "contactDetails": { "telephone": "string", "mobile": "string", "email": "string" } }`	PersonDetail

{
  "crn": "string",
  "name": {
    "forename": "string",
    "surname": "string"
  },
  "dateOfBirth": "string",
  "contactDetails": {
    "telephone": "string",
    "mobile": "string",
    "email": "string"
  }
}

PersonDetail

/probation-cases/{crn}/mappa

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "level": "integer", "levelDescription": "string", "category": "integer", "categoryDescription": "string", "startDate": "string", "reviewDate": "string" }`	MappaDetail

{
  "level": "integer",
  "levelDescription": "string",
  "category": "integer",
  "categoryDescription": "string",
  "startDate": "string",
  "reviewDate": "string"
}

MappaDetail

/probation-cases/{crn}/community-manager

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "name": { "forename": "string", "surname": "string" }, "unallocated": "boolean" }`	Manager

{
  "name": {
    "forename": "string",
    "surname": "string"
  },
  "unallocated": "boolean"
}

Manager

/duty-to-refer-nsi/{value}

get

Parameters

Parameter	In	Type	Required	Description
value	path	string	true
type	query	string	false	Available items: CRN NOMS

Parameter

Type

Required

Description

value

path

string

true

type

query

string

false

Available items:

CRN
NOMS

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "nsiSubType": "string", "referralDate": "string", "provider": "string", "team": "string", "officer": { "forename": "string", "surname": "string", "middleName": "string" }, "status": "string", "startDateTime": "string", "notes": "string", "mainAddress": { "buildingName": "string", "addressNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "noFixedAbode": "boolean" } }`	DutyToReferNSI

{
  "nsiSubType": "string",
  "referralDate": "string",
  "provider": "string",
  "team": "string",
  "officer": {
    "forename": "string",
    "surname": "string",
    "middleName": "string"
  },
  "status": "string",
  "startDateTime": "string",
  "notes": "string",
  "mainAddress": {
    "buildingName": "string",
    "addressNumber": "string",
    "streetName": "string",
    "district": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "noFixedAbode": "boolean"
  }
}

DutyToReferNSI

Schemas

Author

Name	Type	Required
prisonCode	string	true
forename	string	true
surname	string	true

CreateContact

Name	Type	Required	Description	Schema
type	string	true	Nomis contact type. Must either IMMEDIATENEEDSREPORT or PRERELEASEREPORT
description	string	false
dateTime	string	true
notes	string	true
author	object	true		Author

CreateAppointment

Name	Type	Required	Description
type	string	true
start	string	true
duration	string	true	ISO-8601 representation of the duration
notes	string	false
uuid	string	true

CaseIdentifiers

Name	Type	Required	Description	Schema
crn	string	true

ContactDetails

Name	Type	Required
telephone	string	false
mobile	string	false
email	string	false

Name

Name	Type	Required	Description	Schema
forename	string	true
surname	string	true

PersonDetail

Name	Type	Required	Schema
crn	string	true
name	object	true	Name
dateOfBirth	string	true
contactDetails	object	false	ContactDetails

MappaDetail

Name	Type	Required
level	integer	false
levelDescription	string	false
category	integer	false
categoryDescription	string	false
startDate	string	true
reviewDate	string	false

Manager

Name	Type	Required	Description	Schema
name	object	false		Name
unallocated	boolean	true

DutyToReferNSI

Name	Type	Required	Schema
nsiSubType	string	true
referralDate	string	true
provider	string	false
team	string	false
officer	object	false	Officer
status	string	true
startDateTime	string	false
notes	string	false
mainAddress	object	false	MainAddress

MainAddress

Name	Type	Required
buildingName	string	false
addressNumber	string	false
streetName	string	false
district	string	false
town	string	false
county	string	false
postcode	string	false
noFixedAbode	boolean	false

Officer

Name	Type	Required
forename	string	true
surname	string	true
middleName	string	false

Address

Name	Type	Required
buildingName	string	false
buildingNumber	string	false
streetName	string	false
district	string	false
town	string	false
county	string	false
postcode	string	false

Appointment

Name	Type	Required	Description	Schema
type	object	true		Type
dateTime	string	true
duration	string	true	ISO-8601 representation of the duration
staff	object	true		Staff
location	object	false		Location
description	string	true
outcome	object	false		Outcome

Location

Name	Type	Required	Schema
code	string	true
description	string	true
address	object	false	Address
telephoneNumber	string	false

Outcome

Name	Type	Required	Description	Schema
code	string	true
description	string	true

ResultSetAppointment

Name	Type	Required	Schema
results	array	true	Appointment
totalElements	integer	true
totalPages	integer	true
page	integer	true
size	integer	true

Staff

Name	Type	Required	Schema
code	string	true
name	object	true	Name
email	string	false
telephone	string	false

Type

Name	Type	Required	Description	Schema
code	string	true
description	string	true