API Reference

The following documentation is also available in these formats:

API Reference v1.0

/user/{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

/sentence/{crn}

get

Display active events

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "sentences": [ { "offenceDetails": { "eventNumber": "string", "offence": { "description": "string", "count": "integer" }, "dateOfOffence": "string", "notes": "string", "additionalOffences": [ { "description": "string", "count": "integer" } ] }, "conviction": { "sentencingCourt": "string", "responsibleCourt": "string", "convictionDate": "string", "additionalSentences": [ { "length": "integer", "amount": "integer", "notes": "string", "description": "string" } ] }, "order": { "description": "string", "length": "integer", "endDate": "string", "startDate": "string", "status": "string", "mainOffence": "string", "breaches": "integer" }, "requirements": [ { "code": "string", "expectedStartDate": "string", "actualStartDate": "string", "expectedEndDate": "string", "actualEndDate": "string", "terminationReason": "string", "description": "string", "length": "integer", "lengthUnitValue": "string", "notes": "string", "rar": { "completed": "integer", "scheduled": "integer", "totalDays": "integer" } } ], "courtDocuments": [ { "id": "string", "lastSaved": "string", "documentName": "string" } ], "unpaidWorkProgress": "string" } ], "probationHistory": { "numberOfTerminatedEvents": "integer", "dateOfMostRecentTerminatedEvent": "string", "numberOfTerminatedEventBreaches": "integer", "numberOfProfessionalContacts": "integer" } }	SentenceOverview

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "sentences": [
    {
      "offenceDetails": {
        "eventNumber": "string",
        "offence": {
          "description": "string",
          "count": "integer"
        },
        "dateOfOffence": "string",
        "notes": "string",
        "additionalOffences": [
          {
            "description": "string",
            "count": "integer"
          }
        ]
      },
      "conviction": {
        "sentencingCourt": "string",
        "responsibleCourt": "string",
        "convictionDate": "string",
        "additionalSentences": [
          {
            "length": "integer",
            "amount": "integer",
            "notes": "string",
            "description": "string"
          }
        ]
      },
      "order": {
        "description": "string",
        "length": "integer",
        "endDate": "string",
        "startDate": "string",
        "status": "string",
        "mainOffence": "string",
        "breaches": "integer"
      },
      "requirements": [
        {
          "code": "string",
          "expectedStartDate": "string",
          "actualStartDate": "string",
          "expectedEndDate": "string",
          "actualEndDate": "string",
          "terminationReason": "string",
          "description": "string",
          "length": "integer",
          "lengthUnitValue": "string",
          "notes": "string",
          "rar": {
            "completed": "integer",
            "scheduled": "integer",
            "totalDays": "integer"
          }
        }
      ],
      "courtDocuments": [
        {
          "id": "string",
          "lastSaved": "string",
          "documentName": "string"
        }
      ],
      "unpaidWorkProgress": "string"
    }
  ],
  "probationHistory": {
    "numberOfTerminatedEvents": "integer",
    "dateOfMostRecentTerminatedEvent": "string",
    "numberOfTerminatedEventBreaches": "integer",
    "numberOfProfessionalContacts": "integer"
  }
}

SentenceOverview

/sentence/{crn}/previous-orders

get

Display inactive events

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "name": { "forename": "string", "middleName": "string", "surname": "string" }, "previousOrders": [ { "title": "string", "description": "string", "terminationDate": "string" } ] }`	PreviousOrderHistory

{
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "previousOrders": [
    {
      "title": "string",
      "description": "string",
      "terminationDate": "string"
    }
  ]
}

PreviousOrderHistory

/sentence/{crn}/offences/{eventNumber}

get

Display additional offence details

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "name": { "forename": "string", "middleName": "string", "surname": "string" }, "mainOffence": { "description": "string", "count": "integer" }, "additionalOffences": [ { "description": "string", "count": "integer" } ] }`	Offences

{
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "mainOffence": {
    "description": "string",
    "count": "integer"
  },
  "additionalOffences": [
    {
      "description": "string",
      "count": "integer"
    }
  ]
}

Offences

/sentence/{crn}/contacts

get

