API Reference

The following documentation is also available in these formats:

API Reference v1.0

/warning-types/{crn}/{breachNoticeId}

get

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "warningTypes": [ { "code": "string", "description": "string" } ], "sentenceTypes": [ { "code": "string", "description": "string", "conditionBeingEnforced": "string" } ], "defaultSentenceTypeCode": "string" }`	WarningTypesResponse

{
  "warningTypes": [
    {
      "code": "string",
      "description": "string"
    }
  ],
  "sentenceTypes": [
    {
      "code": "string",
      "description": "string",
      "conditionBeingEnforced": "string"
    }
  ],
  "defaultSentenceTypeCode": "string"
}

WarningTypesResponse

/warning-details/{crn}/{breachNoticeId}

get

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "breachReasons": [ { "code": "string", "description": "string" } ], "enforceableContacts": [ { "id": "integer", "datetime": "string", "description": "string", "type": { "code": "string", "description": "string" }, "outcome": { "code": "string", "description": "string" }, "notes": "string", "requirement": { "id": "integer", "type": { "code": "string", "description": "string" }, "subType": { "code": "string", "description": "string" } } } ] }`	WarningDetails

{
  "breachReasons": [
    {
      "code": "string",
      "description": "string"
    }
  ],
  "enforceableContacts": [
    {
      "id": "integer",
      "datetime": "string",
      "description": "string",
      "type": {
        "code": "string",
        "description": "string"
      },
      "outcome": {
        "code": "string",
        "description": "string"
      },
      "notes": "string",
      "requirement": {
        "id": "integer",
        "type": {
          "code": "string",
          "description": "string"
        },
        "subType": {
          "code": "string",
          "description": "string"
        }
      }
    }
  ]
}

WarningDetails

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

get

Parameters

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

Responses

Status Description Schema

200

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

{
  "crn": "string",
  "userExcluded": "boolean",
  "userRestricted": "boolean",
  "exclusionMessage": "string",
  "restrictionMessage": "string"
}

CaseAccess

/next-appointment-details/{crn}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "responsibleOfficer": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "telephoneNumber": "string" }, "futureAppointments": [ { "id": "integer", "type": { "code": "string", "description": "string" }, "datetime": "string", "description": "string", "location": { "id": "integer", "status": "string", "officeDescription": "string", "buildingName": "string", "buildingNumber": "string", "streetName": "string", "townCity": "string", "district": "string", "county": "string", "postcode": "string" }, "officer": { "code": "string", "name": { "forename": "string", "middleName": "string", "surname": "string" } } } ] }	NextAppointmentDetails

{
  "responsibleOfficer": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "telephoneNumber": "string"
  },
  "futureAppointments": [
    {
      "id": "integer",
      "type": {
        "code": "string",
        "description": "string"
      },
      "datetime": "string",
      "description": "string",
      "location": {
        "id": "integer",
        "status": "string",
        "officeDescription": "string",
        "buildingName": "string",
        "buildingNumber": "string",
        "streetName": "string",
        "townCity": "string",
        "district": "string",
        "county": "string",
        "postcode": "string"
      },
      "officer": {
        "code": "string",
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        }
      }
    }
  ]
}

NextAppointmentDetails

/docs/asyncapi

get

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/case/{breachNoticeId}

get

Parameters

Parameter	In	Type	Required	Description
breachNoticeId	path	string	true

Responses

Status Description Schema

200

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

{
  "crn": "string"
}

DocumentCrn

/basic-details/{crn}/{username}

get

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "title": "string", "name": { "forename": "string", "middleName": "string", "surname": "string" }, "addresses": [ { "id": "integer", "status": "string", "buildingName": "string", "buildingNumber": "string", "streetName": "string", "townCity": "string", "district": "string", "county": "string", "postcode": "string" } ], "replyAddresses": [ { "id": "integer", "status": "string", "officeDescription": "string", "buildingName": "string", "buildingNumber": "string", "streetName": "string", "townCity": "string", "district": "string", "county": "string", "postcode": "string" } ] }	BasicDetails

{
  "title": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "addresses": [
    {
      "id": "integer",
      "status": "string",
      "buildingName": "string",
      "buildingNumber": "string",
      "streetName": "string",
      "townCity": "string",
      "district": "string",
      "county": "string",
      "postcode": "string"
    }
  ],
  "replyAddresses": [
    {
      "id": "integer",
      "status": "string",
      "officeDescription": "string",
      "buildingName": "string",
      "buildingNumber": "string",
      "streetName": "string",
      "townCity": "string",
      "district": "string",
      "county": "string",
      "postcode": "string"
    }
  ]
}

BasicDetails

Schemas

CodedDescription

Name	Type	Required	Description	Schema
code	string	true
description	string	true

SentenceType

Name	Type	Required
code	string	true
description	string	true
conditionBeingEnforced	string	true

WarningTypesResponse

Name	Type	Required	Schema
warningTypes	array	true	CodedDescription
sentenceTypes	array	true	SentenceType
defaultSentenceTypeCode	string	true

EnforceableContact

Name	Type	Required	Schema
id	integer	true
datetime	string	true
description	string	false
type	object	true	CodedDescription
outcome	object	true	CodedDescription
notes	string	false
requirement	object	false	Requirement

Requirement

Name	Type	Required	Schema
id	integer	true
type	object	true	CodedDescription
subType	object	false	CodedDescription

WarningDetails

Name	Type	Required	Description	Schema
breachReasons	array	true		CodedDescription
enforceableContacts	array	true		EnforceableContact

CaseAccess

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

Appointment

Name	Type	Required	Schema
id	integer	true
type	object	true	CodedDescription
datetime	string	true
description	string	false
location	object	false	OfficeAddress
officer	object	true	Officer

Name

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

NextAppointmentDetails

Name	Type	Required	Description	Schema
responsibleOfficer	object	true		ResponsibleOfficer
futureAppointments	array	true		Appointment

OfficeAddress

Name	Type	Required
id	integer	true
status	string	false
officeDescription	string	false
buildingName	string	false
buildingNumber	string	false
streetName	string	false
townCity	string	false
district	string	false
county	string	false
postcode	string	false

Officer

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

ResponsibleOfficer

Name	Type	Required	Description	Schema
name	object	true		Name
telephoneNumber	string	false

DocumentCrn

Name	Type	Required	Description	Schema
crn	string	true

Address

Name	Type	Required
id	integer	true
status	string	false
buildingName	string	false
buildingNumber	string	false
streetName	string	false
townCity	string	false
district	string	false
county	string	false
postcode	string	false

BasicDetails

Name	Type	Required	Schema
title	string	false
name	object	true	Name
addresses	array	true	Address
replyAddresses	array	true	OfficeAddress