Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/rosh/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentId": "integer",
  "assessmentType": "string",
  "dateCompleted": "string",
  "assessorSignedDate": "string",
  "initiationDate": "string",
  "assessmentStatus": "string",
  "superStatus": "string",
  "laterWIPAssessmentExists": "boolean",
  "limitedAccessOffender": "boolean",
  "lastUpdatedDate": "string",
  "rosh": {
    "riskChildrenCommunity": "string",
    "riskPrisonersCustody": "string",
    "riskStaffCustody": "string",
    "riskStaffCommunity": "string",
    "riskKnownAdultCustody": "string",
    "riskKnownAdultCommunity": "string",
    "riskPublicCustody": "string",
    "riskPublicCommunity": "string",
    "riskChildrenCustody": "string"
  }
}
 RoshDetails

/rosh-summary/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentId": "integer",
  "assessmentType": "string",
  "dateCompleted": "string",
  "assessorSignedDate": "string",
  "initiationDate": "string",
  "assessmentStatus": "string",
  "superStatus": "string",
  "laterWIPAssessmentExists": "boolean",
  "limitedAccessOffender": "boolean",
  "lastUpdatedDate": "string",
  "roshSummary": {
    "whoIsAtRisk": "string",
    "riskReductionLikelyTo": "string",
    "riskIncreaseLikelyTo": "string",
    "riskGreatest": "string",
    "natureOfRisk": "string"
  }
}
 RoshSummaryDetails

/risk-to-the-individual/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentId": "integer",
  "assessmentType": "string",
  "dateCompleted": "string",
  "assessorSignedDate": "string",
  "initiationDate": "string",
  "assessmentStatus": "string",
  "superStatus": "string",
  "laterWIPAssessmentExists": "boolean",
  "limitedAccessOffender": "boolean",
  "lastUpdatedDate": "string",
  "riskToTheIndividual": {
    "concernsRiskOfSuicide": "boolean",
    "currentConcernsBreachOfTrustText": "string",
    "currentConcernsBreachOfTrust": "boolean",
    "riskOfSeriousHarm": "string",
    "previousVulnerability": "string",
    "currentVulnerability": "string",
    "previousCustodyHostelCoping": "string",
    "currentCustodyHostelCoping": "string",
    "previousConcernsSelfHarmSuicide": "string",
    "currentConcernsSelfHarmSuicide": "string",
    "currentConcernsRiskOfSelfHarm": "boolean",
    "currentConcernsRiskOfSuicide": "boolean",
    "concernsBreachOfTrust": "boolean",
    "concernsRiskOfSelfHarm": "boolean"
  }
}
 RiskToTheIndividualDetails

/risk-management-plan/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentId": "integer",
  "assessmentType": "string",
  "dateCompleted": "string",
  "assessorSignedDate": "string",
  "initiationDate": "string",
  "assessmentStatus": "string",
  "superStatus": "string",
  "laterWIPAssessmentExists": "boolean",
  "limitedAccessOffender": "boolean",
  "lastUpdatedDate": "string",
  "riskManagementPlan": {
    "furtherConsiderations": "string",
    "additionalComments": "string",
    "contingencyPlans": "string",
    "victimSafetyPlanning": "string",
    "interventionsAndTreatment": "string",
    "monitoringAndControl": "string",
    "supervision": "string",
    "keyInformationAboutCurrentSituation": "string"
  }
}
 RiskManagementPlanDetails

/risk-assessment/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentId": "integer",
  "assessmentType": "string",
  "dateCompleted": "string",
  "assessorSignedDate": "string",
  "initiationDate": "string",
  "assessmentStatus": "string",
  "superStatus": "string",
  "laterWIPAssessmentExists": "boolean",
  "limitedAccessOffender": "boolean",
  "lastUpdatedDate": "string",
  "riskAssessment": {
    "currentOffenceDetails": "string",
    "currentSources": "string",
    "currentWhyDone": "string",
    "currentAnyoneElsePresent": "string",
    "currentWhoVictims": "string",
    "currentHowDone": "string",
    "currentWhereAndWhen": "string",
    "previousSources": "string",
    "previousWhyDone": "string",
    "previousAnyoneElsePresent": "string",
    "previousWhoVictims": "string",
    "previousHowDone": "string",
    "previousWhereAndWhen": "string",
    "previousWhatDone": "string"
  }
}
 RiskAssessmentDetails