Display contacts

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "name": { "forename": "string", "middleName": "string", "surname": "string" }, "contacts": [ { "name": "string", "email": "string", "telephoneNumber": "string", "provider": "string", "probationDeliveryUnit": "string", "team": "string", "allocatedUntil": "string" } ] }`	ProfessionalContact

{
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "contacts": [
    {
      "name": "string",
      "email": "string",
      "telephoneNumber": "string",
      "provider": "string",
      "probationDeliveryUnit": "string",
      "team": "string",
      "allocatedUntil": "string"
    }
  ]
}

ProfessionalContact

/schedule/{crn}/upcoming

get

Gets upcoming schedule information’

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "appointments": [ { "id": "integer", "eventNumber": "string", "type": "string", "startDateTime": "string", "endDateTime": "string", "rarToolKit": "string", "notes": "string", "isSensitive": "boolean", "hasOutcome": "boolean", "wasAbsent": "boolean", "officerName": { "forename": "string", "middleName": "string", "surname": "string" }, "isInitial": "boolean", "isNationalStandard": "boolean", "location": { "officeName": "string", "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "ldu": "string", "telephoneNumber": "string" }, "rescheduled": "boolean", "rescheduledStaff": "boolean", "rescheduledPop": "boolean", "didTheyComply": "boolean", "absentWaitingEvidence": "boolean", "rearrangeOrCancelReason": "string", "rescheduledBy": { "forename": "string", "middleName": "string", "surname": "string" }, "repeating": "boolean", "nonComplianceReason": "string", "documents": [ { "id": "string", "name": "string", "lastUpdated": "string" } ], "rarCategory": "string", "acceptableAbsence": "boolean", "acceptableAbsenceReason": "string", "isAppointment": "boolean", "isCommunication": "boolean", "action": "string", "isSystemContact": "boolean", "isEmailOrTextFromPop": "boolean", "isPhoneCallFromPop": "boolean", "isEmailOrTextToPop": "boolean", "isPhoneCallToPop": "boolean", "isPastAppointment": "boolean", "countsTowardsRAR": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] }	Schedule

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "appointments": [
    {
      "id": "integer",
      "eventNumber": "string",
      "type": "string",
      "startDateTime": "string",
      "endDateTime": "string",
      "rarToolKit": "string",
      "notes": "string",
      "isSensitive": "boolean",
      "hasOutcome": "boolean",
      "wasAbsent": "boolean",
      "officerName": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "isInitial": "boolean",
      "isNationalStandard": "boolean",
      "location": {
        "officeName": "string",
        "buildingName": "string",
        "buildingNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string",
        "ldu": "string",
        "telephoneNumber": "string"
      },
      "rescheduled": "boolean",
      "rescheduledStaff": "boolean",
      "rescheduledPop": "boolean",
      "didTheyComply": "boolean",
      "absentWaitingEvidence": "boolean",
      "rearrangeOrCancelReason": "string",
      "rescheduledBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "repeating": "boolean",
      "nonComplianceReason": "string",
      "documents": [
        {
          "id": "string",
          "name": "string",
          "lastUpdated": "string"
        }
      ],
      "rarCategory": "string",
      "acceptableAbsence": "boolean",
      "acceptableAbsenceReason": "string",
      "isAppointment": "boolean",
      "isCommunication": "boolean",
      "action": "string",
      "isSystemContact": "boolean",
      "isEmailOrTextFromPop": "boolean",
      "isPhoneCallFromPop": "boolean",
      "isEmailOrTextToPop": "boolean",
      "isPhoneCallToPop": "boolean",
      "isPastAppointment": "boolean",
      "countsTowardsRAR": "boolean",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      }
    }
  ]
}

Schedule

/schedule/{crn}/previous

get

Gets previous schedule information’

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "appointments": [ { "id": "integer", "eventNumber": "string", "type": "string", "startDateTime": "string", "endDateTime": "string", "rarToolKit": "string", "notes": "string", "isSensitive": "boolean", "hasOutcome": "boolean", "wasAbsent": "boolean", "officerName": { "forename": "string", "middleName": "string", "surname": "string" }, "isInitial": "boolean", "isNationalStandard": "boolean", "location": { "officeName": "string", "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "ldu": "string", "telephoneNumber": "string" }, "rescheduled": "boolean", "rescheduledStaff": "boolean", "rescheduledPop": "boolean", "didTheyComply": "boolean", "absentWaitingEvidence": "boolean", "rearrangeOrCancelReason": "string", "rescheduledBy": { "forename": "string", "middleName": "string", "surname": "string" }, "repeating": "boolean", "nonComplianceReason": "string", "documents": [ { "id": "string", "name": "string", "lastUpdated": "string" } ], "rarCategory": "string", "acceptableAbsence": "boolean", "acceptableAbsenceReason": "string", "isAppointment": "boolean", "isCommunication": "boolean", "action": "string", "isSystemContact": "boolean", "isEmailOrTextFromPop": "boolean", "isPhoneCallFromPop": "boolean", "isEmailOrTextToPop": "boolean", "isPhoneCallToPop": "boolean", "isPastAppointment": "boolean", "countsTowardsRAR": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] }	Schedule

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "appointments": [
    {
      "id": "integer",
      "eventNumber": "string",
      "type": "string",
      "startDateTime": "string",
      "endDateTime": "string",
      "rarToolKit": "string",
      "notes": "string",
      "isSensitive": "boolean",
      "hasOutcome": "boolean",
      "wasAbsent": "boolean",
      "officerName": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "isInitial": "boolean",
      "isNationalStandard": "boolean",
      "location": {
        "officeName": "string",
        "buildingName": "string",
        "buildingNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string",
        "ldu": "string",
        "telephoneNumber": "string"
      },
      "rescheduled": "boolean",
      "rescheduledStaff": "boolean",
      "rescheduledPop": "boolean",
      "didTheyComply": "boolean",
      "absentWaitingEvidence": "boolean",
      "rearrangeOrCancelReason": "string",
      "rescheduledBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "repeating": "boolean",
      "nonComplianceReason": "string",
      "documents": [
        {
          "id": "string",
          "name": "string",
          "lastUpdated": "string"
        }
      ],
      "rarCategory": "string",
      "acceptableAbsence": "boolean",
      "acceptableAbsenceReason": "string",
      "isAppointment": "boolean",
      "isCommunication": "boolean",
      "action": "string",
      "isSystemContact": "boolean",
      "isEmailOrTextFromPop": "boolean",
      "isPhoneCallFromPop": "boolean",
      "isEmailOrTextToPop": "boolean",
      "isPhoneCallToPop": "boolean",
      "isPastAppointment": "boolean",
      "countsTowardsRAR": "boolean",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      }
    }
  ]
}

Schedule

/schedule/{crn}/appointment/{contactId}

get

Gets individual appointment information’

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "appointment": { "id": "integer", "eventNumber": "string", "type": "string", "startDateTime": "string", "endDateTime": "string", "rarToolKit": "string", "notes": "string", "isSensitive": "boolean", "hasOutcome": "boolean", "wasAbsent": "boolean", "officerName": { "forename": "string", "middleName": "string", "surname": "string" }, "isInitial": "boolean", "isNationalStandard": "boolean", "location": { "officeName": "string", "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "ldu": "string", "telephoneNumber": "string" }, "rescheduled": "boolean", "rescheduledStaff": "boolean", "rescheduledPop": "boolean", "didTheyComply": "boolean", "absentWaitingEvidence": "boolean", "rearrangeOrCancelReason": "string", "rescheduledBy": { "forename": "string", "middleName": "string", "surname": "string" }, "repeating": "boolean", "nonComplianceReason": "string", "documents": [ { "id": "string", "name": "string", "lastUpdated": "string" } ], "rarCategory": "string", "acceptableAbsence": "boolean", "acceptableAbsenceReason": "string", "isAppointment": "boolean", "isCommunication": "boolean", "action": "string", "isSystemContact": "boolean", "isEmailOrTextFromPop": "boolean", "isPhoneCallFromPop": "boolean", "isEmailOrTextToPop": "boolean", "isPhoneCallToPop": "boolean", "isPastAppointment": "boolean", "countsTowardsRAR": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } }	PersonAppointment

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "appointment": {
    "id": "integer",
    "eventNumber": "string",
    "type": "string",
    "startDateTime": "string",
    "endDateTime": "string",
    "rarToolKit": "string",
    "notes": "string",
    "isSensitive": "boolean",
    "hasOutcome": "boolean",
    "wasAbsent": "boolean",
    "officerName": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "isInitial": "boolean",
    "isNationalStandard": "boolean",
    "location": {
      "officeName": "string",
      "buildingName": "string",
      "buildingNumber": "string",
      "streetName": "string",
      "district": "string",
      "town": "string",
      "county": "string",
      "postcode": "string",
      "ldu": "string",
      "telephoneNumber": "string"
    },
    "rescheduled": "boolean",
    "rescheduledStaff": "boolean",
    "rescheduledPop": "boolean",
    "didTheyComply": "boolean",
    "absentWaitingEvidence": "boolean",
    "rearrangeOrCancelReason": "string",
    "rescheduledBy": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "repeating": "boolean",
    "nonComplianceReason": "string",
    "documents": [
      {
        "id": "string",
        "name": "string",
        "lastUpdated": "string"
      }
    ],
    "rarCategory": "string",
    "acceptableAbsence": "boolean",
    "acceptableAbsenceReason": "string",
    "isAppointment": "boolean",
    "isCommunication": "boolean",
    "action": "string",
    "isSystemContact": "boolean",
    "isEmailOrTextFromPop": "boolean",
    "isPhoneCallFromPop": "boolean",
    "isEmailOrTextToPop": "boolean",
    "isPhoneCallToPop": "boolean",
    "isPastAppointment": "boolean",
    "countsTowardsRAR": "boolean",
    "lastUpdated": "string",
    "lastUpdatedBy": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    }
  }
}

PersonAppointment

/risk-flags/{crn}

get

Gets all risk flags for an offender’

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "riskFlags": [ { "id": "integer", "description": "string", "notes": "string", "nextReviewDate": "string", "mostRecentReviewDate": "string", "createdDate": "string", "createdBy": { "forename": "string", "middleName": "string", "surname": "string" }, "removed": "boolean", "removalHistory": [ { "notes": "string", "removalDate": "string", "removedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] } ], "removedRiskFlags": [ { "id": "integer", "description": "string", "notes": "string", "nextReviewDate": "string", "mostRecentReviewDate": "string", "createdDate": "string", "createdBy": { "forename": "string", "middleName": "string", "surname": "string" }, "removed": "boolean", "removalHistory": [ { "notes": "string", "removalDate": "string", "removedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] } ] }	PersonRiskFlags

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "riskFlags": [
    {
      "id": "integer",
      "description": "string",
      "notes": "string",
      "nextReviewDate": "string",
      "mostRecentReviewDate": "string",
      "createdDate": "string",
      "createdBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "removed": "boolean",
      "removalHistory": [
        {
          "notes": "string",
          "removalDate": "string",
          "removedBy": {
            "forename": "string",
            "middleName": "string",
            "surname": "string"
          }
        }
      ]
    }
  ],
  "removedRiskFlags": [
    {
      "id": "integer",
      "description": "string",
      "notes": "string",
      "nextReviewDate": "string",
      "mostRecentReviewDate": "string",
      "createdDate": "string",
      "createdBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "removed": "boolean",
      "removalHistory": [
        {
          "notes": "string",
          "removalDate": "string",
          "removedBy": {
            "forename": "string",
            "middleName": "string",
            "surname": "string"
          }
        }
      ]
    }
  ]
}

PersonRiskFlags

/risk-flags/{crn}/{riskFlagId}

get

Gets an individual risk flag for an offender’

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "riskFlag": { "id": "integer", "description": "string", "notes": "string", "nextReviewDate": "string", "mostRecentReviewDate": "string", "createdDate": "string", "createdBy": { "forename": "string", "middleName": "string", "surname": "string" }, "removed": "boolean", "removalHistory": [ { "notes": "string", "removalDate": "string", "removedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] } }	PersonRiskFlag

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "riskFlag": {
    "id": "integer",
    "description": "string",
    "notes": "string",
    "nextReviewDate": "string",
    "mostRecentReviewDate": "string",
    "createdDate": "string",
    "createdBy": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "removed": "boolean",
    "removalHistory": [
      {
        "notes": "string",
        "removalDate": "string",
        "removedBy": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        }
      }
    ]
  }
}

PersonRiskFlag

/personal-details/{crn}

get

Personal Details containing address, personal contacts and documents

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", "middleName": "string", "surname": "string" }, "contacts": [ { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "contactId": "integer", "name": { "forename": "string", "middleName": "string", "surname": "string" }, "relationship": "string", "relationshipType": "string", "address": { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } }, "notes": "string", "phone": "string", "email": "string", "startDate": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ], "mainAddress": { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "telephoneNumber": "string", "from": "string", "to": "string", "verified": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" }, "type": "string", "status": "string", "notes": "string" }, "otherAddressCount": "integer", "previousAddressCount": "integer", "preferredGender": "string", "dateOfBirth": "string", "preferredName": "string", "previousSurname": "string", "preferredLanguage": "string", "genderIdentity": "string", "selfDescribedGender": "string", "aliases": [ { "forename": "string", "middleName": "string", "surname": "string" } ], "telephoneNumber": "string", "mobileNumber": "string", "email": "string", "circumstances": { "circumstances": [ { "subType": "string", "type": "string" } ], "lastUpdated": "string" }, "disabilities": { "disabilities": [ { } ], "lastUpdated": "string" }, "provisions": { "provisions": [ { } ], "lastUpdated": "string" }, "pnc": "string", "sex": "string", "religionOrBelief": "string", "sexualOrientation": "string", "requiresInterpreter": "boolean", "documents": [ { "id": "string", "name": "string", "lastUpdated": "string" } ] }	PersonalDetails

{
  "crn": "string",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "contacts": [
    {
      "personSummary": {
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "crn": "string",
        "offenderId": "integer",
        "pnc": "string",
        "dateOfBirth": "string"
      },
      "contactId": "integer",
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "relationship": "string",
      "relationshipType": "string",
      "address": {
        "buildingName": "string",
        "buildingNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string",
        "lastUpdated": "string",
        "lastUpdatedBy": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        }
      },
      "notes": "string",
      "phone": "string",
      "email": "string",
      "startDate": "string",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      }
    }
  ],
  "mainAddress": {
    "buildingName": "string",
    "buildingNumber": "string",
    "streetName": "string",
    "district": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "telephoneNumber": "string",
    "from": "string",
    "to": "string",
    "verified": "boolean",
    "lastUpdated": "string",
    "lastUpdatedBy": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "type": "string",
    "status": "string",
    "notes": "string"
  },
  "otherAddressCount": "integer",
  "previousAddressCount": "integer",
  "preferredGender": "string",
  "dateOfBirth": "string",
  "preferredName": "string",
  "previousSurname": "string",
  "preferredLanguage": "string",
  "genderIdentity": "string",
  "selfDescribedGender": "string",
  "aliases": [
    {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    }
  ],
  "telephoneNumber": "string",
  "mobileNumber": "string",
  "email": "string",
  "circumstances": {
    "circumstances": [
      {
        "subType": "string",
        "type": "string"
      }
    ],
    "lastUpdated": "string"
  },
  "disabilities": {
    "disabilities": [
      {
      }
    ],
    "lastUpdated": "string"
  },
  "provisions": {
    "provisions": [
      {
      }
    ],
    "lastUpdated": "string"
  },
  "pnc": "string",
  "sex": "string",
  "religionOrBelief": "string",
  "sexualOrientation": "string",
  "requiresInterpreter": "boolean",
  "documents": [
    {
      "id": "string",
      "name": "string",
      "lastUpdated": "string"
    }
  ]
}

PersonalDetails

/personal-details/{crn}/summary

get

Person Summary

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }`	PersonSummary

