POST v1/AssessmentResponses

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AssessmentResponseId	integer	None.
AssessmentId	integer	None.
AssessmentAnswerId	integer	None.
ResponseText1	string	String length: inclusive between 0 and 2000
ResponseText2	string	String length: inclusive between 0 and 2000
ModifiedBy	integer	None.
SealedFlag	byte	None.
Assessment	Assessment	None.

Request Formats

application/json, text/json

Sample:

{
  "assessmentResponseId": 1,
  "assessmentId": 2,
  "assessmentAnswerId": 3,
  "responseText1": "sample string 4",
  "responseText2": "sample string 5",
  "modifiedBy": 6,
  "sealedFlag": 64,
  "assessment": {
    "assessmentId": 1,
    "offenderId": 2,
    "assessmentTypeId": 3,
    "staffDescription": "sample string 4",
    "modifiedBy": 5,
    "sealedFlag": 64,
    "assessmentResponses": [],
    "assessmentStatusHistories": [
      {
        "assessmentStatusHistoryId": 1,
        "assessmentId": 2,
        "assessmentStatusId": "sample string 3",
        "startDate": "2024-09-12T13:04:26.4349058+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": "2024-09-12T13:04:26.4349058+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

AssessmentResponse

Name	Type	Additional information
AssessmentResponseId	integer	None.
AssessmentId	integer	None.
AssessmentAnswerId	integer	None.
ResponseText1	string	String length: inclusive between 0 and 2000
ResponseText2	string	String length: inclusive between 0 and 2000
ModifiedBy	integer	None.
SealedFlag	byte	None.
Assessment	Assessment	None.

Response Formats

application/json, text/json

Sample:

{
  "assessmentResponseId": 1,
  "assessmentId": 2,
  "assessmentAnswerId": 3,
  "responseText1": "sample string 4",
  "responseText2": "sample string 5",
  "modifiedBy": 6,
  "sealedFlag": 64,
  "assessment": {
    "assessmentId": 1,
    "offenderId": 2,
    "assessmentTypeId": 3,
    "staffDescription": "sample string 4",
    "modifiedBy": 5,
    "sealedFlag": 64,
    "assessmentResponses": [],
    "assessmentStatusHistories": [
      {
        "assessmentStatusHistoryId": 1,
        "assessmentId": 2,
        "assessmentStatusId": "sample string 3",
        "startDate": "2024-09-12T13:04:26.450469+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": "2024-09-12T13:04:26.450469+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
          }
        ]
      }
    ]
  }
}