GET v1/regions/summary?FiscalYear={FiscalYear}&ExcludeGrantAmounts={ExcludeGrantAmounts}

Data for By Originating Office view. Shows grant making, structured by Thematic Area, for each office

Request Information

URI Parameters

NameDescriptionTypeAdditional information
FiscalYear

Filter on Fiscal Year

integer

None.

ExcludeGrantAmounts

in some contexts we don't want to return all the grant data (GrantAmounts will be an empty enum in each ByRegionResultItem if true)

boolean

None.

Body Parameters

None.

Response Information

Resource Description

IByRegionSummaryResult
NameDescriptionTypeAdditional information
Options

IByRegionSummaryOptions

None.

Summary

IByRegionSummaryResultSummary

None.

HeadQuarters

IByRegionResultItem

None.

OtherRegionsCombined

IByRegionResultItem

None.

OtherRegions

Collection of IByRegionResultItem

None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.