API Reference

The following documentation is also available in these formats:

API Reference v1.0

/secure/compare

post

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "endPointName": "string", "message": "string", "url": "string", "testExecuted": "boolean", "success": "boolean" }`	CompareReport

{
  "endPointName": "string",
  "message": "string",
  "url": "string",
  "testExecuted": "boolean",
  "success": "boolean"
}

CompareReport

/secure/compareAll

post

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "totalNumberOfCrns": "integer", "totalPages": "integer", "currentPageNumber": "integer", "totalNumberOfRequests": "integer", "numberOfSuccessfulRequests": "integer", "numberOfUnsuccessfulRequests": "integer", "unableToBeExecuted": "integer", "failureReports": [ { "endPointName": "string", "message": "string", "url": "string", "testExecuted": "boolean", "success": "boolean" } ], "endpointsCovered": [ { } ], "endpointsRequestedButNotCovered": [ { } ] }`	CompareAllReport

{
  "totalNumberOfCrns": "integer",
  "totalPages": "integer",
  "currentPageNumber": "integer",
  "totalNumberOfRequests": "integer",
  "numberOfSuccessfulRequests": "integer",
  "numberOfUnsuccessfulRequests": "integer",
  "unableToBeExecuted": "integer",
  "failureReports": [
    {
      "endPointName": "string",
      "message": "string",
      "url": "string",
      "testExecuted": "boolean",
      "success": "boolean"
    }
  ],
  "endpointsCovered": [
    {
    }
  ],
  "endpointsRequestedButNotCovered": [
    {
    }
  ]
}

CompareAllReport

/secure/offenders/crn/{crn}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/registrations

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
activeOnly	query	boolean	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/documents/{documentId}

get

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`	StreamingResponseBody

{
}

StreamingResponseBody

/secure/offenders/crn/{crn}/documents/grouped

get

Parameters

Parameter	In	Type	Required
crn	path	string	true
type	query	string	false
subtype	query	string	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
activeOnly	query	boolean	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/sentenceStatus

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/requirements

get

Parameters

Parameter	In	Type	Required
crn	path	string	true
convictionId	path	integer	true
activeOnly	query	boolean	false
excludeSoftDeleted	query	boolean	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/pssRequirements

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/nsis

get

Parameters

Parameter	In	Type	Required
crn	path	string	true
convictionId	path	integer	true
nsiCodes	query	array	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/nsis/{nsiId}

get

Parameters

Parameter	In	Type	Required
crn	path	string	true
convictionId	path	integer	true
nsiId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/licenceConditions

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/courtReports

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/courtAppearances

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/convictions/{convictionId}/attendancesFilter

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/all

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/secure/offenders/crn/{crn}/allOffenderManagers

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
includeProbationAreaTeams	query	boolean	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/probation-case/{crn}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "preferredName": "string", "activeProbationManagedSentence": "boolean", "contactDetails": { "allowSMS": "boolean", "emailAddresses": [ { } ], "phoneNumbers": [ { "number": "string", "type": "string" } ] }, "currentDisposal": "string", "currentExclusion": "boolean", "currentRestriction": "boolean", "dateOfBirth": "string", "firstName": "string", "gender": "string", "middleNames": [ { } ], "offenderId": "integer", "offenderProfile": { "genderIdentity": "string", "selfDescribedGender": "string", "disabilities": [ { "lastUpdatedDateTime": "string", "disabilityCondition": { "code": "string", "description": "string" }, "disabilityId": "integer", "disabilityType": { "code": "string", "description": "string" }, "endDate": "string", "isActive": "boolean", "notes": "string", "provisions": [ { "category": { "code": "string", "description": "string" }, "finishDate": "string", "notes": "string", "provisionId": "integer", "provisionType": { "code": "string", "description": "string" }, "startDate": "string" } ], "startDate": "string" } ], "ethnicity": "string", "immigrationStatus": "string", "nationality": "string", "notes": "string", "offenderDetails": "string", "offenderLanguages": { "languageConcerns": "string", "otherLanguages": [ { } ], "primaryLanguage": "string", "requiresInterpreter": "boolean" }, "previousConviction": { "convictionDate": "string", "detail": { } }, "provisions": [ { "category": { "code": "string", "description": "string" }, "finishDate": "string", "notes": "string", "provisionId": "integer", "provisionType": { "code": "string", "description": "string" }, "startDate": "string" } ], "religion": "string", "remandStatus": "string", "riskColour": "string", "secondaryNationality": "string", "sexualOrientation": "string" }, "otherIds": { "crn": "string", "croNumber": "string", "immigrationNumber": "string", "mostRecentPrisonerNumber": "string", "niNumber": "string", "nomsNumber": "string", "pncNumber": "string" }, "partitionArea": "string", "previousSurname": "string", "softDeleted": "boolean", "surname": "string", "title": "string" }	OffenderDetailSummary

{
  "preferredName": "string",
  "activeProbationManagedSentence": "boolean",
  "contactDetails": {
    "allowSMS": "boolean",
    "emailAddresses": [
      {
      }
    ],
    "phoneNumbers": [
      {
        "number": "string",
        "type": "string"
      }
    ]
  },
  "currentDisposal": "string",
  "currentExclusion": "boolean",
  "currentRestriction": "boolean",
  "dateOfBirth": "string",
  "firstName": "string",
  "gender": "string",
  "middleNames": [
    {
    }
  ],
  "offenderId": "integer",
  "offenderProfile": {
    "genderIdentity": "string",
    "selfDescribedGender": "string",
    "disabilities": [
      {
        "lastUpdatedDateTime": "string",
        "disabilityCondition": {
          "code": "string",
          "description": "string"
        },
        "disabilityId": "integer",
        "disabilityType": {
          "code": "string",
          "description": "string"
        },
        "endDate": "string",
        "isActive": "boolean",
        "notes": "string",
        "provisions": [
          {
            "category": {
              "code": "string",
              "description": "string"
            },
            "finishDate": "string",
            "notes": "string",
            "provisionId": "integer",
            "provisionType": {
              "code": "string",
              "description": "string"
            },
            "startDate": "string"
          }
        ],
        "startDate": "string"
      }
    ],
    "ethnicity": "string",
    "immigrationStatus": "string",
    "nationality": "string",
    "notes": "string",
    "offenderDetails": "string",
    "offenderLanguages": {
      "languageConcerns": "string",
      "otherLanguages": [
        {
        }
      ],
      "primaryLanguage": "string",
      "requiresInterpreter": "boolean"
    },
    "previousConviction": {
      "convictionDate": "string",
      "detail": {
      }
    },
    "provisions": [
      {
        "category": {
          "code": "string",
          "description": "string"
        },
        "finishDate": "string",
        "notes": "string",
        "provisionId": "integer",
        "provisionType": {
          "code": "string",
          "description": "string"
        },
        "startDate": "string"
      }
    ],
    "religion": "string",
    "remandStatus": "string",
    "riskColour": "string",
    "secondaryNationality": "string",
    "sexualOrientation": "string"
  },
  "otherIds": {
    "crn": "string",
    "croNumber": "string",
    "immigrationNumber": "string",
    "mostRecentPrisonerNumber": "string",
    "niNumber": "string",
    "nomsNumber": "string",
    "pncNumber": "string"
  },
  "partitionArea": "string",
  "previousSurname": "string",
  "softDeleted": "boolean",
  "surname": "string",
  "title": "string"
}

OffenderDetailSummary

/probation-case/{crn}/status

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "status": "string", "terminationDate": "string", "inBreach": "boolean", "preSentenceActivity": "boolean", "awaitingPsr": "boolean" }`	ProbationStatusDetail

