GET v1/Groups/Summary/

Retrieves the credit risk summary and group data based on the ID of a group.

Request Information

Parameters

Name Type Description Additional information
request GroupGetSummaryRequest Container for the Group Summary Request input parameters. See parameter details below.

Define this parameter in the request URI.

Parameter Information

Parameter Name: request

Property Type Description
Id String The unique ID for the Group.
CalculationType String The calculation type for the credit risk summary. Valid values are "Average" and "Median".
SdkVersion String If the client is using the SDK, the version number will be passed along with the request. This field is optional.

Response Information

Response body formats

application/json, text/json

Sample:
{
  "group": {
    "id": "sample string 1",
    "name": "sample string 2",
    "organizationCount": 3
  },
  "creditRiskSummary": {
    "edf8": {
      "annualized": {
        "term1": {
          "impliedRatings": {
            "moodysImpliedRatingSpot": {
              "code": "sample string 1",
              "rank": 1,
              "date": "2026-06-05T14:55:47.6361396+00:00",
              "requiresSubscription": false
            },
            "moodysImpliedRating5YearGrand": {
              "code": "sample string 1",
              "rank": 1,
              "date": "2026-06-05T14:55:47.6361396+00:00",
              "requiresSubscription": false
            }
          },
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        },
        "term5": {
          "impliedRatings": {
            "moodysImpliedRatingSpot": {
              "code": "sample string 1",
              "rank": 1,
              "date": "2026-06-05T14:55:47.6361396+00:00",
              "requiresSubscription": false
            },
            "moodysImpliedRating5YearGrand": {
              "code": "sample string 1",
              "rank": 1,
              "date": "2026-06-05T14:55:47.6361396+00:00",
              "requiresSubscription": false
            }
          },
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        }
      },
      "cumulative": {
        "term1": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        },
        "term5": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        }
      },
      "requiresSubscription": false
    },
    "cdsiEdf8": {
      "annualized": {
        "term1": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        },
        "term5": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        }
      },
      "requiresSubscription": false
    },
    "ttcEdf8": {
      "annualized": {
        "term1": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        },
        "term5": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        }
      },
      "requiresSubscription": false
    },
    "edf9": {
      "annualized": {
        "term1": {
          "impliedRatings": {
            "corporateImpliedMoodysRatingSpot": {
              "code": "sample string 1",
              "rank": 1,
              "date": "2026-06-05T14:55:47.6361396+00:00",
              "requiresSubscription": false
            },
            "financialImpliedMoodysRatingSpot": {
              "code": "sample string 1",
              "rank": 1,
              "date": "2026-06-05T14:55:47.6361396+00:00",
              "requiresSubscription": false
            }
          },
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        },
        "term5": {
          "impliedRatings": {
            "corporateImpliedMoodysRatingSpot": {
              "code": "sample string 1",
              "rank": 1,
              "date": "2026-06-05T14:55:47.6361396+00:00",
              "requiresSubscription": false
            },
            "financialImpliedMoodysRatingSpot": {
              "code": "sample string 1",
              "rank": 1,
              "date": "2026-06-05T14:55:47.6361396+00:00",
              "requiresSubscription": false
            }
          },
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        }
      },
      "cumulative": {
        "term1": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        },
        "term5": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        }
      },
      "requiresSubscription": false
    },
    "cdsiEdf9": {
      "annualized": {
        "term1": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        },
        "term5": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        }
      },
      "requiresSubscription": false
    },
    "ttcEdf9": {
      "annualized": {
        "term1": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        },
        "term5": {
          "value": 1.0,
          "date": "2026-06-05T14:55:47.6361396+00:00"
        }
      },
      "requiresSubscription": false
    }
  },
  "errorOccurred": false,
  "errorMessages": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "request": {
    "id": "sample string 1",
    "calculationType": "sample string 2",
    "sdkVersion": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<GroupGetSummaryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <ErrorMessages xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </ErrorMessages>
  <ErrorOccurred>false</ErrorOccurred>
  <Request>
    <SdkVersion>sample string 3</SdkVersion>
    <CalculationType>sample string 2</CalculationType>
    <Id>sample string 1</Id>
  </Request>
  <CreditRiskSummary>
    <CdsiEdf8>
      <Annualized>
        <Term1>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term1>
        <Term5>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term5>
      </Annualized>
      <RequiresSubscription>false</RequiresSubscription>
    </CdsiEdf8>
    <CdsiEdf9>
      <Annualized>
        <Term1>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term1>
        <Term5>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term5>
      </Annualized>
      <RequiresSubscription>false</RequiresSubscription>
    </CdsiEdf9>
    <Edf8>
      <Annualized>
        <Term1>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
          <ImpliedRatings>
            <MoodysImpliedRating5YearGrand>
              <Code>sample string 1</Code>
              <Date>2026-06-05T14:55:47.6361396+00:00</Date>
              <Rank>1</Rank>
              <RequiresSubscription>false</RequiresSubscription>
            </MoodysImpliedRating5YearGrand>
            <MoodysImpliedRatingSpot>
              <Code>sample string 1</Code>
              <Date>2026-06-05T14:55:47.6361396+00:00</Date>
              <Rank>1</Rank>
              <RequiresSubscription>false</RequiresSubscription>
            </MoodysImpliedRatingSpot>
          </ImpliedRatings>
        </Term1>
        <Term5>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
          <ImpliedRatings>
            <MoodysImpliedRating5YearGrand>
              <Code>sample string 1</Code>
              <Date>2026-06-05T14:55:47.6361396+00:00</Date>
              <Rank>1</Rank>
              <RequiresSubscription>false</RequiresSubscription>
            </MoodysImpliedRating5YearGrand>
            <MoodysImpliedRatingSpot>
              <Code>sample string 1</Code>
              <Date>2026-06-05T14:55:47.6361396+00:00</Date>
              <Rank>1</Rank>
              <RequiresSubscription>false</RequiresSubscription>
            </MoodysImpliedRatingSpot>
          </ImpliedRatings>
        </Term5>
      </Annualized>
      <Cumulative>
        <Term1>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term1>
        <Term5>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term5>
      </Cumulative>
      <RequiresSubscription>false</RequiresSubscription>
    </Edf8>
    <Edf9>
      <Annualized>
        <Term1>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
          <ImpliedRatings>
            <CorporateImpliedMoodysRatingSpot>
              <Code>sample string 1</Code>
              <Date>2026-06-05T14:55:47.6361396+00:00</Date>
              <Rank>1</Rank>
              <RequiresSubscription>false</RequiresSubscription>
            </CorporateImpliedMoodysRatingSpot>
            <FinancialImpliedMoodysRatingSpot>
              <Code>sample string 1</Code>
              <Date>2026-06-05T14:55:47.6361396+00:00</Date>
              <Rank>1</Rank>
              <RequiresSubscription>false</RequiresSubscription>
            </FinancialImpliedMoodysRatingSpot>
          </ImpliedRatings>
        </Term1>
        <Term5>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
          <ImpliedRatings>
            <CorporateImpliedMoodysRatingSpot>
              <Code>sample string 1</Code>
              <Date>2026-06-05T14:55:47.6361396+00:00</Date>
              <Rank>1</Rank>
              <RequiresSubscription>false</RequiresSubscription>
            </CorporateImpliedMoodysRatingSpot>
            <FinancialImpliedMoodysRatingSpot>
              <Code>sample string 1</Code>
              <Date>2026-06-05T14:55:47.6361396+00:00</Date>
              <Rank>1</Rank>
              <RequiresSubscription>false</RequiresSubscription>
            </FinancialImpliedMoodysRatingSpot>
          </ImpliedRatings>
        </Term5>
      </Annualized>
      <Cumulative>
        <Term1>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term1>
        <Term5>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term5>
      </Cumulative>
      <RequiresSubscription>false</RequiresSubscription>
    </Edf9>
    <TtcEdf8>
      <Annualized>
        <Term1>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term1>
        <Term5>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term5>
      </Annualized>
      <RequiresSubscription>false</RequiresSubscription>
    </TtcEdf8>
    <TtcEdf9>
      <Annualized>
        <Term1>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term1>
        <Term5>
          <Date>2026-06-05T14:55:47.6361396+00:00</Date>
          <Value>1</Value>
        </Term5>
      </Annualized>
      <RequiresSubscription>false</RequiresSubscription>
    </TtcEdf9>
  </CreditRiskSummary>
  <Group>
    <Id>sample string 1</Id>
    <Name>sample string 2</Name>
    <OrganizationCount>3</OrganizationCount>
  </Group>
</GroupGetSummaryResponse>