RESTful API

Get grants

Returns a set of data items of type grants.

Copy


                                        GET /api/funding/grants

Request Informaion

URI Parameters

None

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
AdditionalFundingTitle		System.String	Read only: False
Recipient		System.String	Read only: False
Description		System.String	Read only: False
Title		System.String	Read only: False
WhoCanApply		System.String	Read only: False
Departments		System.Guid	Read only: False
FundingFor		System.String	Read only: False
Introduction		System.String	Read only: False
Closed		System.Boolean	Read only: False
AdditionalFundingText		System.String	Read only: False
FundingNotFor		System.String	Read only: False
Tags		System.Guid	Read only: False
Provider		System.String	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    [
  {
    "LastModified": "2024-05-19T02:06:37.8455223Z",
    "PublicationDate": "2024-05-19T02:06:37.8455223Z",
    "DateCreated": "2024-05-19T02:06:37.8455223Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "AdditionalFundingTitle": "sample string 6",
    "Recipient": "sample string 7",
    "Description": "sample string 8",
    "Title": "sample string 9",
    "WhoCanApply": "sample string 10",
    "Departments": "ab9708b0-162f-4c0e-9c5e-cd8939ff562a",
    "FundingFor": "sample string 12",
    "Introduction": "sample string 13",
    "Closed": true,
    "AdditionalFundingText": "sample string 15",
    "FundingNotFor": "sample string 16",
    "Tags": "e7e478fe-f9b7-4ffc-89a5-ae9cb2f7a1a8",
    "Provider": "sample string 18"
  },
  {
    "LastModified": "2024-05-19T02:06:37.8455223Z",
    "PublicationDate": "2024-05-19T02:06:37.8455223Z",
    "DateCreated": "2024-05-19T02:06:37.8455223Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "AdditionalFundingTitle": "sample string 6",
    "Recipient": "sample string 7",
    "Description": "sample string 8",
    "Title": "sample string 9",
    "WhoCanApply": "sample string 10",
    "Departments": "ab9708b0-162f-4c0e-9c5e-cd8939ff562a",
    "FundingFor": "sample string 12",
    "Introduction": "sample string 13",
    "Closed": true,
    "AdditionalFundingText": "sample string 15",
    "FundingNotFor": "sample string 16",
    "Tags": "e7e478fe-f9b7-4ffc-89a5-ae9cb2f7a1a8",
    "Provider": "sample string 18"
  }
]

Get grants by key

Gets grants item by id.

Copy


                                        GET /api/funding/grants({key})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
AdditionalFundingTitle		System.String	Read only: False
Recipient		System.String	Read only: False
Description		System.String	Read only: False
Title		System.String	Read only: False
WhoCanApply		System.String	Read only: False
Departments		System.Guid	Read only: False
FundingFor		System.String	Read only: False
Introduction		System.String	Read only: False
Closed		System.Boolean	Read only: False
AdditionalFundingText		System.String	Read only: False
FundingNotFor		System.String	Read only: False
Tags		System.Guid	Read only: False
Provider		System.String	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2024-05-19T02:06:37.8455223Z",
  "PublicationDate": "2024-05-19T02:06:37.8455223Z",
  "DateCreated": "2024-05-19T02:06:37.8455223Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "AdditionalFundingTitle": "sample string 6",
  "Recipient": "sample string 7",
  "Description": "sample string 8",
  "Title": "sample string 9",
  "WhoCanApply": "sample string 10",
  "Departments": "602ac761-b670-46b8-b7c6-7ae952f10164",
  "FundingFor": "sample string 12",
  "Introduction": "sample string 13",
  "Closed": true,
  "AdditionalFundingText": "sample string 15",
  "FundingNotFor": "sample string 16",
  "Tags": "2e1d9107-bda1-4f37-9351-818b75389f14",
  "Provider": "sample string 18"
}

Get property

Gets Id property from grants item.

Copy


                                        GET /api/funding/grants({key})/property

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required
property		System.String	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name	Description	Type	Additional Information
Id		System.Guid	Read only: False

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "Id": "52d0edb2-7da1-43d2-9188-9ef1a997d39d"
}