{
  "status": "string",
  "terminationDate": "string",
  "inBreach": "boolean",
  "preSentenceActivity": "boolean",
  "awaitingPsr": "boolean"
}

ProbationStatusDetail

/probation-case/{crn}/registrations

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
activeOnly	query	boolean	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "registrations": [ { "registrationId": "integer", "offenderId": "integer", "register": { "code": "string", "description": "string" }, "type": { "code": "string", "description": "string" }, "riskColour": "string", "startDate": "string", "nextReviewDate": "string", "reviewPeriodMonths": "integer", "notes": "string", "registeringTeam": { "code": "string", "description": "string" }, "registeringOfficer": { "code": "string", "forenames": "string", "surname": "string", "unallocated": "boolean" }, "registeringProbationArea": { "code": "string", "description": "string" }, "registerLevel": { "code": "string", "description": "string" }, "registerCategory": { "code": "string", "description": "string" }, "warnUser": "boolean", "active": "boolean", "endDate": "string", "deregisteringTeam": { "code": "string", "description": "string" }, "deregisteringOfficer": { "code": "string", "forenames": "string", "surname": "string", "unallocated": "boolean" }, "deregisteringProbationArea": { "code": "string", "description": "string" }, "deregisteringNotes": "string", "numberOfPreviousDeregistrations": "integer" } ] }	Registrations

{
  "registrations": [
    {
      "registrationId": "integer",
      "offenderId": "integer",
      "register": {
        "code": "string",
        "description": "string"
      },
      "type": {
        "code": "string",
        "description": "string"
      },
      "riskColour": "string",
      "startDate": "string",
      "nextReviewDate": "string",
      "reviewPeriodMonths": "integer",
      "notes": "string",
      "registeringTeam": {
        "code": "string",
        "description": "string"
      },
      "registeringOfficer": {
        "code": "string",
        "forenames": "string",
        "surname": "string",
        "unallocated": "boolean"
      },
      "registeringProbationArea": {
        "code": "string",
        "description": "string"
      },
      "registerLevel": {
        "code": "string",
        "description": "string"
      },
      "registerCategory": {
        "code": "string",
        "description": "string"
      },
      "warnUser": "boolean",
      "active": "boolean",
      "endDate": "string",
      "deregisteringTeam": {
        "code": "string",
        "description": "string"
      },
      "deregisteringOfficer": {
        "code": "string",
        "forenames": "string",
        "surname": "string",
        "unallocated": "boolean"
      },
      "deregisteringProbationArea": {
        "code": "string",
        "description": "string"
      },
      "deregisteringNotes": "string",
      "numberOfPreviousDeregistrations": "integer"
    }
  ]
}

Registrations

/probation-case/{crn}/documents/{documentId}

get

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`	StreamingResponseBody

{
}

StreamingResponseBody

/probation-case/{crn}/documents/grouped

get

Parameters

Parameter	In	Type	Required
crn	path	string	true
type	query	string	false
subType	query	string	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "documents": [ { "id": "string", "documentName": "string", "author": "string", "type": { "code": "string", "description": "string" }, "extendedDescription": "string", "lastModifiedAt": "string", "createdAt": "string", "parentPrimaryKeyId": "integer", "subType": { "code": "string", "description": "string" }, "reportDocumentDates": { "requestedDate": "string", "requiredDate": "string", "completedDate": "string" } } ], "convictions": [ { "convictionId": "string", "documents": [ { "id": "string", "documentName": "string", "author": "string", "type": { "code": "string", "description": "string" }, "extendedDescription": "string", "lastModifiedAt": "string", "createdAt": "string", "parentPrimaryKeyId": "integer", "subType": { "code": "string", "description": "string" }, "reportDocumentDates": { "requestedDate": "string", "requiredDate": "string", "completedDate": "string" } } ] } ] }	OffenderDocuments

{
  "documents": [
    {
      "id": "string",
      "documentName": "string",
      "author": "string",
      "type": {
        "code": "string",
        "description": "string"
      },
      "extendedDescription": "string",
      "lastModifiedAt": "string",
      "createdAt": "string",
      "parentPrimaryKeyId": "integer",
      "subType": {
        "code": "string",
        "description": "string"
      },
      "reportDocumentDates": {
        "requestedDate": "string",
        "requiredDate": "string",
        "completedDate": "string"
      }
    }
  ],
  "convictions": [
    {
      "convictionId": "string",
      "documents": [
        {
          "id": "string",
          "documentName": "string",
          "author": "string",
          "type": {
            "code": "string",
            "description": "string"
          },
          "extendedDescription": "string",
          "lastModifiedAt": "string",
          "createdAt": "string",
          "parentPrimaryKeyId": "integer",
          "subType": {
            "code": "string",
            "description": "string"
          },
          "reportDocumentDates": {
            "requestedDate": "string",
            "requiredDate": "string",
            "completedDate": "string"
          }
        }
      ]
    }
  ]
}

OffenderDocuments

/probation-case/{crn}/convictions

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
activeOnly	query	boolean	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ }`

{
}

/probation-case/{crn}/convictions/{convictionId}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "convictionId": "integer", "index": "string", "active": "boolean", "inBreach": "boolean", "failureToComplyCount": "integer", "breachEnd": "string", "awaitingPsr": "boolean", "convictionDate": "string", "referralDate": "string", "offences": [ { "offenceId": "string", "mainOffence": "boolean", "detail": { "code": "string", "description": "string", "abbreviation": "string", "mainCategoryCode": "string", "mainCategoryDescription": "string", "mainCategoryAbbreviation": "string", "ogrsOffenceCategory": "string", "subCategoryCode": "string", "subCategoryDescription": "string", "form20Code": "string", "subCategoryAbbreviation": "string", "cjitCode": "string" }, "offenceDate": "string", "offenceCount": "integer", "tics": "integer", "verdict": "string", "offenderId": "integer", "createdDatetime": "string", "lastUpdatedDatetime": "string" } ], "sentence": { "sentenceId": "integer", "description": "string", "originalLength": "integer", "originalLengthUnits": "string", "secondLength": "integer", "secondLengthUnits": "string", "defaultLength": "integer", "effectiveLength": "integer", "lengthInDays": "integer", "expectedSentenceEndDate": "string", "unpaidWork": { "minutesOrdered": "integer", "minutesCompleted": "integer", "appointments": { "total": "integer", "attended": "integer", "acceptableAbsences": "integer", "unacceptableAbsences": "integer", "noOutcomeRecorded": "integer" }, "status": "string" }, "startDate": "string", "terminationDate": "string", "terminationReason": "string", "sentenceType": { "code": "string", "description": "string" }, "additionalSentences": [ { "additionalSentenceId": "integer", "type": { "code": "string", "description": "string" }, "amount": "number", "length": "integer", "notes": "string" } ], "failureToComplyLimit": "integer", "cja2003Order": "boolean", "legacyOrder": "boolean" }, "latestCourtAppearanceOutcome": { "code": "string", "description": "string" }, "custody": { "bookingNumber": "string", "institution": { "institutionId": "integer", "isEstablishment": "boolean", "code": "string", "description": "string", "institutionName": "string", "establishmentType": { "code": "string", "description": "string" }, "isPrivate": "boolean", "nomsPrisonInstitutionCode": "string" }, "keyDates": { "conditionalReleaseDate": "string", "licenceExpiryDate": "string", "hdcEligibilityDate": "string", "paroleEligibilityDate": "string", "sentenceExpiryDate": "string", "expectedReleaseDate": "string", "postSentenceSupervisionEndDate": "string", "expectedPrisonOffenderManagerHandoverStartDate": "string", "expectedPrisonOffenderManagerHandoverDate": "string" }, "status": { "code": "string", "description": "string" }, "sentenceStartDate": "string" }, "responsibleCourt": { "courtId": "integer", "code": "string", "selectable": "boolean", "courtName": "string", "telephoneNumber": "string", "fax": "string", "buildingName": "string", "street": "string", "locality": "string", "town": "string", "county": "string", "postcode": "string", "country": "string", "courtTypeId": "integer", "createdDatetime": "string", "lastUpdatedDatetime": "string", "probationAreaId": "integer", "secureEmailAddress": "string", "probationArea": { "code": "string", "description": "string" }, "courtType": { "code": "string", "description": "string" } }, "courtAppearance": { "courtAppearanceId": "integer", "appearanceDate": "string", "courtCode": "string", "courtName": "string", "appearanceType": { "code": "string", "description": "string" }, "crn": "string" }, "orderManagers": [ { "probationAreaId": "integer", "teamId": "integer", "officerId": "integer", "name": "string", "staffCode": "string", "dateStartOfAllocation": "string", "dateEndOfAllocation": "string", "gradeCode": "string", "teamCode": "string", "probationAreaCode": "string" } ] }	Conviction