{
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "crn": "string",
  "offenderId": "integer",
  "pnc": "string",
  "dateOfBirth": "string"
}

PersonSummary

/personal-details/{crn}/provisions

get

Person Provisions

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "provisions": [ { "description": "string", "notes": "string", "startDate": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] }`	ProvisionOverview

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "provisions": [
    {
      "description": "string",
      "notes": "string",
      "startDate": "string",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      }
    }
  ]
}

ProvisionOverview

/personal-details/{crn}/personal-contact/{id}

get

Person Contact

Parameters

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

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "contactId": "integer", "name": { "forename": "string", "middleName": "string", "surname": "string" }, "relationship": "string", "relationshipType": "string", "address": { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } }, "notes": "string", "phone": "string", "email": "string", "startDate": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } }	PersonalContact

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "contactId": "integer",
  "name": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "relationship": "string",
  "relationshipType": "string",
  "address": {
    "buildingName": "string",
    "buildingNumber": "string",
    "streetName": "string",
    "district": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "lastUpdated": "string",
    "lastUpdatedBy": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    }
  },
  "notes": "string",
  "phone": "string",
  "email": "string",
  "startDate": "string",
  "lastUpdated": "string",
  "lastUpdatedBy": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  }
}

PersonalContact

/personal-details/{crn}/document/{documentId}

get

Download document

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

/personal-details/{crn}/disabilities

get

Person Disabilities

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "disabilities": [ { "description": "string", "notes": "string", "startDate": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] }`	DisabilityOverview

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "disabilities": [
    {
      "description": "string",
      "notes": "string",
      "startDate": "string",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      }
    }
  ]
}