/offence-details/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentId": "integer",
  "assessmentType": "string",
  "dateCompleted": "string",
  "assessorSignedDate": "string",
  "initiationDate": "string",
  "assessmentStatus": "string",
  "superStatus": "string",
  "laterWIPAssessmentExists": "boolean",
  "limitedAccessOffender": "boolean",
  "lastUpdatedDate": "string",
  "offence": {
    "offenceAnalysis": "string",
    "othersInvolved": "string",
    "issueContributingToRisk": "string",
    "offenceMotivation": "string",
    "victimImpact": "string",
    "victimPerpetratorRel": "string",
    "victimInfo": "string",
    "patternOffending": "string",
    "acceptsResponsibility": "string"
  }
}
 OffenceDetails

/needs-details/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentId": "integer",
  "assessmentType": "string",
  "dateCompleted": "string",
  "assessorSignedDate": "string",
  "initiationDate": "string",
  "assessmentStatus": "string",
  "superStatus": "string",
  "laterWIPAssessmentExists": "boolean",
  "limitedAccessOffender": "boolean",
  "lastUpdatedDate": "string",
  "needs": {
    "offenceAnalysisDetails": "string",
    "emotionalIssuesDetails": "string",
    "drugIssuesDetails": "string",
    "alcoholIssuesDetails": "string",
    "lifestyleIssuesDetails": "string",
    "relationshipIssuesDetails": "string",
    "financeIssuesDetails": "string",
    "educationTrainingEmploymentIssuesDetails": "string",
    "accommodationIssuesDetails": "string",
    "attitudeIssuesDetails": "string",
    "thinkingBehaviouralIssuesDetails": "string"
  },
  "linksToHarm": {
    "accommodationLinkedToHarm": "boolean",
    "educationTrainingEmploymentLinkedToHarm": "boolean",
    "financeLinkedToHarm": "boolean",
    "relationshipLinkedToHarm": "boolean",
    "lifestyleLinkedToHarm": "boolean",
    "drugLinkedToHarm": "boolean",
    "alcoholLinkedToHarm": "boolean",
    "emotionalLinkedToHarm": "boolean",
    "thinkingBehaviouralLinkedToHarm": "boolean",
    "attitudeLinkedToHarm": "boolean"
  },
  "linksToReOffending": {
    "accommodationLinkedToReOffending": "boolean",
    "educationTrainingEmploymentLinkedToReOffending": "boolean",
    "financeLinkedToReOffending": "boolean",
    "relationshipLinkedToReOffending": "boolean",
    "lifestyleLinkedToReOffending": "boolean",
    "drugLinkedToReOffending": "boolean",
    "alcoholLinkedToReOffending": "boolean",
    "emotionalLinkedToReOffending": "boolean",
    "thinkingBehaviouralLinkedToReOffending": "boolean",
    "attitudeLinkedToReOffending": "boolean"
  }
}
 NeedsDetails

/latest-assessment/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentPk": "integer",
  "assessmentType": "string",
  "initiationDate": "string",
  "status": "string",
  "completedDate": "string"
}
 OasysTimelineAssessment

/health-details/{crn}

get

Parameters

ParameterInTypeRequiredDescription
crn path string true

Responses

StatusDescriptionSchema
200

OK

{
  "assessmentId": "integer",
  "assessmentType": "string",
  "dateCompleted": "string",
  "assessorSignedDate": "string",
  "initiationDate": "string",
  "assessmentStatus": "string",
  "superStatus": "string",
  "laterWIPAssessmentExists": "boolean",
  "limitedAccessOffender": "boolean",
  "lastUpdatedDate": "string",
  "health": {
    "generalHealth": "boolean",
    "generalHealthSpecify": "string",
    "electronicMonitoringSpecify": "string",
    "electronicMonitoringElectricity": "boolean",
    "electronicMonitoring": "boolean",
    "generalHeathSpecify": "string",
    "healthIssues": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "drugsMisuse": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "chaoticLifestyle": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "religiousOrCulturalRequirements": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "transportDifficulties": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "employmentCommitments": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "educationCommitments": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "childCareAndCarers": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "disability": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "psychiatricPsychologicalRequirements": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "levelOfMotivation": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "learningDifficulties": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "literacyProblems": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "poorCommunicationSkills": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "needForInterpreter": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    },
    "alcoholMisuse": {
      "community": "string",
      "electronicMonitoring": "string",
      "programme": "string"
    }
  }
}
 HealthDetails

