Skip to main content
API Reference

The following documentation is also available in these formats:

API Reference v1.0

/assessments/{id}/section/{name}

get

Parameters

ParameterInTypeRequiredDescription
id path integer true
name path string true

Responses

StatusDescriptionSchema
200

OK

{
}
 JsonNode

/assessments/{id}/risk-predictors

get

Parameters

ParameterInTypeRequiredDescription
id path integer true

Responses

StatusDescriptionSchema
200

OK

{
  "groupReconvictionScore": {
    "oneYear": "number",
    "twoYears": "number",
    "scoreLevel": "string"
  },
  "violencePredictorScore": {
    "oneYear": "number",
    "twoYears": "number",
    "scoreLevel": "string"
  },
  "generalPredictorScore": {
    "oneYear": "number",
    "twoYears": "number",
    "scoreLevel": "string"
  },
  "riskOfSeriousRecidivismScore": {
    "scoreLevel": "string",
    "percentageScore": "number"
  },
  "sexualPredictorScore": {
    "ospIndecentPercentageScore": "number",
    "ospContactPercentageScore": "number",
    "ospIndecentPercentageScoreLevel": "string",
    "ospContactPercentageScoreLevel": "string",
    "ospIndirectImagePercentageScore": "number",
    "ospDirectContactPercentageScore": "number",
    "ospIndirectImagePercentageScoreLevel": "string",
    "ospDirectContactPercentageScoreLevel": "string"
  }
}
 RiskPrediction

/assessments/timeline/{nomsId}

get

Parameters

ParameterInTypeRequiredDescription
nomsId path string true

Responses

StatusDescriptionSchema
200

OK

{
  "crn": "string",
  "nomsId": "string",
  "timeline": [
    {
      "id": "integer",
      "completedAt": "string",
      "type": "string",
      "status": "string"
    }
  ]
}
 Timeline

/assessments/pni/{nomsId}

get

Parameters

ParameterInTypeRequiredDescription
nomsId path string true
community query boolean true

Responses

StatusDescriptionSchema
200

OK

{
  "pniCalculation": {
    "sexDomain": {
      "level": "string",
      "score": "integer"
    },
    "thinkingDomain": {
      "level": "string",
      "score": "integer"
    },
    "relationshipDomain": {
      "level": "string",
      "score": "integer"
    },
    "selfManagementDomain": {
      "level": "string",
      "score": "integer"
    },
    "riskLevel": "string",
    "needLevel": "string",
    "totalDomainScore": "integer",
    "pni": "string",
    "saraRiskLevel": {
      "toPartner": "integer",
      "toOther": "integer"
    },
    "missingFields": [
      {
      }
    ]
  },
  "assessment": {
    "id": "integer",
    "ldc": {
      "score": "integer",
      "subTotal": "integer"
    },
    "ldcMessage": "string",
    "ogrs3Risk": "string",
    "ovpRisk": "string",
    "osp": {
      "cdc": "string",
      "iiic": "string"
    },
    "rsrPercentage": "number",
    "offenderAge": "integer",
    "questions": {
      "everCommittedSexualOffence": "string",
      "openSexualOffendingQuestions": "string",
      "sexualPreOccupation": "string",
      "offenceRelatedSexualInterests": "string",
      "emotionalCongruence": "string",
      "proCriminalAttitudes": "string",
      "hostileOrientation": "string",
      "relCloseFamily": "string",
      "prevCloseRelationships": "string",
      "easilyInfluenced": "string",
      "aggressiveControllingBehaviour": "string",
      "impulsivity": "string",
      "temperControl": "string",
      "problemSolvingSkills": "string",
      "difficultiesCoping": "string"
    }
  }
}
 PniResponse

Schemas

JsonNode

RiskPrediction

NameTypeRequiredDescriptionSchema
groupReconvictionScore object false YearPredictor
violencePredictorScore object false YearPredictor
generalPredictorScore object false YearPredictor
riskOfSeriousRecidivismScore object false RsrPredictor
sexualPredictorScore object false SexualPredictor

RsrPredictor

NameTypeRequiredDescriptionSchema
scoreLevel string false
percentageScore number false

SexualPredictor

NameTypeRequiredDescriptionSchema
ospIndecentPercentageScore number false
ospContactPercentageScore number false
ospIndecentPercentageScoreLevel string false
ospContactPercentageScoreLevel string false
ospIndirectImagePercentageScore number false
ospDirectContactPercentageScore number false
ospIndirectImagePercentageScoreLevel string false
ospDirectContactPercentageScoreLevel string false

YearPredictor

NameTypeRequiredDescriptionSchema
oneYear number false
twoYears number false
scoreLevel string false

AssessmentSummary

NameTypeRequiredDescriptionSchema
id integer true
completedAt string false
type string true
status string true

Timeline

NameTypeRequiredDescriptionSchema
crn string false
nomsId string false
timeline array true AssessmentSummary

Ldc

NameTypeRequiredDescriptionSchema
score integer true
subTotal integer true

LevelScore

NameTypeRequiredDescriptionSchema
level string true
score integer true

Osp

NameTypeRequiredDescriptionSchema
cdc string false
iiic string false

PniAssessment

NameTypeRequiredDescriptionSchema
id integer true
ldc object false Ldc
ldcMessage string false
ogrs3Risk string false
ovpRisk string false
osp object false Osp
rsrPercentage number false
offenderAge integer true
questions object true Questions

PniCalculation

NameTypeRequiredDescriptionSchema
sexDomain object true LevelScore
thinkingDomain object true LevelScore
relationshipDomain object true LevelScore
selfManagementDomain object true LevelScore
riskLevel string true
needLevel string true
totalDomainScore integer true
pni string true
saraRiskLevel object true SaraRiskLevel
missingFields array true

PniResponse

NameTypeRequiredDescriptionSchema
pniCalculation object false PniCalculation
assessment object false PniAssessment

Questions

NameTypeRequiredDescriptionSchema
everCommittedSexualOffence string true
openSexualOffendingQuestions string false
sexualPreOccupation string true
offenceRelatedSexualInterests string true
emotionalCongruence string true
proCriminalAttitudes string true
hostileOrientation string true
relCloseFamily string true
prevCloseRelationships string true
easilyInfluenced string true
aggressiveControllingBehaviour string true
impulsivity string true
temperControl string true
problemSolvingSkills string true
difficultiesCoping string true

SaraRiskLevel

NameTypeRequiredDescriptionSchema
toPartner integer true
toOther integer true