DisabilityOverview

/personal-details/{crn}/circumstances

get

Person Circumstances

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "circumstances": [ { "type": "string", "subType": "string", "notes": "string", "verified": "boolean", "startDate": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] }`	CircumstanceOverview

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "circumstances": [
    {
      "type": "string",
      "subType": "string",
      "notes": "string",
      "verified": "boolean",
      "startDate": "string",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      }
    }
  ]
}

CircumstanceOverview

/personal-details/{crn}/addresses

get

Person Addresses

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "mainAddress": { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "telephoneNumber": "string", "from": "string", "to": "string", "verified": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" }, "type": "string", "status": "string", "notes": "string" }, "otherAddresses": [ { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "telephoneNumber": "string", "from": "string", "to": "string", "verified": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" }, "type": "string", "status": "string", "notes": "string" } ], "previousAddresses": [ { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "telephoneNumber": "string", "from": "string", "to": "string", "verified": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" }, "type": "string", "status": "string", "notes": "string" } ] }	AddressOverview

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "mainAddress": {
    "buildingName": "string",
    "buildingNumber": "string",
    "streetName": "string",
    "district": "string",
    "town": "string",
    "county": "string",
    "postcode": "string",
    "telephoneNumber": "string",
    "from": "string",
    "to": "string",
    "verified": "boolean",
    "lastUpdated": "string",
    "lastUpdatedBy": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "type": "string",
    "status": "string",
    "notes": "string"
  },
  "otherAddresses": [
    {
      "buildingName": "string",
      "buildingNumber": "string",
      "streetName": "string",
      "district": "string",
      "town": "string",
      "county": "string",
      "postcode": "string",
      "telephoneNumber": "string",
      "from": "string",
      "to": "string",
      "verified": "boolean",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "type": "string",
      "status": "string",
      "notes": "string"
    }
  ],
  "previousAddresses": [
    {
      "buildingName": "string",
      "buildingNumber": "string",
      "streetName": "string",
      "district": "string",
      "town": "string",
      "county": "string",
      "postcode": "string",
      "telephoneNumber": "string",
      "from": "string",
      "to": "string",
      "verified": "boolean",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "type": "string",
      "status": "string",
      "notes": "string"
    }
  ]
}

AddressOverview

/overview/{crn}

get

MAS Overview containing Personal Details, Activity, Compliance, Schedule, Orders and Sentences

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "appointmentsWithoutOutcome": "integer", "absencesWithoutEvidence": "integer", "activity": { "acceptableAbsenceCount": "integer", "unacceptableAbsenceCount": "integer", "attendedButDidNotComplyCount": "integer", "outcomeNotRecordedCount": "integer", "waitingForEvidenceCount": "integer", "rescheduledCount": "integer", "absentCount": "integer", "rescheduledByStaffCount": "integer", "rescheduledByPersonOnProbationCount": "integer", "lettersCount": "integer", "nationalStandardAppointmentsCount": "integer", "compliedAppointmentsCount": "integer" }, "compliance": { "currentBreaches": "integer", "breachStarted": "boolean", "breachesOnCurrentOrderCount": "integer", "priorBreachesOnCurrentOrderCount": "integer", "failureToComplyCount": "integer" }, "personalDetails": { "crn": "string", "name": { "forename": "string", "middleName": "string", "surname": "string" }, "contacts": [ { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "contactId": "integer", "name": { "forename": "string", "middleName": "string", "surname": "string" }, "relationship": "string", "relationshipType": "string", "address": { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } }, "notes": "string", "phone": "string", "email": "string", "startDate": "string", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ], "mainAddress": { "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "telephoneNumber": "string", "from": "string", "to": "string", "verified": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" }, "type": "string", "status": "string", "notes": "string" }, "otherAddressCount": "integer", "previousAddressCount": "integer", "preferredGender": "string", "dateOfBirth": "string", "preferredName": "string", "previousSurname": "string", "preferredLanguage": "string", "genderIdentity": "string", "selfDescribedGender": "string", "aliases": [ { "forename": "string", "middleName": "string", "surname": "string" } ], "telephoneNumber": "string", "mobileNumber": "string", "email": "string", "circumstances": { "circumstances": [ { "subType": "string", "type": "string" } ], "lastUpdated": "string" }, "disabilities": { "disabilities": [ { } ], "lastUpdated": "string" }, "provisions": { "provisions": [ { } ], "lastUpdated": "string" }, "pnc": "string", "sex": "string", "religionOrBelief": "string", "sexualOrientation": "string", "requiresInterpreter": "boolean", "documents": [ { "id": "string", "name": "string", "lastUpdated": "string" } ] }, "previousOrders": { "breaches": "integer", "count": "integer", "orders": [ { "description": "string", "length": "integer", "endDate": "string", "startDate": "string", "status": "string", "mainOffence": "string", "breaches": "integer" } ] }, "schedule": { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "appointments": [ { "id": "integer", "eventNumber": "string", "type": "string", "startDateTime": "string", "endDateTime": "string", "rarToolKit": "string", "notes": "string", "isSensitive": "boolean", "hasOutcome": "boolean", "wasAbsent": "boolean", "officerName": { "forename": "string", "middleName": "string", "surname": "string" }, "isInitial": "boolean", "isNationalStandard": "boolean", "location": { "officeName": "string", "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "ldu": "string", "telephoneNumber": "string" }, "rescheduled": "boolean", "rescheduledStaff": "boolean", "rescheduledPop": "boolean", "didTheyComply": "boolean", "absentWaitingEvidence": "boolean", "rearrangeOrCancelReason": "string", "rescheduledBy": { "forename": "string", "middleName": "string", "surname": "string" }, "repeating": "boolean", "nonComplianceReason": "string", "documents": [ { "id": "string", "name": "string", "lastUpdated": "string" } ], "rarCategory": "string", "acceptableAbsence": "boolean", "acceptableAbsenceReason": "string", "isAppointment": "boolean", "isCommunication": "boolean", "action": "string", "isSystemContact": "boolean", "isEmailOrTextFromPop": "boolean", "isPhoneCallFromPop": "boolean", "isEmailOrTextToPop": "boolean", "isPhoneCallToPop": "boolean", "isPastAppointment": "boolean", "countsTowardsRAR": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] }, "sentences": [ { "offenceDetails": { "eventNumber": "string", "offence": { "description": "string", "count": "integer" }, "dateOfOffence": "string", "notes": "string", "additionalOffences": [ { "description": "string", "count": "integer" } ] }, "conviction": { "sentencingCourt": "string", "responsibleCourt": "string", "convictionDate": "string", "additionalSentences": [ { "length": "integer", "amount": "integer", "notes": "string", "description": "string" } ] }, "order": { "description": "string", "length": "integer", "endDate": "string", "startDate": "string", "status": "string", "mainOffence": "string", "breaches": "integer" }, "requirements": [ { "code": "string", "expectedStartDate": "string", "actualStartDate": "string", "expectedEndDate": "string", "actualEndDate": "string", "terminationReason": "string", "description": "string", "length": "integer", "lengthUnitValue": "string", "notes": "string", "rar": { "completed": "integer", "scheduled": "integer", "totalDays": "integer" } } ], "courtDocuments": [ { "id": "string", "lastSaved": "string", "documentName": "string" } ], "unpaidWorkProgress": "string" } ], "registrations": [ { } ] }	Overview

{
  "appointmentsWithoutOutcome": "integer",
  "absencesWithoutEvidence": "integer",
  "activity": {
    "acceptableAbsenceCount": "integer",
    "unacceptableAbsenceCount": "integer",
    "attendedButDidNotComplyCount": "integer",
    "outcomeNotRecordedCount": "integer",
    "waitingForEvidenceCount": "integer",
    "rescheduledCount": "integer",
    "absentCount": "integer",
    "rescheduledByStaffCount": "integer",
    "rescheduledByPersonOnProbationCount": "integer",
    "lettersCount": "integer",
    "nationalStandardAppointmentsCount": "integer",
    "compliedAppointmentsCount": "integer"
  },
  "compliance": {
    "currentBreaches": "integer",
    "breachStarted": "boolean",
    "breachesOnCurrentOrderCount": "integer",
    "priorBreachesOnCurrentOrderCount": "integer",
    "failureToComplyCount": "integer"
  },
  "personalDetails": {
    "crn": "string",
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "contacts": [
      {
        "personSummary": {
          "name": {
            "forename": "string",
            "middleName": "string",
            "surname": "string"
          },
          "crn": "string",
          "offenderId": "integer",
          "pnc": "string",
          "dateOfBirth": "string"
        },
        "contactId": "integer",
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "relationship": "string",
        "relationshipType": "string",
        "address": {
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "district": "string",
          "town": "string",
          "county": "string",
          "postcode": "string",
          "lastUpdated": "string",
          "lastUpdatedBy": {
            "forename": "string",
            "middleName": "string",
            "surname": "string"
          }
        },
        "notes": "string",
        "phone": "string",
        "email": "string",
        "startDate": "string",
        "lastUpdated": "string",
        "lastUpdatedBy": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        }
      }
    ],
    "mainAddress": {
      "buildingName": "string",
      "buildingNumber": "string",
      "streetName": "string",
      "district": "string",
      "town": "string",
      "county": "string",
      "postcode": "string",
      "telephoneNumber": "string",
      "from": "string",
      "to": "string",
      "verified": "boolean",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "type": "string",
      "status": "string",
      "notes": "string"
    },
    "otherAddressCount": "integer",
    "previousAddressCount": "integer",
    "preferredGender": "string",
    "dateOfBirth": "string",
    "preferredName": "string",
    "previousSurname": "string",
    "preferredLanguage": "string",
    "genderIdentity": "string",
    "selfDescribedGender": "string",
    "aliases": [
      {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      }
    ],
    "telephoneNumber": "string",
    "mobileNumber": "string",
    "email": "string",
    "circumstances": {
      "circumstances": [
        {
          "subType": "string",
          "type": "string"
        }
      ],
      "lastUpdated": "string"
    },
    "disabilities": {
      "disabilities": [
        {
        }
      ],
      "lastUpdated": "string"
    },
    "provisions": {
      "provisions": [
        {
        }
      ],
      "lastUpdated": "string"
    },
    "pnc": "string",
    "sex": "string",
    "religionOrBelief": "string",
    "sexualOrientation": "string",
    "requiresInterpreter": "boolean",
    "documents": [
      {
        "id": "string",
        "name": "string",
        "lastUpdated": "string"
      }
    ]
  },
  "previousOrders": {
    "breaches": "integer",
    "count": "integer",
    "orders": [
      {
        "description": "string",
        "length": "integer",
        "endDate": "string",
        "startDate": "string",
        "status": "string",
        "mainOffence": "string",
        "breaches": "integer"
      }
    ]
  },
  "schedule": {
    "personSummary": {
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "crn": "string",
      "offenderId": "integer",
      "pnc": "string",
      "dateOfBirth": "string"
    },
    "appointments": [
      {
        "id": "integer",
        "eventNumber": "string",
        "type": "string",
        "startDateTime": "string",
        "endDateTime": "string",
        "rarToolKit": "string",
        "notes": "string",
        "isSensitive": "boolean",
        "hasOutcome": "boolean",
        "wasAbsent": "boolean",
        "officerName": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "isInitial": "boolean",
        "isNationalStandard": "boolean",
        "location": {
          "officeName": "string",
          "buildingName": "string",
          "buildingNumber": "string",
          "streetName": "string",
          "district": "string",
          "town": "string",
          "county": "string",
          "postcode": "string",
          "ldu": "string",
          "telephoneNumber": "string"
        },
        "rescheduled": "boolean",
        "rescheduledStaff": "boolean",
        "rescheduledPop": "boolean",
        "didTheyComply": "boolean",
        "absentWaitingEvidence": "boolean",
        "rearrangeOrCancelReason": "string",
        "rescheduledBy": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "repeating": "boolean",
        "nonComplianceReason": "string",
        "documents": [
          {
            "id": "string",
            "name": "string",
            "lastUpdated": "string"
          }
        ],
        "rarCategory": "string",
        "acceptableAbsence": "boolean",
        "acceptableAbsenceReason": "string",
        "isAppointment": "boolean",
        "isCommunication": "boolean",
        "action": "string",
        "isSystemContact": "boolean",
        "isEmailOrTextFromPop": "boolean",
        "isPhoneCallFromPop": "boolean",
        "isEmailOrTextToPop": "boolean",
        "isPhoneCallToPop": "boolean",
        "isPastAppointment": "boolean",
        "countsTowardsRAR": "boolean",
        "lastUpdated": "string",
        "lastUpdatedBy": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        }
      }
    ]
  },
  "sentences": [
    {
      "offenceDetails": {
        "eventNumber": "string",
        "offence": {
          "description": "string",
          "count": "integer"
        },
        "dateOfOffence": "string",
        "notes": "string",
        "additionalOffences": [
          {
            "description": "string",
            "count": "integer"
          }
        ]
      },
      "conviction": {
        "sentencingCourt": "string",
        "responsibleCourt": "string",
        "convictionDate": "string",
        "additionalSentences": [
          {
            "length": "integer",
            "amount": "integer",
            "notes": "string",
            "description": "string"
          }
        ]
      },
      "order": {
        "description": "string",
        "length": "integer",
        "endDate": "string",
        "startDate": "string",
        "status": "string",
        "mainOffence": "string",
        "breaches": "integer"
      },
      "requirements": [
        {
          "code": "string",
          "expectedStartDate": "string",
          "actualStartDate": "string",
          "expectedEndDate": "string",
          "actualEndDate": "string",
          "terminationReason": "string",
          "description": "string",
          "length": "integer",
          "lengthUnitValue": "string",
          "notes": "string",
          "rar": {
            "completed": "integer",
            "scheduled": "integer",
            "totalDays": "integer"
          }
        }
      ],
      "courtDocuments": [
        {
          "id": "string",
          "lastSaved": "string",
          "documentName": "string"
        }
      ],
      "unpaidWorkProgress": "string"
    }
  ],
  "registrations": [
    {
    }
  ]
}

Overview

/compliance/{crn}

get

Gets all compliance info for a person

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "currentSentences": [ { "eventNumber": "string", "mainOffence": { "description": "string", "count": "integer" }, "order": { "description": "string", "length": "integer", "endDate": "string", "startDate": "string", "status": "string", "mainOffence": "string", "breaches": "integer" }, "activeBreach": { "startDate": "string", "status": "string" }, "rar": { "completed": "integer", "scheduled": "integer", "totalDays": "integer" }, "rarCategory": "string", "compliance": { "currentBreaches": "integer", "breachStarted": "boolean", "breachesOnCurrentOrderCount": "integer", "priorBreachesOnCurrentOrderCount": "integer", "failureToComplyCount": "integer" }, "activity": { "acceptableAbsenceCount": "integer", "unacceptableAbsenceCount": "integer", "attendedButDidNotComplyCount": "integer", "outcomeNotRecordedCount": "integer", "waitingForEvidenceCount": "integer", "rescheduledCount": "integer", "absentCount": "integer", "rescheduledByStaffCount": "integer", "rescheduledByPersonOnProbationCount": "integer", "lettersCount": "integer", "nationalStandardAppointmentsCount": "integer", "compliedAppointmentsCount": "integer" } } ], "previousOrders": { "breaches": "integer", "count": "integer", "orders": [ { "description": "string", "length": "integer", "endDate": "string", "startDate": "string", "status": "string", "mainOffence": "string", "breaches": "integer" } ] } }	PersonCompliance

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "currentSentences": [
    {
      "eventNumber": "string",
      "mainOffence": {
        "description": "string",
        "count": "integer"
      },
      "order": {
        "description": "string",
        "length": "integer",
        "endDate": "string",
        "startDate": "string",
        "status": "string",
        "mainOffence": "string",
        "breaches": "integer"
      },
      "activeBreach": {
        "startDate": "string",
        "status": "string"
      },
      "rar": {
        "completed": "integer",
        "scheduled": "integer",
        "totalDays": "integer"
      },
      "rarCategory": "string",
      "compliance": {
        "currentBreaches": "integer",
        "breachStarted": "boolean",
        "breachesOnCurrentOrderCount": "integer",
        "priorBreachesOnCurrentOrderCount": "integer",
        "failureToComplyCount": "integer"
      },
      "activity": {
        "acceptableAbsenceCount": "integer",
        "unacceptableAbsenceCount": "integer",
        "attendedButDidNotComplyCount": "integer",
        "outcomeNotRecordedCount": "integer",
        "waitingForEvidenceCount": "integer",
        "rescheduledCount": "integer",
        "absentCount": "integer",
        "rescheduledByStaffCount": "integer",
        "rescheduledByPersonOnProbationCount": "integer",
        "lettersCount": "integer",
        "nationalStandardAppointmentsCount": "integer",
        "compliedAppointmentsCount": "integer"
      }
    }
  ],
  "previousOrders": {
    "breaches": "integer",
    "count": "integer",
    "orders": [
      {
        "description": "string",
        "length": "integer",
        "endDate": "string",
        "startDate": "string",
        "status": "string",
        "mainOffence": "string",
        "breaches": "integer"
      }
    ]
  }
}

PersonCompliance

/caseload/user/{username}

get

Gets caseloads for the user

Parameters

Parameter	In	Type	Required
username	path	string	true
page	query	integer	false
size	query	integer	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "totalPages": "integer", "totalElements": "integer", "provider": "string", "staff": { "forename": "string", "middleName": "string", "surname": "string" }, "caseload": [ { "caseName": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string" } ] }`	StaffCaseload