Schemas

Rosh

NameTypeRequiredDescriptionSchema
riskChildrenCommunity string false
riskPrisonersCustody string false
riskStaffCustody string false
riskStaffCommunity string false
riskKnownAdultCustody string false
riskKnownAdultCommunity string false
riskPublicCustody string false
riskPublicCommunity string false
riskChildrenCustody string false

RoshDetails

NameTypeRequiredDescriptionSchema
assessmentId integer true
assessmentType string true
dateCompleted string false
assessorSignedDate string false
initiationDate string true
assessmentStatus string true
superStatus string false
laterWIPAssessmentExists boolean false
limitedAccessOffender boolean true
lastUpdatedDate string false
rosh object true Rosh

RoshSummary

NameTypeRequiredDescriptionSchema
whoIsAtRisk string false
riskReductionLikelyTo string false
riskIncreaseLikelyTo string false
riskGreatest string false
natureOfRisk string false

RoshSummaryDetails

NameTypeRequiredDescriptionSchema
assessmentId integer true
assessmentType string true
dateCompleted string false
assessorSignedDate string false
initiationDate string true
assessmentStatus string true
superStatus string false
laterWIPAssessmentExists boolean false
limitedAccessOffender boolean true
lastUpdatedDate string false
roshSummary object true RoshSummary

RiskToTheIndividual

NameTypeRequiredDescriptionSchema
concernsRiskOfSuicide boolean false
currentConcernsBreachOfTrustText string false
currentConcernsBreachOfTrust boolean false
riskOfSeriousHarm string false
previousVulnerability string false
currentVulnerability string false
previousCustodyHostelCoping string false
currentCustodyHostelCoping string false
previousConcernsSelfHarmSuicide string false
currentConcernsSelfHarmSuicide string false
currentConcernsRiskOfSelfHarm boolean false
currentConcernsRiskOfSuicide boolean false
concernsBreachOfTrust boolean false
concernsRiskOfSelfHarm boolean false

RiskToTheIndividualDetails

NameTypeRequiredDescriptionSchema
assessmentId integer true
assessmentType string true
dateCompleted string false
assessorSignedDate string false
initiationDate string true
assessmentStatus string true
superStatus string false
laterWIPAssessmentExists boolean false
limitedAccessOffender boolean true
lastUpdatedDate string false
riskToTheIndividual object true RiskToTheIndividual

RiskManagementPlan

NameTypeRequiredDescriptionSchema
furtherConsiderations string false
additionalComments string false
contingencyPlans string false
victimSafetyPlanning string false
interventionsAndTreatment string false
monitoringAndControl string false
supervision string false
keyInformationAboutCurrentSituation string false

RiskManagementPlanDetails

NameTypeRequiredDescriptionSchema
assessmentId integer true
assessmentType string true
dateCompleted string false
assessorSignedDate string false
initiationDate string true
assessmentStatus string true
superStatus string false
laterWIPAssessmentExists boolean false
limitedAccessOffender boolean true
lastUpdatedDate string false
riskManagementPlan object true RiskManagementPlan

RiskAssessment

NameTypeRequiredDescriptionSchema
currentOffenceDetails string false
currentSources string false
currentWhyDone string false
currentAnyoneElsePresent string false
currentWhoVictims string false
currentHowDone string false
currentWhereAndWhen string false
previousSources string false
previousWhyDone string false
previousAnyoneElsePresent string false
previousWhoVictims string false
previousHowDone string false
previousWhereAndWhen string false
previousWhatDone string false

RiskAssessmentDetails

NameTypeRequiredDescriptionSchema
assessmentId integer true
assessmentType string true
dateCompleted string false
assessorSignedDate string false
initiationDate string true
assessmentStatus string true
superStatus string false
laterWIPAssessmentExists boolean false
limitedAccessOffender boolean true
lastUpdatedDate string false
riskAssessment object true RiskAssessment

