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 .xml suffix or ?format=xml

HTTP + XML

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

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

<GetReportRiskAssessments xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <ReportId>00000000-0000-0000-0000-000000000000</ReportId>
</GetReportRiskAssessments>
                    
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetReportRiskAssessmentsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <StatusDescription>String</StatusDescription>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
  <ReportRiskAssessments>
    <ReportRiskAssessmentDetail>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <RiskAssessmentValue>0</RiskAssessmentValue>
      <SuggestedAction>String</SuggestedAction>
      <Comment>String</Comment>
      <PerformedBy>String</PerformedBy>
      <PerformedById>00000000-0000-0000-0000-000000000000</PerformedById>
      <PerformedDate>String</PerformedDate>
      <RiskRating>String</RiskRating>
      <MatrixName>String</MatrixName>
      <MatrixDescription>String</MatrixDescription>
      <MatrixRevisionNumber>0</MatrixRevisionNumber>
    </ReportRiskAssessmentDetail>
  </ReportRiskAssessments>
</GetReportRiskAssessmentsResponse>