POST v1/Assessments

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AssessmentId	integer	None.
OffenderId	integer	None.
AssessmentTypeId	integer	None.
StaffDescription	string	String length: inclusive between 0 and 200
ModifiedBy	integer	None.
SealedFlag	byte	None.
AssessmentResponses	Collection of AssessmentResponse	None.
AssessmentStatusHistories	Collection of AssessmentStatusHistory	None.

Request Formats

application/json, text/json

Sample:

{
  "assessmentId": 1,
  "offenderId": 2,
  "assessmentTypeId": 3,
  "staffDescription": "sample string 4",
  "modifiedBy": 5,
  "sealedFlag": 64,
  "assessmentResponses": [
    {
      "assessmentResponseId": 1,
      "assessmentId": 2,
      "assessmentAnswerId": 3,
      "responseText1": "sample string 4",
      "responseText2": "sample string 5",
      "modifiedBy": 6,
      "sealedFlag": 64
    },
    {
      "assessmentResponseId": 1,
      "assessmentId": 2,
      "assessmentAnswerId": 3,
      "responseText1": "sample string 4",
      "responseText2": "sample string 5",
      "modifiedBy": 6,
      "sealedFlag": 64
    }
  ],
  "assessmentStatusHistories": [
    {
      "assessmentStatusHistoryId": 1,
      "assessmentId": 2,
      "assessmentStatusId": "sample string 3",
      "startDate": "2025-12-16T16:56:44.1875351+00:00",
      "comment": "sample string 5",
      "supervisionLevelId": "sample string 6",
      "autoScreenerScoreCutPointId": 1,
      "modifiedBy": 7,
      "sealedFlag": 64,
      "assessmentStatusHistoryReasons": [
        {
          "assessmentStatusHistoryReasonId": 1,
          "assessmentStatusHistoryId": 2,
          "assessmentStatusReasonId": "sample string 3",
          "modifiedBy": 4,
          "sealedFlag": 64
        },
        {
          "assessmentStatusHistoryReasonId": 1,
          "assessmentStatusHistoryId": 2,
          "assessmentStatusReasonId": "sample string 3",
          "modifiedBy": 4,
          "sealedFlag": 64
        }
      ]
    },
    {
      "assessmentStatusHistoryId": 1,
      "assessmentId": 2,
      "assessmentStatusId": "sample string 3",
      "startDate": "2025-12-16T16:56:44.1875351+00:00",
      "comment": "sample string 5",
      "supervisionLevelId": "sample string 6",
      "autoScreenerScoreCutPointId": 1,
      "modifiedBy": 7,
      "sealedFlag": 64,
      "assessmentStatusHistoryReasons": [
        {
          "assessmentStatusHistoryReasonId": 1,
          "assessmentStatusHistoryId": 2,
          "assessmentStatusReasonId": "sample string 3",
          "modifiedBy": 4,
          "sealedFlag": 64
        },
        {
          "assessmentStatusHistoryReasonId": 1,
          "assessmentStatusHistoryId": 2,
          "assessmentStatusReasonId": "sample string 3",
          "modifiedBy": 4,
          "sealedFlag": 64
        }
      ]
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Assessment

Name	Type	Additional information
AssessmentId	integer	None.
OffenderId	integer	None.
AssessmentTypeId	integer	None.
StaffDescription	string	String length: inclusive between 0 and 200
ModifiedBy	integer	None.
SealedFlag	byte	None.
AssessmentResponses	Collection of AssessmentResponse	None.
AssessmentStatusHistories	Collection of AssessmentStatusHistory	None.

Response Formats

application/json, text/json

Sample:

{
  "assessmentId": 1,
  "offenderId": 2,
  "assessmentTypeId": 3,
  "staffDescription": "sample string 4",
  "modifiedBy": 5,
  "sealedFlag": 64,
  "assessmentResponses": [
    {
      "assessmentResponseId": 1,
      "assessmentId": 2,
      "assessmentAnswerId": 3,
      "responseText1": "sample string 4",
      "responseText2": "sample string 5",
      "modifiedBy": 6,
      "sealedFlag": 64
    },
    {
      "assessmentResponseId": 1,
      "assessmentId": 2,
      "assessmentAnswerId": 3,
      "responseText1": "sample string 4",
      "responseText2": "sample string 5",
      "modifiedBy": 6,
      "sealedFlag": 64
    }
  ],
  "assessmentStatusHistories": [
    {
      "assessmentStatusHistoryId": 1,
      "assessmentId": 2,
      "assessmentStatusId": "sample string 3",
      "startDate": "2025-12-16T16:56:44.1875351+00:00",
      "comment": "sample string 5",
      "supervisionLevelId": "sample string 6",
      "autoScreenerScoreCutPointId": 1,
      "modifiedBy": 7,
      "sealedFlag": 64,
      "assessmentStatusHistoryReasons": [
        {
          "assessmentStatusHistoryReasonId": 1,
          "assessmentStatusHistoryId": 2,
          "assessmentStatusReasonId": "sample string 3",
          "modifiedBy": 4,
          "sealedFlag": 64
        },
        {
          "assessmentStatusHistoryReasonId": 1,
          "assessmentStatusHistoryId": 2,
          "assessmentStatusReasonId": "sample string 3",
          "modifiedBy": 4,
          "sealedFlag": 64
        }
      ]
    },
    {
      "assessmentStatusHistoryId": 1,
      "assessmentId": 2,
      "assessmentStatusId": "sample string 3",
      "startDate": "2025-12-16T16:56:44.1875351+00:00",
      "comment": "sample string 5",
      "supervisionLevelId": "sample string 6",
      "autoScreenerScoreCutPointId": 1,
      "modifiedBy": 7,
      "sealedFlag": 64,
      "assessmentStatusHistoryReasons": [
        {
          "assessmentStatusHistoryReasonId": 1,
          "assessmentStatusHistoryId": 2,
          "assessmentStatusReasonId": "sample string 3",
          "modifiedBy": 4,
          "sealedFlag": 64
        },
        {
          "assessmentStatusHistoryReasonId": 1,
          "assessmentStatusHistoryId": 2,
          "assessmentStatusReasonId": "sample string 3",
          "modifiedBy": 4,
          "sealedFlag": 64
        }
      ]
    }
  ]
}