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 .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/GetRiskMatrix 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
		}
	},
	Name: String,
	Revision: 0,
	XDimension: 
	{
		Label: String,
		RangeType: Alpha,
		RangeMin: 0,
		RangeMax: 0,
		Values: 
		[
			{
				Position: 0,
				DisplayValue: String,
				Label: String
			}
		]
	},
	YDimension: 
	{
		Label: String,
		RangeType: Alpha,
		RangeMin: 0,
		RangeMax: 0,
		Perspectives: 
		[
			{
				Label: String,
				Index: 0,
				Values: 
				[
					{
						Position: 0,
						DisplayValue: String,
						Label: String
					}
				]
			}
		]
	}
}