{
  "convictionId": "integer",
  "index": "string",
  "active": "boolean",
  "inBreach": "boolean",
  "failureToComplyCount": "integer",
  "breachEnd": "string",
  "awaitingPsr": "boolean",
  "convictionDate": "string",
  "referralDate": "string",
  "offences": [
    {
      "offenceId": "string",
      "mainOffence": "boolean",
      "detail": {
        "code": "string",
        "description": "string",
        "abbreviation": "string",
        "mainCategoryCode": "string",
        "mainCategoryDescription": "string",
        "mainCategoryAbbreviation": "string",
        "ogrsOffenceCategory": "string",
        "subCategoryCode": "string",
        "subCategoryDescription": "string",
        "form20Code": "string",
        "subCategoryAbbreviation": "string",
        "cjitCode": "string"
      },
      "offenceDate": "string",
      "offenceCount": "integer",
      "tics": "integer",
      "verdict": "string",
      "offenderId": "integer",
      "createdDatetime": "string",
      "lastUpdatedDatetime": "string"
    }
  ],
  "sentence": {
    "sentenceId": "integer",
    "description": "string",
    "originalLength": "integer",
    "originalLengthUnits": "string",
    "secondLength": "integer",
    "secondLengthUnits": "string",
    "defaultLength": "integer",
    "effectiveLength": "integer",
    "lengthInDays": "integer",
    "expectedSentenceEndDate": "string",
    "unpaidWork": {
      "minutesOrdered": "integer",
      "minutesCompleted": "integer",
      "appointments": {
        "total": "integer",
        "attended": "integer",
        "acceptableAbsences": "integer",
        "unacceptableAbsences": "integer",
        "noOutcomeRecorded": "integer"
      },
      "status": "string"
    },
    "startDate": "string",
    "terminationDate": "string",
    "terminationReason": "string",
    "sentenceType": {
      "code": "string",
      "description": "string"
    },
    "additionalSentences": [
      {
        "additionalSentenceId": "integer",
        "type": {
          "code": "string",
          "description": "string"
        },
        "amount": "number",
        "length": "integer",
        "notes": "string"
      }
    ],
    "failureToComplyLimit": "integer",
    "cja2003Order": "boolean",
    "legacyOrder": "boolean"
  },
  "latestCourtAppearanceOutcome": {
    "code": "string",
    "description": "string"
  },
  "custody": {
    "bookingNumber": "string",
    "institution": {
      "institutionId": "integer",
      "isEstablishment": "boolean",
      "code": "string",
      "description": "string",
      "institutionName": "string",
      "establishmentType": {
        "code": "string",
        "description": "string"
      },
      "isPrivate": "boolean",
      "nomsPrisonInstitutionCode": "string"
    },
    "keyDates": {
      "conditionalReleaseDate": "string",
      "licenceExpiryDate": "string",
      "hdcEligibilityDate": "string",
      "paroleEligibilityDate": "string",
      "sentenceExpiryDate": "string",
      "expectedReleaseDate": "string",
      "postSentenceSupervisionEndDate": "string",
      "expectedPrisonOffenderManagerHandoverStartDate": "string",
      "expectedPrisonOffenderManagerHandoverDate": "string"
    },
    "status": {
      "code": "string",
      "description": "string"
    },
    "sentenceStartDate": "string"
  },
  "responsibleCourt": {
    "courtId": "integer",
    "code": "string",
    "selectable": "boolean",
    "courtName": "string",
    "telephoneNumber": "string",
    "fax": "string",
    "buildingName": "string",
    "street": "string",
    "locality": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "country": "string",
    "courtTypeId": "integer",
    "createdDatetime": "string",
    "lastUpdatedDatetime": "string",
    "probationAreaId": "integer",
    "secureEmailAddress": "string",
    "probationArea": {
      "code": "string",
      "description": "string"
    },
    "courtType": {
      "code": "string",
      "description": "string"
    }
  },
  "courtAppearance": {
    "courtAppearanceId": "integer",
    "appearanceDate": "string",
    "courtCode": "string",
    "courtName": "string",
    "appearanceType": {
      "code": "string",
      "description": "string"
    },
    "crn": "string"
  },
  "orderManagers": [
    {
      "probationAreaId": "integer",
      "teamId": "integer",
      "officerId": "integer",
      "name": "string",
      "staffCode": "string",
      "dateStartOfAllocation": "string",
      "dateEndOfAllocation": "string",
      "gradeCode": "string",
      "teamCode": "string",
      "probationAreaCode": "string"
    }
  ]
}

Conviction

/probation-case/{crn}/convictions/{convictionId}/sentenceStatus

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

{
  "sentenceId": "integer",
  "custodialType": {
    "code": "string",
    "description": "string"
  },
  "sentence": {
    "code": "string",
    "description": "string"
  },
  "mainOffence": {
    "code": "string",
    "description": "string"
  },
  "sentenceDate": "string",
  "actualReleaseDate": "string",
  "licenceExpiryDate": "string",
  "pssEndDate": "string",
  "length": "integer",
  "lengthUnit": "string"
}

SentenceStatus

/probation-case/{crn}/convictions/{convictionId}/requirements

get

Parameters

Parameter	In	Type	Required
crn	path	string	true
convictionId	path	integer	true
activeOnly	query	boolean	false
excludeSoftDeleted	query	boolean	false

Responses

Status Description Schema

200

{
  "requirements": [
    {
      "requirementId": "integer",
      "requirementNotes": "string",
      "commencementDate": "string",
      "startDate": "string",
      "terminationDate": "string",
      "expectedStartDate": "string",
      "expectedEndDate": "string",
      "createdDatetime": "string",
      "active": "boolean",
      "requirementTypeSubCategory": {
        "code": "string",
        "description": "string"
      },
      "requirementTypeMainCategory": {
        "code": "string",
        "description": "string"
      },
      "adRequirementTypeMainCategory": {
        "code": "string",
        "description": "string"
      },
      "adRequirementTypeSubCategory": {
        "code": "string",
        "description": "string"
      },
      "terminationReason": {
        "code": "string",
        "description": "string"
      },
      "length": "integer",
      "lengthUnit": "string",
      "restrictive": "boolean",
      "softDeleted": "boolean",
      "rarCount": "integer"
    }
  ]
}

ConvictionRequirements

/probation-case/{crn}/convictions/{convictionId}/pssRequirements

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

{
  "pssRequirements": [
    {
      "type": {
        "code": "string",
        "description": "string"
      },
      "subType": {
        "code": "string",
        "description": "string"
      },
      "active": "boolean"
    }
  ]
}

PssRequirements