Post grants

Creates a grants item.

Copy


                                        POST /api/funding/grants

Request Informaion

URI Parameters

None

Body Parameters

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
AdditionalFundingTitle		System.String	Read only: False
Recipient		System.String	Read only: False
Description		System.String	Read only: False
Title		System.String	Read only: False
WhoCanApply		System.String	Read only: False
Departments		System.Guid	Read only: False
FundingFor		System.String	Read only: False
Introduction		System.String	Read only: False
Closed		System.Boolean	Read only: False
AdditionalFundingText		System.String	Read only: False
FundingNotFor		System.String	Read only: False
Tags		System.Guid	Read only: False
Provider		System.String	Read only: True

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2024-05-19T02:06:37.8455223Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AdditionalFundingTitle": "sample string 4",
  "Recipient": "sample string 5",
  "Description": "sample string 6",
  "Title": "sample string 7",
  "WhoCanApply": "sample string 8",
  "Departments": "00efc597-aa98-4c7d-94af-99df3a2d4f99",
  "FundingFor": "sample string 10",
  "Introduction": "sample string 11",
  "Closed": true,
  "AdditionalFundingText": "sample string 13",
  "FundingNotFor": "sample string 14",
  "Tags": "f55d9dba-17ef-4828-be37-1fc585e243fb"
}

Response Informaion

Resource Description

Method can return success code: Created - 201 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
AdditionalFundingTitle		System.String	Read only: False
Recipient		System.String	Read only: False
Description		System.String	Read only: False
Title		System.String	Read only: False
WhoCanApply		System.String	Read only: False
Departments		System.Guid	Read only: False
FundingFor		System.String	Read only: False
Introduction		System.String	Read only: False
Closed		System.Boolean	Read only: False
AdditionalFundingText		System.String	Read only: False
FundingNotFor		System.String	Read only: False
Tags		System.Guid	Read only: False
Provider		System.String	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2024-05-19T02:06:37.8455223Z",
  "PublicationDate": "2024-05-19T02:06:37.8455223Z",
  "DateCreated": "2024-05-19T02:06:37.8455223Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "AdditionalFundingTitle": "sample string 6",
  "Recipient": "sample string 7",
  "Description": "sample string 8",
  "Title": "sample string 9",
  "WhoCanApply": "sample string 10",
  "Departments": "b6f031e7-e93e-486c-9a28-1419f79ee74a",
  "FundingFor": "sample string 12",
  "Introduction": "sample string 13",
  "Closed": true,
  "AdditionalFundingText": "sample string 15",
  "FundingNotFor": "sample string 16",
  "Tags": "d544ab13-a751-49d5-91ba-49c9f226d119",
  "Provider": "sample string 18"
}

Patch grants by key

Partial update for grants item.

Copy


                                        PATCH /api/funding/grants({key})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
AdditionalFundingTitle		System.String	Read only: False
Recipient		System.String	Read only: False
Description		System.String	Read only: False
Title		System.String	Read only: False
WhoCanApply		System.String	Read only: False
Departments		System.Guid	Read only: False
FundingFor		System.String	Read only: False
Introduction		System.String	Read only: False
Closed		System.Boolean	Read only: False
AdditionalFundingText		System.String	Read only: False
FundingNotFor		System.String	Read only: False
Tags		System.Guid	Read only: False
Provider		System.String	Read only: True

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2024-05-19T02:06:37.8455223Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AdditionalFundingTitle": "sample string 4",
  "Recipient": "sample string 5",
  "Description": "sample string 6",
  "Title": "sample string 7",
  "WhoCanApply": "sample string 8",
  "Departments": "99c3d41a-f3e4-4778-bb25-e9e5984786db",
  "FundingFor": "sample string 10",
  "Introduction": "sample string 11",
  "Closed": true,
  "AdditionalFundingText": "sample string 13",
  "FundingNotFor": "sample string 14",
  "Tags": "b2a513db-acd9-4bc0-b0de-4e67da014808"
}

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Put grants by key

Full update for grants item.

Copy


                                        PUT /api/funding/grants({key})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