{
  "totalPages": "integer",
  "totalElements": "integer",
  "provider": "string",
  "staff": {
    "forename": "string",
    "middleName": "string",
    "surname": "string"
  },
  "caseload": [
    {
      "caseName": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "crn": "string"
    }
  ]
}

StaffCaseload

/caseload/user/{username}/teams

get

Gets the users teams

Parameters

Parameter	In	Type	Required	Description
username	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "provider": "string", "teams": [ { "description": "string", "code": "string" } ] }`	UserTeam

{
  "provider": "string",
  "teams": [
    {
      "description": "string",
      "code": "string"
    }
  ]
}

UserTeam

/caseload/team/{teamCode}

get

Gets the caseload for the team

Parameters

Parameter	In	Type	Required
teamCode	path	string	true
page	query	integer	false
size	query	integer	false

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "totalPages": "integer", "totalElements": "integer", "provider": "string", "team": { "description": "string", "code": "string" }, "caseload": [ { "staff": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "code": "string" }, "caseName": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string" } ] }`	TeamCaseload

{
  "totalPages": "integer",
  "totalElements": "integer",
  "provider": "string",
  "team": {
    "description": "string",
    "code": "string"
  },
  "caseload": [
    {
      "staff": {
        "name": {
          "forename": "string",
          "middleName": "string",
          "surname": "string"
        },
        "code": "string"
      },
      "caseName": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "crn": "string"
    }
  ]
}

