GET v1/grants/search

Main grant search. Returns all details on grants matching search options

Request Information

URI Parameters

NameDescriptionTypeAdditional information
SearchText

looks for text (as a complete phrase) in grant description and in grantee name - case insensitive

string

None.

FiscalYearStart

Only return grants with Fiscal Year on or after this

integer

None.

FiscalYearEnd

Only return grants with Fiscal Year on or before this

integer

None.

MinAmount

Only return grants with Amount equal or greater to this

decimal number

None.

MaxAmount

Only return grants with Amount equal or less than this

decimal number

None.

ThematicAreaIds

Filter on Thematic Area Ids - include all Lines of work which are part of one of these TAs

Collection of integer

None.

LineOfWorkIds

Filter on Line of Work Ids - include grants where any contributing amount matches a line of work. If null or empty do not filter

Collection of integer

None.

RegionIds

Filter on Originating Office Ids - if null or empty do not filter

Collection of integer

None.

SubjectIds

Filter on Subjects - include grants where one of the subjects matches. If null or empty do not filter

Collection of integer

None.

IsBuild

boolean

None.

SortBy

Sort result (before pagination). Default is by Grantee Name (first of the GrantSortBy enums)

GrantSearchSortBy

None.

SortDirection

Sort order - default Ascending ((int)SortOrder.Ascending == 0)

SortDirection

None.

ResultsPerPage

Default 30

integer

None.

PageIndex

Default 0

integer

None.

ExcludeGrantDetails

Default false

boolean

None.

Body Parameters

None.

Response Information

Resource Description

IGrantsSearchResult
NameDescriptionTypeAdditional information
Options

IGrantsSearchOptions

None.

Summary

IGrantsSearchResultSummary

None.

Results

Collection of IGrantDetail

None.

Response Formats

application/json, text/json, text/xml

Sample:

Sample not available.