AdditionalFundingTitle		System.String	Read only: False
Recipient		System.String	Read only: False
Description		System.String	Read only: False
Title		System.String	Read only: False
WhoCanApply		System.String	Read only: False
Departments		System.Guid	Read only: False
FundingFor		System.String	Read only: False
Introduction		System.String	Read only: False
Closed		System.Boolean	Read only: False
AdditionalFundingText		System.String	Read only: False
FundingNotFor		System.String	Read only: False
Tags		System.Guid	Read only: False
Provider		System.String	Read only: True

Request Formats

Copy


                                                                    application/json
                                                                    {
  "PublicationDate": "2024-05-19T02:06:37.8455223Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AdditionalFundingTitle": "sample string 4",
  "Recipient": "sample string 5",
  "Description": "sample string 6",
  "Title": "sample string 7",
  "WhoCanApply": "sample string 8",
  "Departments": "ada3c3f4-b52a-4e2c-a22e-97bbdd739744",
  "FundingFor": "sample string 10",
  "Introduction": "sample string 11",
  "Closed": true,
  "AdditionalFundingText": "sample string 13",
  "FundingNotFor": "sample string 14",
  "Tags": "81e393c5-b946-4e71-b361-e5347e39e841"
}

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete grants by key

Deletes a grants item by Id.

Copy


                                        DELETE /api/funding/grants({key})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Get Rounds

Returns a set of related items of type Rounds from grants item.

Copy


                                        GET /api/funding/grants({key})/Rounds

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
CloseDateText		System.String	Read only: False
Closed		System.Boolean	Read only: False
Title		System.String	Read only: False
OpenDate		System.DateTimeOffset	Read only: False
ProjectEndDate		System.DateTimeOffset	Read only: False
GrantsAwardedText		System.String	Read only: False
OpenDateText		System.String	Read only: False
ProjectStartDate		System.DateTimeOffset	Read only: False
DraftReviewStatus		System.String	Read only: False
AlwaysOpen		System.Boolean	Read only: False
CloseDate		System.DateTimeOffset	Read only: False
DraftReview		System.DateTimeOffset	Read only: False
GrantsAwarded		System.DateTimeOffset	Read only: False
ProjectStartDateText		System.String	Read only: False
ParentId		System.Guid	Read only: False
Provider		System.String	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    [
  {
    "LastModified": "2024-05-19T02:06:37.8455223Z",
    "PublicationDate": "2024-05-19T02:06:37.8455223Z",
    "DateCreated": "2024-05-19T02:06:37.8455223Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "CloseDateText": "sample string 6",
    "Closed": true,
    "Title": "sample string 8",
    "OpenDate": "2024-05-19T02:06:37.8455223Z",
    "ProjectEndDate": "2024-05-19T02:06:37.8455223Z",
    "GrantsAwardedText": "sample string 11",
    "OpenDateText": "sample string 12",
    "ProjectStartDate": "2024-05-19T02:06:37.8455223Z",
    "DraftReviewStatus": "sample string 14",
    "AlwaysOpen": true,
    "CloseDate": "2024-05-19T02:06:37.8455223Z",
    "DraftReview": "2024-05-19T02:06:37.8455223Z",
    "GrantsAwarded": "2024-05-19T02:06:37.8455223Z",
    "ProjectStartDateText": "sample string 19",
    "ParentId": "a09e22ad-c74d-42a5-869d-a59ff79555b8",
    "Provider": "sample string 21"
  },
  {
    "LastModified": "2024-05-19T02:06:37.8455223Z",
    "PublicationDate": "2024-05-19T02:06:37.8455223Z",
    "DateCreated": "2024-05-19T02:06:37.8455223Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "CloseDateText": "sample string 6",
    "Closed": true,
    "Title": "sample string 8",
    "OpenDate": "2024-05-19T02:06:37.8455223Z",
    "ProjectEndDate": "2024-05-19T02:06:37.8455223Z",
    "GrantsAwardedText": "sample string 11",
    "OpenDateText": "sample string 12",
    "ProjectStartDate": "2024-05-19T02:06:37.8455223Z",
    "DraftReviewStatus": "sample string 14",
    "AlwaysOpen": true,
    "CloseDate": "2024-05-19T02:06:37.8455223Z",
    "DraftReview": "2024-05-19T02:06:37.8455223Z",
    "GrantsAwarded": "2024-05-19T02:06:37.8455223Z",
    "ProjectStartDateText": "sample string 19",
    "ParentId": "a09e22ad-c74d-42a5-869d-a59ff79555b8",
    "Provider": "sample string 21"
  }
]