TeamCaseload

/caseload/team/{teamCode}/staff

get

Gets the staff within the team

Parameters

Parameter	In	Type	Required	Description
teamCode	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK `{ "provider": "string", "staff": [ { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "code": "string" } ] }`	TeamStaff

{
  "provider": "string",
  "staff": [
    {
      "name": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "code": "string"
    }
  ]
}

TeamStaff

/activity/{crn}

get

Gets all activity for a person’

Parameters

Parameter	In	Type	Required	Description
crn	path	string	true

Responses

Status Description Schema

200

Status	Description	Schema
200	OK { "personSummary": { "name": { "forename": "string", "middleName": "string", "surname": "string" }, "crn": "string", "offenderId": "integer", "pnc": "string", "dateOfBirth": "string" }, "activities": [ { "id": "integer", "eventNumber": "string", "type": "string", "startDateTime": "string", "endDateTime": "string", "rarToolKit": "string", "notes": "string", "isSensitive": "boolean", "hasOutcome": "boolean", "wasAbsent": "boolean", "officerName": { "forename": "string", "middleName": "string", "surname": "string" }, "isInitial": "boolean", "isNationalStandard": "boolean", "location": { "officeName": "string", "buildingName": "string", "buildingNumber": "string", "streetName": "string", "district": "string", "town": "string", "county": "string", "postcode": "string", "ldu": "string", "telephoneNumber": "string" }, "rescheduled": "boolean", "rescheduledStaff": "boolean", "rescheduledPop": "boolean", "didTheyComply": "boolean", "absentWaitingEvidence": "boolean", "rearrangeOrCancelReason": "string", "rescheduledBy": { "forename": "string", "middleName": "string", "surname": "string" }, "repeating": "boolean", "nonComplianceReason": "string", "documents": [ { "id": "string", "name": "string", "lastUpdated": "string" } ], "rarCategory": "string", "acceptableAbsence": "boolean", "acceptableAbsenceReason": "string", "isAppointment": "boolean", "isCommunication": "boolean", "action": "string", "isSystemContact": "boolean", "isEmailOrTextFromPop": "boolean", "isPhoneCallFromPop": "boolean", "isEmailOrTextToPop": "boolean", "isPhoneCallToPop": "boolean", "isPastAppointment": "boolean", "countsTowardsRAR": "boolean", "lastUpdated": "string", "lastUpdatedBy": { "forename": "string", "middleName": "string", "surname": "string" } } ] }	PersonActivity

