Coruson API

GetRiskMatrix

Coruson Risk

The following routes are available for this service:
GET	/api/risks/riskmatrices/{MatrixRevisionId}	Get the dimension detail (X/Y ranges, scale and perspective ids) for a risk matrix revision

**GetRiskMatrix** Parameters:
Name	Parameter	Data Type	Required	Description
MatrixRevisionId	path	Guid	Yes	The matrix revision id (obtained from GET /risks/riskmatrices).

**RequestBase** Parameters:
Name	Parameter	Data Type	Required	Description
Version	form	int	No

**GetRiskMatrixResponse** Parameters:
Name	Parameter	Data Type	Required
MatrixRevisionId	form	Guid	No
MatrixId	form	Guid	No
Name	form	string	No
Revision	form	int	No
XDimension	form	RiskMatrixDimension	No
YDimension	form	RiskMatrixYDimension	No

**ResponseBase** Parameters:
Name	Parameter	Data Type	Required	Description
StatusDescription	form	string	No
ResponseStatus	form	ResponseStatus	No

**RiskMatrixDimension** Parameters:
Name	Parameter	Data Type	Required
DimensionId	form	Guid	No
Label	form	string	No
RangeType	form	RangeType	No
RangeMin	form	int	No
RangeMax	form	int	No
Values	form	List<RiskMatrixRangeValue>	No

**RiskMatrixRangeValue** Parameters:
Name	Parameter	Data Type	Required
Position	form	int	No
DisplayValue	form	string	No
Label	form	string	No

**RiskMatrixYDimension** Parameters:
Name	Parameter	Data Type	Required
DimensionId	form	Guid	No
Label	form	string	No
RangeType	form	RangeType	No
RangeMin	form	int	No
RangeMax	form	int	No
Perspectives	form	List<RiskMatrixPerspective>	No

**RiskMatrixPerspective** Parameters:
Name	Parameter	Data Type	Required
PerspectiveId	form	Guid	No
Label	form	string	No
Index	form	int	No
Values	form	List<RiskMatrixRangeValue>	No

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/GetRiskMatrix HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: application/xml
Content-Length: length

<GetRiskMatrix xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <MatrixRevisionId>00000000-0000-0000-0000-000000000000</MatrixRevisionId>
</GetRiskMatrix>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetRiskMatrixResponse 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>
  <MatrixRevisionId>00000000-0000-0000-0000-000000000000</MatrixRevisionId>
  <MatrixId>00000000-0000-0000-0000-000000000000</MatrixId>
  <Name>String</Name>
  <Revision>0</Revision>
  <XDimension>
    <DimensionId>00000000-0000-0000-0000-000000000000</DimensionId>
    <Label>String</Label>
    <RangeType>Alpha</RangeType>
    <RangeMin>0</RangeMin>
    <RangeMax>0</RangeMax>
    <Values>
      <RiskMatrixRangeValue>
        <Position>0</Position>
        <DisplayValue>String</DisplayValue>
        <Label>String</Label>
      </RiskMatrixRangeValue>
    </Values>
  </XDimension>
  <YDimension>
    <DimensionId>00000000-0000-0000-0000-000000000000</DimensionId>
    <Label>String</Label>
    <RangeType>Alpha</RangeType>
    <RangeMin>0</RangeMin>
    <RangeMax>0</RangeMax>
    <Perspectives>
      <RiskMatrixPerspective>
        <PerspectiveId>00000000-0000-0000-0000-000000000000</PerspectiveId>
        <Label>String</Label>
        <Index>0</Index>
        <Values>
          <RiskMatrixRangeValue>
            <Position>0</Position>
            <DisplayValue>String</DisplayValue>
            <Label>String</Label>
          </RiskMatrixRangeValue>
        </Values>
      </RiskMatrixPerspective>
    </Perspectives>
  </YDimension>
</GetRiskMatrixResponse>