Coruson API

<back to all web services

GetReportRiskAssessments

Coruson Reports

Requires Authentication
The following routes are available for this service:
GET/api/reports/{ReportId}/riskassessmentsQuery for the Risk Assessments of a Coruson Report
GetReportRiskAssessments Parameters:
NameParameterData TypeRequiredDescription
ReportIdpathGuidYesThe unique identifier of the report to retrieve risk assessments for.
RequestBase Parameters:
NameParameterData TypeRequiredDescription
VersionformintNo
GetReportRiskAssessmentsResponse Parameters:
NameParameterData TypeRequiredDescription
ReportRiskAssessmentsformList<ReportRiskAssessmentDetail>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusDescriptionformstringNo
ResponseStatusformResponseStatusNo
ReportRiskAssessmentDetail Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
RiskAssessmentValueformintNo
SuggestedActionformstringNo
CommentformstringNo
PerformedByformstringNo
PerformedByIdformGuidNo
PerformedDateformstringNo
RiskRatingDisplayValueformstringNo
MatrixNameformstringNo
MatrixDescriptionformstringNo
MatrixRevisionNumberformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

                    POST /jsv/reply/GetReportRiskAssessments HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/jsv
Content-Length: length

{
	Version: 0
}
                    
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	StatusDescription: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	ReportRiskAssessments: 
	[
		{
			RiskAssessmentValue: 0,
			SuggestedAction: String,
			Comment: String,
			PerformedBy: String,
			PerformedDate: String,
			RiskRating: String,
			MatrixName: String,
			MatrixDescription: String,
			MatrixRevisionNumber: 0
		}
	]
}