/probation-case/{crn}/convictions/{convictionId}/nsis

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true	CRN for the offender
convictionId	path	integer	true	ID for the conviction / event
nsiCodes	query	array	true	list of NSI codes to constrain by

Responses

Status Description Schema

200

{
  "nsis": [
    {
      "nsiId": "integer",
      "nsiType": {
        "code": "string",
        "description": "string"
      },
      "nsiSubType": {
        "code": "string",
        "description": "string"
      },
      "nsiOutcome": {
        "code": "string",
        "description": "string"
      },
      "requirement": {
        "requirementId": "integer",
        "requirementNotes": "string",
        "commencementDate": "string",
        "startDate": "string",
        "terminationDate": "string",
        "expectedStartDate": "string",
        "expectedEndDate": "string",
        "createdDatetime": "string",
        "active": "boolean",
        "requirementTypeSubCategory": {
          "code": "string",
          "description": "string"
        },
        "requirementTypeMainCategory": {
          "code": "string",
          "description": "string"
        },
        "adRequirementTypeMainCategory": {
          "code": "string",
          "description": "string"
        },
        "adRequirementTypeSubCategory": {
          "code": "string",
          "description": "string"
        },
        "terminationReason": {
          "code": "string",
          "description": "string"
        },
        "length": "integer",
        "lengthUnit": "string",
        "restrictive": "boolean",
        "softDeleted": "boolean",
        "rarCount": "integer"
      },
      "nsiStatus": {
        "code": "string",
        "description": "string"
      },
      "statusDateTime": "string",
      "actualStartDate": "string",
      "expectedStartDate": "string",
      "actualEndDate": "string",
      "expectedEndDate": "string",
      "referralDate": "string",
      "length": "integer",
      "lengthUnit": "string",
      "nsiManagers": [
        {
          "probationArea": {
            "probationAreaId": "integer",
            "code": "string",
            "description": "string",
            "organisation": {
              "code": "string",
              "description": "string"
            },
            "institution": {
              "institutionId": "integer",
              "isEstablishment": "boolean",
              "code": "string",
              "description": "string",
              "institutionName": "string",
              "establishmentType": {
                "code": "string",
                "description": "string"
              },
              "isPrivate": "boolean",
              "nomsPrisonInstitutionCode": "string"
            },
            "nps": "boolean",
            "teams": [
              {
                "providerTeamId": "integer",
                "teamId": "integer",
                "code": "string",
                "description": "string",
                "name": "string",
                "isPrivate": "boolean",
                "externalProvider": {
                  "code": "string",
                  "description": "string"
                },
                "scProvider": {
                  "code": "string",
                  "description": "string"
                },
                "localDeliveryUnit": {
                  "code": "string",
                  "description": "string"
                },
                "district": {
                  "code": "string",
                  "description": "string"
                },
                "borough": {
                  "code": "string",
                  "description": "string"
                }
              }
            ]
          },
          "team": {
            "code": "string",
            "description": "string",
            "telephone": "string",
            "emailAddress": "string",
            "localDeliveryUnit": {
              "code": "string",
              "description": "string"
            },
            "district": {
              "code": "string",
              "description": "string"
            },
            "borough": {
              "code": "string",
              "description": "string"
            },
            "teamType": {
              "code": "string",
              "description": "string"
            },
            "startDate": "string",
            "endDate": "string"
          },
          "staff": {
            "username": "SheilaHancockNPS",
            "staffCode": "SH00001",
            "staffIdentifier": 123456,
            "staff": {
              "forenames": "string",
              "surname": "string"
            },
            "teams": [
              {
                "code": "string",
                "description": "string",
                "telephone": "string",
                "emailAddress": "string",
                "localDeliveryUnit": {
                  "code": "string",
                  "description": "string"
                },
                "district": {
                  "code": "string",
                  "description": "string"
                },
                "borough": {
                  "code": "string",
                  "description": "string"
                },
                "teamType": {
                  "code": "string",
                  "description": "string"
                },
                "startDate": "string",
                "endDate": "string"
              }
            ],
            "probationArea": {
              "probationAreaId": "integer",
              "code": "string",
              "description": "string",
              "organisation": {
                "code": "string",
                "description": "string"
              },
              "institution": {
                "institutionId": "integer",
                "isEstablishment": "boolean",
                "code": "string",
                "description": "string",
                "institutionName": "string",
                "establishmentType": {
                  "code": "string",
                  "description": "string"
                },
                "isPrivate": "boolean",
                "nomsPrisonInstitutionCode": "string"
              },
              "nps": "boolean",
              "teams": [
                {
                  "providerTeamId": "integer",
                  "teamId": "integer",
                  "code": "string",
                  "description": "string",
                  "name": "string",
                  "isPrivate": "boolean",
                  "externalProvider": {
                    "code": "string",
                    "description": "string"
                  },
                  "scProvider": {
                    "code": "string",
                    "description": "string"
                  },
                  "localDeliveryUnit": {
                    "code": "string",
                    "description": "string"
                  },
                  "district": {
                    "code": "string",
                    "description": "string"
                  },
                  "borough": {
                    "code": "string",
                    "description": "string"
                  }
                }
              ]
            },
            "staffGrade": {
              "code": "string",
              "description": "string"
            }
          },
          "startDate": "string",
          "endDate": "string"
        }
      ],
      "notes": "string",
      "intendedProvider": {
        "probationAreaId": "integer",
        "code": "string",
        "description": "string",
        "organisation": {
          "code": "string",
          "description": "string"
        },
        "institution": {
          "institutionId": "integer",
          "isEstablishment": "boolean",
          "code": "string",
          "description": "string",
          "institutionName": "string",
          "establishmentType": {
            "code": "string",
            "description": "string"
          },
          "isPrivate": "boolean",
          "nomsPrisonInstitutionCode": "string"
        },
        "nps": "boolean",
        "teams": [
          {
            "providerTeamId": "integer",
            "teamId": "integer",
            "code": "string",
            "description": "string",
            "name": "string",
            "isPrivate": "boolean",
            "externalProvider": {
              "code": "string",
              "description": "string"
            },
            "scProvider": {
              "code": "string",
              "description": "string"
            },
            "localDeliveryUnit": {
              "code": "string",
              "description": "string"
            },
            "district": {
              "code": "string",
              "description": "string"
            },
            "borough": {
              "code": "string",
              "description": "string"
            }
          }
        ]
      },
      "active": "boolean",
      "softDeleted": "boolean",
      "externalReference": "string",
      "recallRejectedOrWithdrawn": "boolean",
      "outcomeRecall": "boolean"
    }
  ]
}

NsiDetails

/probation-case/{crn}/convictions/{convictionId}/nsis/{nsiId}

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true	CRN for the offender
convictionId	path	integer	true	ID for the conviction / event
nsiId	path	integer	true	ID for the nsi

Responses

Status Description Schema

200

