API Reference

The following documentation is also available in these formats:

• OpenAPI JSON
• OpenAPI YAML
• Swagger UI

API Reference v1.0

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

get

Parameters

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

Responses

Status	Description	Schema
200	OK { }	JsonNode

/assessments/{id}/risk-predictors

get

Parameters

Parameter	In	Type	Required	Description
id	path	integer	true

Responses

Status	Description	Schema
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

Parameter	In	Type	Required	Description
nomsId	path	string	true

Responses

Status	Description	Schema
200	OK { "crn": "string", "nomsId": "string", "timeline": [ { "id": "integer", "completedAt": "string", "type": "string", "status": "string" } ] }	Timeline

Schemas

JsonNode

RiskPrediction

Name	Type	Required	Description	Schema
groupReconvictionScore	object	false		YearPredictor
violencePredictorScore	object	false		YearPredictor
generalPredictorScore	object	false		YearPredictor
riskOfSeriousRecidivismScore	object	false		RsrPredictor
sexualPredictorScore	object	false		SexualPredictor

RsrPredictor

Name	Type	Required	Description	Schema
scoreLevel	string	false
percentageScore	number	false

SexualPredictor

Name	Type	Required	Description	Schema
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

Name	Type	Required	Description	Schema
oneYear	number	false
twoYears	number	false
scoreLevel	string	false

AssessmentSummary

Name	Type	Required	Description	Schema
id	integer	true
completedAt	string	false
type	string	true
status	string	true

Timeline

Name	Type	Required	Description	Schema
crn	string	false
nomsId	string	false
timeline	array	true		AssessmentSummary