Coruson API

<back to all web services

GetRiskMatrices

Coruson Risk

Requires Authentication
GetRiskMatrices Parameters:
NameParameterData TypeRequiredDescription
ReportIdqueryGuidNoOptional. When supplied, only risk matrices configured/available for this report are returned.
OrderByqueryMatrixOrderYesProperty to order by in Ascending order. Default is 'Name'.

Allowable Values

  • Default
  • Name
OrderByDescqueryMatrixOrderYesProperty to order by in Descending order.

Allowable Values

  • Default
  • Name
ThenByqueryMatrixOrderYesSecond Property to order by in Ascending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.

Allowable Values

  • Default
  • Name
ThenByDescqueryMatrixOrderYesSecond Property to order by in Descending order. NOTE: If this value is the same as either the OrderBy or OrderByDesc values, then it will be ignored.

Allowable Values

  • Default
  • Name
PagingRequestBase<T> Parameters:
NameParameterData TypeRequiredDescription
SkipformIntegerNoNumber of items to skip before returning results. Minimum suitable value is 0 and is also the default value.
TakeformIntegerNoNumber of items to return per page. Must be a number in the range 1-100. Default value is 100.
OrderByformEnumNoOrder By
OrderByDescformEnumNoOrder By Descending
ThenByformEnumNoThen By
ThenByDescformEnumNoThen By Descending
RequestBase Parameters:
NameParameterData TypeRequiredDescription
VersionformintNo
GetRiskMatricesResponse Parameters:
NameParameterData TypeRequiredDescription
RiskMatricesformList<RiskMatrix>No
GetResponseBase Parameters:
NameParameterData TypeRequiredDescription
TotalResultsformintNo
SkipformintNo
TakeformintNo
LinksformList<Link>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusDescriptionformstringNo
ResponseStatusformResponseStatusNo
Link Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
RequestUrlformstringNo
MethodformstringNo
RiskMatrix Parameters:
NameParameterData TypeRequiredDescription
MatrixRevisionIdformGuidNo
MatrixIdformGuidNo
NameformstringNo
DescriptionformstringNo
RevisionformintNo
StatusformMatrixStatusNo

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

HTTP + SOAP11

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

                    POST /soap11 HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: GetRiskMatrices

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetRiskMatrices xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Version>0</Version>
  <Skip>0</Skip>
  <Take>0</Take>
  <OrderBy>Default</OrderBy>
  <OrderByDesc>Default</OrderByDesc>
  <ThenBy>Default</ThenBy>
  <ThenByDesc>Default</ThenByDesc>
  <ReportId>00000000-0000-0000-0000-000000000000</ReportId>
</GetRiskMatrices>

    </soap:Body>
</soap:Envelope>
                    
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
    <soap:Body>

<GetRiskMatricesResponse 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>
  <TotalResults>0</TotalResults>
  <Skip>0</Skip>
  <Take>0</Take>
  <Links>
    <Link>
      <Name>String</Name>
      <RequestUrl>String</RequestUrl>
      <Method>String</Method>
    </Link>
  </Links>
  <RiskMatrices>
    <RiskMatrix>
      <MatrixRevisionId>00000000-0000-0000-0000-000000000000</MatrixRevisionId>
      <MatrixId>00000000-0000-0000-0000-000000000000</MatrixId>
      <Name>String</Name>
      <Description>String</Description>
      <Revision>0</Revision>
      <Status>Draft</Status>
    </RiskMatrix>
  </RiskMatrices>
</GetRiskMatricesResponse>

    </soap:Body>
</soap:Envelope>