{
  "nsiId": "integer",
  "nsiType": {
    "code": "string",
    "description": "string"
  },
  "nsiSubType": {
    "code": "string",
    "description": "string"
  },
  "nsiOutcome": {
    "code": "string",
    "description": "string"
  },
  "requirement": {
    "requirementId": "integer",
    "requirementNotes": "string",
    "commencementDate": "string",
    "startDate": "string",
    "terminationDate": "string",
    "expectedStartDate": "string",
    "expectedEndDate": "string",
    "createdDatetime": "string",
    "active": "boolean",
    "requirementTypeSubCategory": {
      "code": "string",
      "description": "string"
    },
    "requirementTypeMainCategory": {
      "code": "string",
      "description": "string"
    },
    "adRequirementTypeMainCategory": {
      "code": "string",
      "description": "string"
    },
    "adRequirementTypeSubCategory": {
      "code": "string",
      "description": "string"
    },
    "terminationReason": {
      "code": "string",
      "description": "string"
    },
    "length": "integer",
    "lengthUnit": "string",
    "restrictive": "boolean",
    "softDeleted": "boolean",
    "rarCount": "integer"
  },
  "nsiStatus": {
    "code": "string",
    "description": "string"
  },
  "statusDateTime": "string",
  "actualStartDate": "string",
  "expectedStartDate": "string",
  "actualEndDate": "string",
  "expectedEndDate": "string",
  "referralDate": "string",
  "length": "integer",
  "lengthUnit": "string",
  "nsiManagers": [
    {
      "probationArea": {
        "probationAreaId": "integer",
        "code": "string",
        "description": "string",
        "organisation": {
          "code": "string",
          "description": "string"
        },
        "institution": {
          "institutionId": "integer",
          "isEstablishment": "boolean",
          "code": "string",
          "description": "string",
          "institutionName": "string",
          "establishmentType": {
            "code": "string",
            "description": "string"
          },
          "isPrivate": "boolean",
          "nomsPrisonInstitutionCode": "string"
        },
        "nps": "boolean",
        "teams": [
          {
            "providerTeamId": "integer",
            "teamId": "integer",
            "code": "string",
            "description": "string",
            "name": "string",
            "isPrivate": "boolean",
            "externalProvider": {
              "code": "string",
              "description": "string"
            },
            "scProvider": {
              "code": "string",
              "description": "string"
            },
            "localDeliveryUnit": {
              "code": "string",
              "description": "string"
            },
            "district": {
              "code": "string",
              "description": "string"
            },
            "borough": {
              "code": "string",
              "description": "string"
            }
          }
        ]
      },
      "team": {
        "code": "string",
        "description": "string",
        "telephone": "string",
        "emailAddress": "string",
        "localDeliveryUnit": {
          "code": "string",
          "description": "string"
        },
        "district": {
          "code": "string",
          "description": "string"
        },
        "borough": {
          "code": "string",
          "description": "string"
        },
        "teamType": {
          "code": "string",
          "description": "string"
        },
        "startDate": "string",
        "endDate": "string"
      },
      "staff": {
        "username": "SheilaHancockNPS",
        "staffCode": "SH00001",
        "staffIdentifier": 123456,
        "staff": {
          "forenames": "string",
          "surname": "string"
        },
        "teams": [
          {
            "code": "string",
            "description": "string",
            "telephone": "string",
            "emailAddress": "string",
            "localDeliveryUnit": {
              "code": "string",
              "description": "string"
            },
            "district": {
              "code": "string",
              "description": "string"
            },
            "borough": {
              "code": "string",
              "description": "string"
            },
            "teamType": {
              "code": "string",
              "description": "string"
            },
            "startDate": "string",
            "endDate": "string"
          }
        ],
        "probationArea": {
          "probationAreaId": "integer",
          "code": "string",
          "description": "string",
          "organisation": {
            "code": "string",
            "description": "string"
          },
          "institution": {
            "institutionId": "integer",
            "isEstablishment": "boolean",
            "code": "string",
            "description": "string",
            "institutionName": "string",
            "establishmentType": {
              "code": "string",
              "description": "string"
            },
            "isPrivate": "boolean",
            "nomsPrisonInstitutionCode": "string"
          },
          "nps": "boolean",
          "teams": [
            {
              "providerTeamId": "integer",
              "teamId": "integer",
              "code": "string",
              "description": "string",
              "name": "string",
              "isPrivate": "boolean",
              "externalProvider": {
                "code": "string",
                "description": "string"
              },
              "scProvider": {
                "code": "string",
                "description": "string"
              },
              "localDeliveryUnit": {
                "code": "string",
                "description": "string"
              },
              "district": {
                "code": "string",
                "description": "string"
              },
              "borough": {
                "code": "string",
                "description": "string"
              }
            }
          ]
        },
        "staffGrade": {
          "code": "string",
          "description": "string"
        }
      },
      "startDate": "string",
      "endDate": "string"
    }
  ],
  "notes": "string",
  "intendedProvider": {
    "probationAreaId": "integer",
    "code": "string",
    "description": "string",
    "organisation": {
      "code": "string",
      "description": "string"
    },
    "institution": {
      "institutionId": "integer",
      "isEstablishment": "boolean",
      "code": "string",
      "description": "string",
      "institutionName": "string",
      "establishmentType": {
        "code": "string",
        "description": "string"
      },
      "isPrivate": "boolean",
      "nomsPrisonInstitutionCode": "string"
    },
    "nps": "boolean",
    "teams": [
      {
        "providerTeamId": "integer",
        "teamId": "integer",
        "code": "string",
        "description": "string",
        "name": "string",
        "isPrivate": "boolean",
        "externalProvider": {
          "code": "string",
          "description": "string"
        },
        "scProvider": {
          "code": "string",
          "description": "string"
        },
        "localDeliveryUnit": {
          "code": "string",
          "description": "string"
        },
        "district": {
          "code": "string",
          "description": "string"
        },
        "borough": {
          "code": "string",
          "description": "string"
        }
      }
    ]
  },
  "active": "boolean",
  "softDeleted": "boolean",
  "externalReference": "string",
  "recallRejectedOrWithdrawn": "boolean",
  "outcomeRecall": "boolean"
}

Nsi

/probation-case/{crn}/convictions/{convictionId}/licenceConditions

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

{
  "licenceConditions": [
    {
      "licenceConditionNotes": "string",
      "startDate": "string",
      "commencementDate": "string",
      "commencementNotes": "string",
      "terminationDate": "string",
      "terminationNotes": "string",
      "createdDateTime": "string",
      "active": "boolean",
      "licenceConditionTypeMainCat": {
        "code": "string",
        "description": "string"
      },
      "licenceConditionTypeSubCat": {
        "code": "string",
        "description": "string"
      }
    }
  ]
}

LicenceConditions

/probation-case/{crn}/convictions/{convictionId}/courtReports

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

{
}

/probation-case/{crn}/convictions/{convictionId}/courtAppearances

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

{
  "courtAppearances": [
    {
      "courtAppearanceId": "integer",
      "appearanceDate": "string",
      "courtCode": "string",
      "courtName": "string",
      "appearanceType": {
        "code": "string",
        "description": "string"
      },
      "crn": "string"
    }
  ]
}

CourtAppearanceBasicWrapper

/probation-case/{crn}/convictions/{convictionId}/attendancesFilter

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
convictionId	path	integer	true

Responses

Status Description Schema

200

{
  "attendances": [
    {
      "attended": "boolean",
      "complied": "boolean",
      "attendanceDate": "string",
      "contactId": "integer",
      "outcome": "string",
      "contactType": {
        "code": "string",
        "description": "string"
      }
    }
  ]
}

Attendances

/probation-case/{crn}/all

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

