API Reference

The following documentation is also available in these formats:

• OpenAPI JSON
• OpenAPI YAML
• Swagger UI

API Reference v1.0

/users/{username}/access/{crn}

get

Parameters

Parameter	In	Type	Required	Description
username	path	string	true
crn	path	string	true

Responses

Status	Description	Schema
200	OK { "crn": "string", "userExcluded": "boolean", "userRestricted": "boolean", "exclusionMessage": "string", "restrictionMessage": "string" }	CaseAccess

/tier-details/{crn}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status	Description	Schema
200	OK { "gender": "string", "currentTier": "string", "oGRSScore": "integer", "rSRScore": "number", "registrations": [ { "code": "string", "description": "string", "level": "string", "date": "string" } ], "convictions": [ { "terminationDate": "string", "sentenceTypeCode": "string", "breached": "boolean", "requirements": [ { "mainCategoryTypeCode": "string", "restrictive": "boolean" } ] } ], "previousEnforcementActivity": "boolean", "ogrsscore": "integer", "rsrscore": "number" }	TierDetails

/probation-cases

get

Responses

Status	Description	Schema
200	OK { }

/person/{crn}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status	Description	Schema
200	OK { "crn": "string", "name": { "forenames": "string", "surname": "string" } }	PersonDetails

/docs/asyncapi

get

Responses

Status	Description	Schema
200	OK { }

Schemas

CaseAccess

Name	Type	Required	Description	Schema
crn	string	true
userExcluded	boolean	true
userRestricted	boolean	true
exclusionMessage	string	false
restrictionMessage	string	false

Conviction

Name	Type	Required	Description	Schema
terminationDate	string	false
sentenceTypeCode	string	false
breached	boolean	true
requirements	array	true		Requirement

Registration

Name	Type	Required	Description	Schema
code	string	true
description	string	true
level	string	false
date	string	true

Requirement

Name	Type	Required	Description	Schema
mainCategoryTypeCode	string	true
restrictive	boolean	true

TierDetails

Name	Type	Required	Description	Schema
gender	string	true
currentTier	string	false
oGRSScore	integer	false
rSRScore	number	false
registrations	array	true		Registration
convictions	array	true		Conviction
previousEnforcementActivity	boolean	true
ogrsscore	integer	false
rsrscore	number	false

Name

Name	Type	Required	Description	Schema
forenames	string	true
surname	string	true

PersonDetails

Name	Type	Required	Description	Schema
crn	string	true
name	object	true		Name