{
  "personSummary": {
    "name": {
      "forename": "string",
      "middleName": "string",
      "surname": "string"
    },
    "crn": "string",
    "offenderId": "integer",
    "pnc": "string",
    "dateOfBirth": "string"
  },
  "activities": [
    {
      "id": "integer",
      "eventNumber": "string",
      "type": "string",
      "startDateTime": "string",
      "endDateTime": "string",
      "rarToolKit": "string",
      "notes": "string",
      "isSensitive": "boolean",
      "hasOutcome": "boolean",
      "wasAbsent": "boolean",
      "officerName": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "isInitial": "boolean",
      "isNationalStandard": "boolean",
      "location": {
        "officeName": "string",
        "buildingName": "string",
        "buildingNumber": "string",
        "streetName": "string",
        "district": "string",
        "town": "string",
        "county": "string",
        "postcode": "string",
        "ldu": "string",
        "telephoneNumber": "string"
      },
      "rescheduled": "boolean",
      "rescheduledStaff": "boolean",
      "rescheduledPop": "boolean",
      "didTheyComply": "boolean",
      "absentWaitingEvidence": "boolean",
      "rearrangeOrCancelReason": "string",
      "rescheduledBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      },
      "repeating": "boolean",
      "nonComplianceReason": "string",
      "documents": [
        {
          "id": "string",
          "name": "string",
          "lastUpdated": "string"
        }
      ],
      "rarCategory": "string",
      "acceptableAbsence": "boolean",
      "acceptableAbsenceReason": "string",
      "isAppointment": "boolean",
      "isCommunication": "boolean",
      "action": "string",
      "isSystemContact": "boolean",
      "isEmailOrTextFromPop": "boolean",
      "isPhoneCallFromPop": "boolean",
      "isEmailOrTextToPop": "boolean",
      "isPhoneCallToPop": "boolean",
      "isPastAppointment": "boolean",
      "countsTowardsRAR": "boolean",
      "lastUpdated": "string",
      "lastUpdatedBy": {
        "forename": "string",
        "middleName": "string",
        "surname": "string"
      }
    }
  ]
}

PersonActivity

Schemas

CaseAccess

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

AdditionalSentence

Name	Type	Required
length	integer	false
amount	integer	false
notes	string	false
description	string	true

Conviction

Name	Type	Required	Schema
sentencingCourt	string	false
responsibleCourt	string	false
convictionDate	string	false
additionalSentences	array	true	AdditionalSentence

CourtDocument

Name	Type	Required
id	string	true
lastSaved	string	false
documentName	string	false

Name

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

Offence

Name	Type	Required	Description	Schema
description	string	true
count	integer	true

OffenceDetails

Name	Type	Required	Schema
eventNumber	string	true
offence	object	false	Offence
dateOfOffence	string	false
notes	string	false
additionalOffences	array	true	Offence

Order

Name	Type	Required
description	string	true
length	integer	false
endDate	string	false
startDate	string	true
status	string	false
mainOffence	string	false
breaches	integer	false

PersonSummary

Name	Type	Required	Schema
name	object	true	Name
crn	string	true
offenderId	integer	true
pnc	string	false
dateOfBirth	string	true

ProbationHistory

Name	Type	Required
numberOfTerminatedEvents	integer	true
dateOfMostRecentTerminatedEvent	string	false
numberOfTerminatedEventBreaches	integer	true
numberOfProfessionalContacts	integer	true

Rar

Name	Type	Required
completed	integer	true
scheduled	integer	true
totalDays	integer	true

Requirement

Name	Type	Required	Schema
code	string	true
expectedStartDate	string	false
actualStartDate	string	true
expectedEndDate	string	false
actualEndDate	string	false
terminationReason	string	false
description	string	true
length	integer	false
lengthUnitValue	string	false
notes	string	false
rar	object	false	Rar

Sentence

Name	Type	Required	Schema
offenceDetails	object	true	OffenceDetails
conviction	object	false	Conviction
order	object	false	Order
requirements	array	true	Requirement
courtDocuments	array	true	CourtDocument
unpaidWorkProgress	string	false

SentenceOverview

Name	Type	Required	Schema
personSummary	object	true	PersonSummary
sentences	array	true	Sentence
probationHistory	object	true	ProbationHistory

PreviousOrder

Name	Type	Required
title	string	true
description	string	false
terminationDate	string	false

PreviousOrderHistory

Name	Type	Required	Description	Schema
name	object	true		Name
previousOrders	array	true		PreviousOrder

Offences

Name	Type	Required	Schema
name	object	true	Name
mainOffence	object	true	Offence
additionalOffences	array	true	Offence

Contact

Name	Type	Required
name	string	true
email	string	false
telephoneNumber	string	false
provider	string	true
probationDeliveryUnit	string	true
team	string	false
allocatedUntil	string	false

ProfessionalContact

Name	Type	Required	Description	Schema
name	object	true		Name
contacts	array	true		Contact

Activity

Name	Type	Required	Schema
id	integer	true
eventNumber	string	false
type	string	true
startDateTime	string	true
endDateTime	string	false
rarToolKit	string	false
notes	string	false
isSensitive	boolean	false
hasOutcome	boolean	true
wasAbsent	boolean	false
officerName	object	false	Name
isInitial	boolean	true
isNationalStandard	boolean	true
location	object	false	OfficeAddress
rescheduled	boolean	true
rescheduledStaff	boolean	true
rescheduledPop	boolean	true
didTheyComply	boolean	false
absentWaitingEvidence	boolean	false
rearrangeOrCancelReason	string	false
rescheduledBy	object	false	Name
repeating	boolean	false
nonComplianceReason	string	false
documents	array	true	Document
rarCategory	string	false
acceptableAbsence	boolean	false
acceptableAbsenceReason	string	false
isAppointment	boolean	true
isCommunication	boolean	true
action	string	false
isSystemContact	boolean	false
isEmailOrTextFromPop	boolean	false
isPhoneCallFromPop	boolean	false
isEmailOrTextToPop	boolean	false
isPhoneCallToPop	boolean	false
isPastAppointment	boolean	true
countsTowardsRAR	boolean	false
lastUpdated	string	true
lastUpdatedBy	object	true	Name

Document

Name	Type	Required
id	string	true
name	string	true
lastUpdated	string	false

OfficeAddress

Name	Type	Required
officeName	string	false
buildingName	string	false
buildingNumber	string	false
streetName	string	false
district	string	false
town	string	false
county	string	false
postcode	string	false
ldu	string	true
telephoneNumber	string	false