Get Rounds by relatedKey

Returns a related item of type Rounds from grants item.

Copy


                                        GET /api/funding/grants({key})/Rounds({relatedKey})

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required
relatedKey		System.Guid	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: OK - 200 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Name	Description	Type	Additional Information
LastModified		System.DateTimeOffset	Read only: True
PublicationDate		System.DateTimeOffset	Read only: False
DateCreated		System.DateTimeOffset	Read only: True
IncludeInSitemap		System.Boolean	Read only: False
UrlName		System.String	Read only: False
CloseDateText		System.String	Read only: False
Closed		System.Boolean	Read only: False
Title		System.String	Read only: False
OpenDate		System.DateTimeOffset	Read only: False
ProjectEndDate		System.DateTimeOffset	Read only: False
GrantsAwardedText		System.String	Read only: False
OpenDateText		System.String	Read only: False
ProjectStartDate		System.DateTimeOffset	Read only: False
DraftReviewStatus		System.String	Read only: False
AlwaysOpen		System.Boolean	Read only: False
CloseDate		System.DateTimeOffset	Read only: False
DraftReview		System.DateTimeOffset	Read only: False
GrantsAwarded		System.DateTimeOffset	Read only: False
ProjectStartDateText		System.String	Read only: False
ParentId		System.Guid	Read only: False
Provider		System.String	Read only: True

Resource Format

Response Formats

Copy


                                                                    application/json
                                                                    {
  "LastModified": "2024-05-19T02:06:37.8455223Z",
  "PublicationDate": "2024-05-19T02:06:37.8455223Z",
  "DateCreated": "2024-05-19T02:06:37.8455223Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "CloseDateText": "sample string 6",
  "Closed": true,
  "Title": "sample string 8",
  "OpenDate": "2024-05-19T02:06:37.8455223Z",
  "ProjectEndDate": "2024-05-19T02:06:37.8455223Z",
  "GrantsAwardedText": "sample string 11",
  "OpenDateText": "sample string 12",
  "ProjectStartDate": "2024-05-19T02:06:37.8455223Z",
  "DraftReviewStatus": "sample string 14",
  "AlwaysOpen": true,
  "CloseDate": "2024-05-19T02:06:37.8455223Z",
  "DraftReview": "2024-05-19T02:06:37.8455223Z",
  "GrantsAwarded": "2024-05-19T02:06:37.8455223Z",
  "ProjectStartDateText": "sample string 19",
  "ParentId": "470c6717-608d-4fec-b281-f641898ce454",
  "Provider": "sample string 21"
}

Post Rounds

Add Rounds relation to grants item.

Copy


                                        POST /api/funding/grants({key})/Rounds/$ref

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

None

Request Formats

Copy


                                                                    application/json
                                                                    {
  "@odata.id": "http://host/route/service/type(key)"
}

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete Rounds

Delete set of related items of type Rounds from grants item.

Copy


                                        DELETE /api/funding/grants({key})/Rounds/$ref

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.

Delete Rounds by relatedKey

Delete relation of type Rounds from grants item.

Copy


                                        DELETE /api/funding/grants({key})/Rounds({relatedKey})/$ref

Request Informaion

URI Parameters

Name	Description	Type	Additional Information
key		System.Guid	Required
relatedKey		System.Guid	Required

Body Parameters

None

Request Formats

None.

Response Informaion

Resource Description

Method can return success code: NoContent - 204 or one of these error codes: BadRequest - 400, NotFound - 404, NotImplemented - 501, InternalServerError - 500, Unauthorized - 401.

Resource Format

Response Formats

None.