{
  "preferredName": "string",
  "activeProbationManagedSentence": "boolean",
  "contactDetails": {
    "allowSMS": "boolean",
    "emailAddresses": [
      {
      }
    ],
    "phoneNumbers": [
      {
        "number": "string",
        "type": "string"
      }
    ],
    "addresses": [
      {
        "from": "string",
        "to": "string",
        "noFixedAbode": "boolean",
        "notes": "string",
        "addressNumber": "string",
        "buildingName": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string",
        "telephoneNumber": "string",
        "status": {
          "code": "string",
          "description": "string"
        },
        "type": {
          "code": "string",
          "description": "string"
        },
        "typeVerified": "boolean",
        "latestAssessmentDate": "string",
        "createdDatetime": "string",
        "lastUpdatedDatetime": "string"
      }
    ]
  },
  "currentDisposal": "string",
  "currentExclusion": "boolean",
  "exclusionMessage": "string",
  "currentRestriction": "boolean",
  "restrictionMessage": "string",
  "dateOfBirth": "string",
  "firstName": "string",
  "gender": "string",
  "middleNames": [
    {
    }
  ],
  "offenderId": "integer",
  "offenderProfile": {
    "genderIdentity": "string",
    "selfDescribedGender": "string",
    "disabilities": [
      {
        "lastUpdatedDateTime": "string",
        "disabilityCondition": {
          "code": "string",
          "description": "string"
        },
        "disabilityId": "integer",
        "disabilityType": {
          "code": "string",
          "description": "string"
        },
        "endDate": "string",
        "isActive": "boolean",
        "notes": "string",
        "provisions": [
          {
            "category": {
              "code": "string",
              "description": "string"
            },
            "finishDate": "string",
            "notes": "string",
            "provisionId": "integer",
            "provisionType": {
              "code": "string",
              "description": "string"
            },
            "startDate": "string"
          }
        ],
        "startDate": "string"
      }
    ],
    "ethnicity": "string",
    "immigrationStatus": "string",
    "nationality": "string",
    "notes": "string",
    "offenderDetails": "string",
    "offenderLanguages": {
      "languageConcerns": "string",
      "otherLanguages": [
        {
        }
      ],
      "primaryLanguage": "string",
      "requiresInterpreter": "boolean"
    },
    "previousConviction": {
      "convictionDate": "string",
      "detail": {
      }
    },
    "provisions": [
      {
        "category": {
          "code": "string",
          "description": "string"
        },
        "finishDate": "string",
        "notes": "string",
        "provisionId": "integer",
        "provisionType": {
          "code": "string",
          "description": "string"
        },
        "startDate": "string"
      }
    ],
    "religion": "string",
    "remandStatus": "string",
    "riskColour": "string",
    "secondaryNationality": "string",
    "sexualOrientation": "string"
  },
  "offenderAliases": [
    {
      "id": "string",
      "dateOfBirth": "string",
      "firstName": "string",
      "middleNames": [
        {
        }
      ],
      "surname": "string",
      "gender": "string"
    }
  ],
  "offenderManagers": [
    {
      "trustOfficer": {
        "forenames": "string",
        "surname": "string"
      },
      "staff": {
        "code": "string",
        "forenames": "string",
        "surname": "string",
        "unallocated": "boolean"
      },
      "providerEmployee": {
        "forenames": "string",
        "surname": "string"
      },
      "partitionArea": "string",
      "softDeleted": "boolean",
      "team": {
        "code": "string",
        "description": "string",
        "telephone": "string",
        "emailAddress": "string",
        "localDeliveryUnit": {
          "code": "string",
          "description": "string"
        },
        "district": {
          "code": "string",
          "description": "string"
        },
        "borough": {
          "code": "string",
          "description": "string"
        },
        "teamType": {
          "code": "string",
          "description": "string"
        },
        "startDate": "string",
        "endDate": "string"
      },
      "probationArea": {
        "probationAreaId": "integer",
        "code": "string",
        "description": "string",
        "organisation": {
          "code": "string",
          "description": "string"
        },
        "institution": {
          "institutionId": "integer",
          "isEstablishment": "boolean",
          "code": "string",
          "description": "string",
          "institutionName": "string",
          "establishmentType": {
            "code": "string",
            "description": "string"
          },
          "isPrivate": "boolean",
          "nomsPrisonInstitutionCode": "string"
        },
        "nps": "boolean",
        "teams": [
          {
            "providerTeamId": "integer",
            "teamId": "integer",
            "code": "string",
            "description": "string",
            "name": "string",
            "isPrivate": "boolean",
            "externalProvider": {
              "code": "string",
              "description": "string"
            },
            "scProvider": {
              "code": "string",
              "description": "string"
            },
            "localDeliveryUnit": {
              "code": "string",
              "description": "string"
            },
            "district": {
              "code": "string",
              "description": "string"
            },
            "borough": {
              "code": "string",
              "description": "string"
            }
          }
        ]
      },
      "fromDate": "string",
      "toDate": "string",
      "active": "boolean",
      "allocationReason": {
        "code": "string",
        "description": "string"
      }
    }
  ],
  "otherIds": {
    "crn": "string",
    "croNumber": "string",
    "immigrationNumber": "string",
    "mostRecentPrisonerNumber": "string",
    "niNumber": "string",
    "nomsNumber": "string",
    "pncNumber": "string"
  },
  "partitionArea": "string",
  "currentTier": "string",
  "previousSurname": "string",
  "softDeleted": "boolean",
  "surname": "string",
  "title": "string"
}

OffenderDetail

/probation-case/{crn}/allOffenderManagers

get

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true
includeProbationAreaTeams	query	boolean	false

Responses

Status Description Schema

200

{
}

/docs/asyncapi

get

Responses

Status Description Schema

200

{
}

Schemas

Compare

Name	Type	Required	Description	Schema
params	object	true
uri	string	true

CompareReport

Name	Type	Required
endPointName	string	true
message	string	true
url	string	false
testExecuted	boolean	false
success	boolean	true

CompareAll

Name	Type	Required
crns	array	false
uriConfig	object	true
pageNumber	integer	true
pageSize	integer	true

CompareAllReport

Name	Type	Required	Schema
totalNumberOfCrns	integer	true
totalPages	integer	true
currentPageNumber	integer	true
totalNumberOfRequests	integer	true
numberOfSuccessfulRequests	integer	true
numberOfUnsuccessfulRequests	integer	true
unableToBeExecuted	integer	true
failureReports	array	true	CompareReport
endpointsCovered	array	true
endpointsRequestedButNotCovered	array	true

StreamingResponseBody

ContactDetailsSummary

Name	Type	Required	Schema
allowSMS	boolean	false
emailAddresses	array	false
phoneNumbers	array	false	PhoneNumber

Disability

Name	Type	Required	Schema
lastUpdatedDateTime	string	true
disabilityCondition	object	false	KeyValue
disabilityId	integer	true
disabilityType	object	true	KeyValue
endDate	string	false
isActive	boolean	true
notes	string	false
provisions	array	false	Provision
startDate	string	true

KeyValue

Name	Type	Required	Description	Schema
code	string	false
description	string	true

OffenderDetailSummary

Name	Type	Required	Schema
preferredName	string	false
activeProbationManagedSentence	boolean	true
contactDetails	object	true	ContactDetailsSummary
currentDisposal	string	true
currentExclusion	boolean	true
currentRestriction	boolean	true
dateOfBirth	string	true
firstName	string	true
gender	string	true
middleNames	array	false
offenderId	integer	true
offenderProfile	object	true	OffenderProfile
otherIds	object	true	OtherIds
partitionArea	string	true
previousSurname	string	false
softDeleted	boolean	true
surname	string	true
title	string	false

OffenderLanguages

Name	Type	Required
languageConcerns	string	false
otherLanguages	array	false
primaryLanguage	string	false
requiresInterpreter	boolean	false

OffenderProfile

Name	Type	Required	Schema
genderIdentity	string	false
selfDescribedGender	string	false
disabilities	array	false	Disability
ethnicity	string	false
immigrationStatus	string	false
nationality	string	false
notes	string	false
offenderDetails	string	false
offenderLanguages	object	true	OffenderLanguages
previousConviction	object	true	PreviousConviction
provisions	array	false	Provision
religion	string	false
remandStatus	string	false
riskColour	string	false
secondaryNationality	string	false
sexualOrientation	string	false

OtherIds

Name	Type	Required
crn	string	true
croNumber	string	false
immigrationNumber	string	false
mostRecentPrisonerNumber	string	false
niNumber	string	false
nomsNumber	string	false
pncNumber	string	false

PhoneNumber