Schedule

Name	Type	Required	Description	Schema
personSummary	object	true		PersonSummary
appointments	array	true		Activity

PersonAppointment

Name	Type	Required	Description	Schema
personSummary	object	true		PersonSummary
appointment	object	true		Activity

PersonRiskFlags

Name	Type	Required	Schema
personSummary	object	true	PersonSummary
riskFlags	array	true	RiskFlag
removedRiskFlags	array	true	RiskFlag

RiskFlag

Name	Type	Required	Schema
id	integer	true
description	string	true
notes	string	false
nextReviewDate	string	false
mostRecentReviewDate	string	false
createdDate	string	true
createdBy	object	true	Name
removed	boolean	true
removalHistory	array	true	RiskFlagRemoval

RiskFlagRemoval

Name	Type	Required	Schema
notes	string	false
removalDate	string	true
removedBy	object	true	Name

PersonRiskFlag

Name	Type	Required	Description	Schema
personSummary	object	true		PersonSummary
riskFlag	object	true		RiskFlag

Address

Name	Type	Required	Schema
buildingName	string	false
buildingNumber	string	false
streetName	string	false
district	string	false
town	string	false
county	string	false
postcode	string	false
telephoneNumber	string	false
from	string	true
to	string	false
verified	boolean	false
lastUpdated	string	false
lastUpdatedBy	object	true	Name
type	string	false
status	string	false
notes	string	false

Circumstances

Name	Type	Required	Description	Schema
circumstances	array	true		PersonalCircumstance
lastUpdated	string	false

ContactAddress

Name	Type	Required	Schema
buildingName	string	false
buildingNumber	string	false
streetName	string	false
district	string	false
town	string	false
county	string	false
postcode	string	false
lastUpdated	string	true
lastUpdatedBy	object	true	Name

Disabilities

Name	Type	Required	Description	Schema
disabilities	array	true
lastUpdated	string	false

PersonalCircumstance

Name	Type	Required	Description	Schema
subType	string	true
type	string	true

PersonalContact

Name	Type	Required	Schema
personSummary	object	true	PersonSummary
contactId	integer	true
name	object	true	Name
relationship	string	false
relationshipType	string	true
address	object	false	ContactAddress
notes	string	false
phone	string	false
email	string	false
startDate	string	false
lastUpdated	string	true
lastUpdatedBy	object	true	Name

PersonalDetails

Name	Type	Required	Schema
crn	string	true
name	object	true	Name
contacts	array	true	PersonalContact
mainAddress	object	false	Address
otherAddressCount	integer	true
previousAddressCount	integer	true
preferredGender	string	true
dateOfBirth	string	true
preferredName	string	false
previousSurname	string	false
preferredLanguage	string	false
genderIdentity	string	false
selfDescribedGender	string	false
aliases	array	true	Name
telephoneNumber	string	false
mobileNumber	string	false
email	string	false
circumstances	object	true	Circumstances
disabilities	object	true	Disabilities
provisions	object	true	Provisions
pnc	string	false
sex	string	true
religionOrBelief	string	false
sexualOrientation	string	false
requiresInterpreter	boolean	false
documents	array	true	Document

Provisions

Name	Type	Required	Description	Schema
provisions	array	true
lastUpdated	string	false

Provision

Name	Type	Required	Schema
description	string	true
notes	string	false
startDate	string	true
lastUpdated	string	true
lastUpdatedBy	object	true	Name

ProvisionOverview

Name	Type	Required	Description	Schema
personSummary	object	true		PersonSummary
provisions	array	true		Provision

StreamingResponseBody

Disability

Name	Type	Required	Schema
description	string	true
notes	string	false
startDate	string	true
lastUpdated	string	true
lastUpdatedBy	object	true	Name

DisabilityOverview

Name	Type	Required	Description	Schema
personSummary	object	true		PersonSummary
disabilities	array	true		Disability

Circumstance

Name	Type	Required	Schema
type	string	true
subType	string	true
notes	string	false
verified	boolean	false
startDate	string	true
lastUpdated	string	true
lastUpdatedBy	object	true	Name

CircumstanceOverview

Name	Type	Required	Description	Schema
personSummary	object	true		PersonSummary
circumstances	array	true		Circumstance

AddressOverview

Name	Type	Required	Schema
personSummary	object	true	PersonSummary
mainAddress	object	false	Address
otherAddresses	array	true	Address
previousAddresses	array	true	Address

ActivityCount

Name	Type	Required
acceptableAbsenceCount	integer	true
unacceptableAbsenceCount	integer	true
attendedButDidNotComplyCount	integer	true
outcomeNotRecordedCount	integer	true
waitingForEvidenceCount	integer	true
rescheduledCount	integer	true
absentCount	integer	true
rescheduledByStaffCount	integer	true
rescheduledByPersonOnProbationCount	integer	true
lettersCount	integer	true
nationalStandardAppointmentsCount	integer	true
compliedAppointmentsCount	integer	true

Compliance

Name	Type	Required
currentBreaches	integer	true
breachStarted	boolean	true
breachesOnCurrentOrderCount	integer	true
priorBreachesOnCurrentOrderCount	integer	true
failureToComplyCount	integer	true

Overview

Name	Type	Required	Schema
appointmentsWithoutOutcome	integer	true
absencesWithoutEvidence	integer	true
activity	object	false	ActivityCount
compliance	object	false	Compliance
personalDetails	object	true	PersonalDetails
previousOrders	object	true	PreviousOrders
schedule	object	true	Schedule
sentences	array	true	Sentence
registrations	array	true

PreviousOrders

Name	Type	Required	Schema
breaches	integer	true
count	integer	true
orders	array	true	Order

Breach

Name	Type	Required	Description	Schema
startDate	string	false
status	string	false

PersonCompliance

Name	Type	Required	Schema
personSummary	object	true	PersonSummary
currentSentences	array	true	SentenceCompliance
previousOrders	object	true	PreviousOrders

SentenceCompliance

Name	Type	Required	Schema
eventNumber	string	true
mainOffence	object	true	Offence
order	object	false	Order
activeBreach	object	false	Breach
rar	object	false	Rar
rarCategory	string	false
compliance	object	true	Compliance
activity	object	true	ActivityCount

StaffCase

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

StaffCaseload

Name	Type	Required	Schema
totalPages	integer	true
totalElements	integer	true
provider	string	false
staff	object	true	Name
caseload	array	true	StaffCase

Team

Name	Type	Required	Description	Schema
description	string	true
code	string	true

UserTeam

Name	Type	Required	Description	Schema
provider	string	false
teams	array	true		Team

Staff

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

TeamCase

Name	Type	Required	Schema
staff	object	true	Staff
caseName	object	true	Name
crn	string	true

TeamCaseload

Name	Type	Required	Schema
totalPages	integer	true
totalElements	integer	true
provider	string	false
team	object	true	Team
caseload	array	true	TeamCase

TeamStaff

Name	Type	Required	Description	Schema
provider	string	false
staff	array	true		Staff

PersonActivity

Name	Type	Required	Description	Schema
personSummary	object	true		PersonSummary
activities	array	true		Activity