Offence

NameTypeRequiredDescriptionSchema
offenceAnalysis string false
othersInvolved string false
issueContributingToRisk string false
offenceMotivation string false
victimImpact string false
victimPerpetratorRel string false
victimInfo string false
patternOffending string false
acceptsResponsibility string false

OffenceDetails

NameTypeRequiredDescriptionSchema
assessmentId integer true
assessmentType string true
dateCompleted string false
assessorSignedDate string false
initiationDate string true
assessmentStatus string true
superStatus string false
laterWIPAssessmentExists boolean false
limitedAccessOffender boolean true
lastUpdatedDate string false
offence object false Offence

LinksToHarm

NameTypeRequiredDescriptionSchema
accommodationLinkedToHarm boolean false
educationTrainingEmploymentLinkedToHarm boolean false
financeLinkedToHarm boolean false
relationshipLinkedToHarm boolean false
lifestyleLinkedToHarm boolean false
drugLinkedToHarm boolean false
alcoholLinkedToHarm boolean false
emotionalLinkedToHarm boolean false
thinkingBehaviouralLinkedToHarm boolean false
attitudeLinkedToHarm boolean false

LinksToReOffending

NameTypeRequiredDescriptionSchema
accommodationLinkedToReOffending boolean false
educationTrainingEmploymentLinkedToReOffending boolean false
financeLinkedToReOffending boolean false
relationshipLinkedToReOffending boolean false
lifestyleLinkedToReOffending boolean false
drugLinkedToReOffending boolean false
alcoholLinkedToReOffending boolean false
emotionalLinkedToReOffending boolean false
thinkingBehaviouralLinkedToReOffending boolean false
attitudeLinkedToReOffending boolean false

Needs

NameTypeRequiredDescriptionSchema
offenceAnalysisDetails string false
emotionalIssuesDetails string false
drugIssuesDetails string false
alcoholIssuesDetails string false
lifestyleIssuesDetails string false
relationshipIssuesDetails string false
financeIssuesDetails string false
educationTrainingEmploymentIssuesDetails string false
accommodationIssuesDetails string false
attitudeIssuesDetails string false
thinkingBehaviouralIssuesDetails string false

NeedsDetails

NameTypeRequiredDescriptionSchema
assessmentId integer true
assessmentType string true
dateCompleted string false
assessorSignedDate string false
initiationDate string true
assessmentStatus string true
superStatus string false
laterWIPAssessmentExists boolean false
limitedAccessOffender boolean true
lastUpdatedDate string false
needs object false Needs
linksToHarm object false LinksToHarm
linksToReOffending object false LinksToReOffending

OasysTimelineAssessment

NameTypeRequiredDescriptionSchema
assessmentPk integer true
assessmentType string true
initiationDate string true
status string true
completedDate string false

Health

NameTypeRequiredDescriptionSchema
generalHealth boolean false
generalHealthSpecify string false
electronicMonitoringSpecify string false
electronicMonitoringElectricity boolean false
electronicMonitoring boolean false
generalHeathSpecify string false
healthIssues object false HealthDetail
drugsMisuse object false HealthDetail
chaoticLifestyle object false HealthDetail
religiousOrCulturalRequirements object false HealthDetail
transportDifficulties object false HealthDetail
employmentCommitments object false HealthDetail
educationCommitments object false HealthDetail
childCareAndCarers object false HealthDetail
disability object false HealthDetail
psychiatricPsychologicalRequirements object false HealthDetail
levelOfMotivation object false HealthDetail
learningDifficulties object false HealthDetail
literacyProblems object false HealthDetail
poorCommunicationSkills object false HealthDetail
needForInterpreter object false HealthDetail
alcoholMisuse object false HealthDetail

HealthDetail

NameTypeRequiredDescriptionSchema
community string false
electronicMonitoring string false
programme string false

HealthDetails

NameTypeRequiredDescriptionSchema
assessmentId integer true
assessmentType string true
dateCompleted string false
assessorSignedDate string false
initiationDate string true
assessmentStatus string true
superStatus string false
laterWIPAssessmentExists boolean false
limitedAccessOffender boolean true
lastUpdatedDate string false
health object true Health