Name	Type	Required	Description	Schema
number	string	false
type	string	true

PreviousConviction

Name	Type	Required	Description	Schema
convictionDate	string	false
detail	object	false

Provision

Name	Type	Required	Schema
category	object	false	KeyValue
finishDate	string	false
notes	string	false
provisionId	integer	true
provisionType	object	true	KeyValue
startDate	string	true

ProbationStatusDetail

Name	Type	Required
status	string	true
terminationDate	string	false
inBreach	boolean	true
preSentenceActivity	boolean	true
awaitingPsr	boolean	true

Registration

Name	Type	Required	Schema
registrationId	integer	false
offenderId	integer	false
register	object	false	KeyValue
type	object	false	KeyValue
riskColour	string	false
startDate	string	false
nextReviewDate	string	false
reviewPeriodMonths	integer	false
notes	string	false
registeringTeam	object	false	KeyValue
registeringOfficer	object	false	StaffHuman
registeringProbationArea	object	false	KeyValue
registerLevel	object	false	KeyValue
registerCategory	object	false	KeyValue
warnUser	boolean	true
active	boolean	true
endDate	string	false
deregisteringTeam	object	false	KeyValue
deregisteringOfficer	object	false	StaffHuman
deregisteringProbationArea	object	false	KeyValue
deregisteringNotes	string	false
numberOfPreviousDeregistrations	integer	true

Registrations

Name	Type	Required	Description	Schema
registrations	array	false		Registration

StaffHuman

Name	Type	Required
code	string	true
forenames	string	true
surname	string	true
unallocated	boolean	false

ConvictionDocuments

Name	Type	Required	Description	Schema
convictionId	string	true
documents	array	true		OffenderDocumentDetail

OffenderDocumentDetail

Name	Type	Required	Schema
id	string	false
documentName	string	false
author	string	false
type	object	true	KeyValue
extendedDescription	string	false
lastModifiedAt	string	false
createdAt	string	false
parentPrimaryKeyId	integer	false
subType	object	false	KeyValue
reportDocumentDates	object	false	ReportDocumentDates

OffenderDocuments

Name	Type	Required	Description	Schema
documents	array	true		OffenderDocumentDetail
convictions	array	true		ConvictionDocuments

ReportDocumentDates

Name	Type	Required
requestedDate	string	false
requiredDate	string	false
completedDate	string	false

AdditionalSentence

Name	Type	Required	Schema
additionalSentenceId	integer	true
type	object	true	KeyValue
amount	number	false
length	integer	false
notes	string	false

Appointments

Name	Type	Required
total	integer	true
attended	integer	true
acceptableAbsences	integer	true
unacceptableAbsences	integer	true
noOutcomeRecorded	integer	true

Conviction

Name	Type	Required	Schema
convictionId	integer	true
index	string	true
active	boolean	true
inBreach	boolean	true
failureToComplyCount	integer	true
breachEnd	string	false
awaitingPsr	boolean	true
convictionDate	string	false
referralDate	string	true
offences	array	true	Offence
sentence	object	false	Sentence
latestCourtAppearanceOutcome	object	false	KeyValue
custody	object	false	Custody
responsibleCourt	object	false	Court
courtAppearance	object	false	CourtAppearanceBasic
orderManagers	array	false	OrderManager

Court

Name	Type	Required	Schema
courtId	integer	true
code	string	true
selectable	boolean	true
courtName	string	false
telephoneNumber	string	false
fax	string	false
buildingName	string	false
street	string	false
locality	string	false
town	string	false
county	string	false
postcode	string	false
country	string	false
courtTypeId	integer	true
createdDatetime	string	true
lastUpdatedDatetime	string	true
probationAreaId	integer	true
secureEmailAddress	string	false
probationArea	object	true	KeyValue
courtType	object	true	KeyValue

CourtAppearanceBasic

Name	Type	Required	Schema
courtAppearanceId	integer	true
appearanceDate	string	true
courtCode	string	true
courtName	string	false
appearanceType	object	true	KeyValue
crn	string	true

Custody

Name	Type	Required	Schema
bookingNumber	string	false
institution	object	false	Institution
keyDates	object	true	CustodyRelatedKeyDates
status	object	true	KeyValue
sentenceStartDate	string	true

CustodyRelatedKeyDates

Name	Type	Required
conditionalReleaseDate	string	false
licenceExpiryDate	string	false
hdcEligibilityDate	string	false
paroleEligibilityDate	string	false
sentenceExpiryDate	string	false
expectedReleaseDate	string	false
postSentenceSupervisionEndDate	string	false
expectedPrisonOffenderManagerHandoverStartDate	string	false
expectedPrisonOffenderManagerHandoverDate	string	false

Institution

Name	Type	Required	Schema
institutionId	integer	true
isEstablishment	boolean	true
code	string	true
description	string	true
institutionName	string	false
establishmentType	object	false	KeyValue
isPrivate	boolean	false
nomsPrisonInstitutionCode	string	false

Offence

Name	Type	Required	Schema
offenceId	string	true
mainOffence	boolean	true
detail	object	true	OffenceDetail
offenceDate	string	false
offenceCount	integer	false
tics	integer	false
verdict	string	false
offenderId	integer	false
createdDatetime	string	true
lastUpdatedDatetime	string	true

OffenceDetail

Name	Type	Required
code	string	true
description	string	true
abbreviation	string	false
mainCategoryCode	string	true
mainCategoryDescription	string	true
mainCategoryAbbreviation	string	true
ogrsOffenceCategory	string	true
subCategoryCode	string	true
subCategoryDescription	string	true
form20Code	string	false
subCategoryAbbreviation	string	false
cjitCode	string	false

OrderManager

Name	Type	Required
probationAreaId	integer	true
teamId	integer	false
officerId	integer	true
name	string	false
staffCode	string	false
dateStartOfAllocation	string	true
dateEndOfAllocation	string	false
gradeCode	string	false
teamCode	string	false
probationAreaCode	string	true

Sentence

Name	Type	Required	Schema
sentenceId	integer	true
description	string	true
originalLength	integer	false
originalLengthUnits	string	false
secondLength	integer	false
secondLengthUnits	string	false
defaultLength	integer	false
effectiveLength	integer	false
lengthInDays	integer	false
expectedSentenceEndDate	string	false
unpaidWork	object	false	UnpaidWork
startDate	string	true
terminationDate	string	false
terminationReason	string	false
sentenceType	object	true	KeyValue
additionalSentences	array	false	AdditionalSentence
failureToComplyLimit	integer	false
cja2003Order	boolean	true
legacyOrder	boolean	true

UnpaidWork

Name	Type	Required	Schema
minutesOrdered	integer	true
minutesCompleted	integer	true
appointments	object	true	Appointments
status	string	true

SentenceStatus

Name	Type	Required	Schema
sentenceId	integer	true
custodialType	object	true	KeyValue
sentence	object	true	KeyValue
mainOffence	object	false	KeyValue
sentenceDate	string	false
actualReleaseDate	string	false
licenceExpiryDate	string	false
pssEndDate	string	false
length	integer	false
lengthUnit	string	true

ConvictionRequirements

Name	Type	Required	Description	Schema
requirements	array	true		Requirement

Requirement

Name	Type	Required	Description	Schema
requirementId	integer	true	Unique identifier for the requirement
requirementNotes	string	true	Name of the requirement
commencementDate	string	false
startDate	string	false
terminationDate	string	false
expectedStartDate	string	false
expectedEndDate	string	false
createdDatetime	string	true
active	boolean	true	Is the requirement currently active
requirementTypeSubCategory	object	false		KeyValue
requirementTypeMainCategory	object	false		KeyValue
adRequirementTypeMainCategory	object	false		KeyValue
adRequirementTypeSubCategory	object	false		KeyValue
terminationReason	object	false		KeyValue
length	integer	false	The number of temporal units to complete the requirement (see lengthUnit field for unit)
lengthUnit	string	false	The temporal unit corresponding to the length field
restrictive	boolean	false	Is the main category restrictive
softDeleted	boolean	true
rarCount	integer	false	Total RAR days completed

PssRequirement

List of pssRequirements associated with this conviction

Name	Type	Required	Description	Schema
type	object	false		KeyValue
subType	object	false		KeyValue
active	boolean	true	Is the requirement currently active

PssRequirements

Name	Type	Required	Description	Schema
pssRequirements	array	true	List of pssRequirements associated with this conviction	PssRequirement

AllTeam

Name	Type	Required	Schema
providerTeamId	integer	false
teamId	integer	false
code	string	true
description	string	false
name	string	false
isPrivate	boolean	false
externalProvider	object	false	KeyValue
scProvider	object	false	KeyValue
localDeliveryUnit	object	false	KeyValue
district	object	false	KeyValue
borough	object	false	KeyValue

Human

staff name details

Name	Type	Required	Description	Schema
forenames	string	true
surname	string	true

Nsi

Name	Type	Required	Description	Schema
nsiId	integer	true
nsiType	object	true		KeyValue
nsiSubType	object	false		KeyValue
nsiOutcome	object	false		KeyValue
requirement	object	false		Requirement
nsiStatus	object	true		KeyValue
statusDateTime	string	true
actualStartDate	string	false
expectedStartDate	string	false
actualEndDate	string	false
expectedEndDate	string	false
referralDate	string	true
length	integer	false
lengthUnit	string	false
nsiManagers	array	true		NsiManager
notes	string	false
intendedProvider	object	false	provider this staff member is associated with	ProbationArea
active	boolean	true
softDeleted	boolean	true
externalReference	string	false
recallRejectedOrWithdrawn	boolean	false
outcomeRecall	boolean	false

NsiDetails

Name	Type	Required	Description	Schema
nsis	array	true		Nsi

NsiManager

Name	Type	Required	Description	Schema
probationArea	object	true	provider this staff member is associated with	ProbationArea
team	object	true	all teams related to this staff member	Team
staff	object	true		StaffDetails
startDate	string	true
endDate	string	false

ProbationArea

provider this staff member is associated with

Name	Type	Required	Schema
probationAreaId	integer	false
code	string	true
description	string	true
organisation	object	false	KeyValue
institution	object	false	Institution
nps	boolean	false
teams	array	false	AllTeam

StaffDetails

Name	Type	Required	Description	Schema
username	string	false	the optional username of this staff member, will be absent if the staff member is not a user of Delius
staffCode	string	true	staff code AKA officer code
staffIdentifier	integer	true	staff identifier
staff	object	true	staff name details	Human
teams	array	false	all teams related to this staff member	Team
probationArea	object	true	provider this staff member is associated with	ProbationArea
staffGrade	object	false		KeyValue

Team

all teams related to this staff member

Name	Type	Required	Schema
code	string	true
description	string	true
telephone	string	false
emailAddress	string	false
localDeliveryUnit	object	true	KeyValue
district	object	true	KeyValue
borough	object	true	KeyValue
teamType	object	false	KeyValue
startDate	string	false
endDate	string	false

LicenceCondition

Name	Type	Required	Schema
licenceConditionNotes	string	false
startDate	string	true
commencementDate	string	false
commencementNotes	string	false
terminationDate	string	false
terminationNotes	string	false
createdDateTime	string	true
active	boolean	true
licenceConditionTypeMainCat	object	false	KeyValue
licenceConditionTypeSubCat	object	false	KeyValue

LicenceConditions

Name	Type	Required	Description	Schema
licenceConditions	array	true		LicenceCondition

CourtReportMinimal

Name	Type	Required	Schema
courtReportId	integer	true
offenderId	integer	true
requestedDate	string	true
requiredDate	string	true
allocationDate	string	false
completedDate	string	false
sentToCourtDate	string	false
receivedByCourtDate	string	false
courtReportType	object	false	KeyValue
reportManagers	array	true	ReportManager
deliveredCourtReportType	object	false	KeyValue

ReportManager

Name	Type	Required	Description	Schema
staff	object	false		StaffHuman
active	boolean	true

CourtAppearanceBasicWrapper

Name	Type	Required	Description	Schema
courtAppearances	array	true		CourtAppearanceBasic

Attendance

Name	Type	Required	Schema
attended	boolean	true
complied	boolean	true
attendanceDate	string	true
contactId	integer	true
outcome	string	false
contactType	object	true	ContactTypeDetail

Attendances

Name	Type	Required	Description	Schema
attendances	array	true		Attendance

ContactTypeDetail

Name	Type	Required	Description	Schema
code	string	false
description	string	false

Address

Name	Type	Required	Schema
from	string	false
to	string	false
noFixedAbode	boolean	false
notes	string	false
addressNumber	string	false
buildingName	string	false
streetName	string	false
district	string	false
town	string	false
county	string	false
postcode	string	false
telephoneNumber	string	false
status	object	false	KeyValue
type	object	false	KeyValue
typeVerified	boolean	false
latestAssessmentDate	string	false
createdDatetime	string	false
lastUpdatedDatetime	string	false

ContactDetails

Name	Type	Required	Schema
allowSMS	boolean	false
emailAddresses	array	false
phoneNumbers	array	false	PhoneNumber
addresses	array	false	Address

OffenderAlias

Name	Type	Required
id	string	true
dateOfBirth	string	false
firstName	string	true
middleNames	array	false
surname	string	true
gender	string	true

OffenderDetail

Name	Type	Required	Schema
preferredName	string	false
activeProbationManagedSentence	boolean	true
contactDetails	object	true	ContactDetails
currentDisposal	string	true
currentExclusion	boolean	true
exclusionMessage	string	false
currentRestriction	boolean	true
restrictionMessage	string	false
dateOfBirth	string	true
firstName	string	true
gender	string	true
middleNames	array	false
offenderId	integer	true
offenderProfile	object	true	OffenderProfile
offenderAliases	array	false	OffenderAlias
offenderManagers	array	false	OffenderManager
otherIds	object	true	OtherIds
partitionArea	string	true
currentTier	string	false
previousSurname	string	false
softDeleted	boolean	true
surname	string	true
title	string	false

OffenderManager

Name	Type	Required	Description	Schema
trustOfficer	object	true	staff name details	Human
staff	object	false		StaffHuman
providerEmployee	object	false	staff name details	Human
partitionArea	string	true
softDeleted	boolean	true
team	object	false	all teams related to this staff member	Team
probationArea	object	true	provider this staff member is associated with	ProbationArea
fromDate	string	true
toDate	string	false
active	boolean	true
allocationReason	object	false		KeyValue

CommunityOrPrisonOffenderManager

Name	Type	Required	Description	Schema
staffCode	string	false	Staff code
staffId	integer	false	Staff id
isResponsibleOfficer	boolean	true	True if this offender manager is the current responsible officer
isPrisonOffenderManager	boolean	true	True if this offender manager is the prison OM else False
isUnallocated	boolean	true	True if no real offender manager has been allocated and this is just a placeholder
staff	object	false	staff name and contact details	ContactableHuman
team	object	false	all teams related to this staff member	Team
probationArea	object	false	provider this staff member is associated with	ProbationArea
fromDate	string	false	Date since the offender manager was assigned
grade	object	false		KeyValue

ContactableHuman

staff name and contact details

Name	Type	Required	Description
forenames	string	true	Given names
surname	string	true	Family name
email	string	false	Email address
phoneNumber	string	false	Phone number