RESTful API
Funding
Funding Alerts News Liquor Off-road vehicle map

Grants

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

HideRecipientColumn

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

FilterFields

System.String

Read only: False

ShowGraphs

System.Boolean

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-12-20T19:36:47.0519065Z",
    "PublicationDate": "2024-12-20T19:36:47.0519065Z",
    "DateCreated": "2024-12-20T19:36:47.0519065Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "AdditionalFundingTitle": "sample string 6",
    "Recipient": "sample string 7",
    "Description": "sample string 8",
    "HideRecipientColumn": "sample string 9",
    "Title": "sample string 10",
    "WhoCanApply": "sample string 11",
    "Departments": "217046d7-47a5-4a11-a4fb-10189d9d315c",
    "FundingFor": "sample string 13",
    "Introduction": "sample string 14",
    "FilterFields": "sample string 15",
    "ShowGraphs": true,
    "Closed": true,
    "AdditionalFundingText": "sample string 18",
    "FundingNotFor": "sample string 19",
    "Tags": "2c86e309-ff14-4232-849b-30518f0e5a96",
    "Provider": "sample string 21"
  },
  {
    "LastModified": "2024-12-20T19:36:47.0519065Z",
    "PublicationDate": "2024-12-20T19:36:47.0519065Z",
    "DateCreated": "2024-12-20T19:36:47.0519065Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "AdditionalFundingTitle": "sample string 6",
    "Recipient": "sample string 7",
    "Description": "sample string 8",
    "HideRecipientColumn": "sample string 9",
    "Title": "sample string 10",
    "WhoCanApply": "sample string 11",
    "Departments": "217046d7-47a5-4a11-a4fb-10189d9d315c",
    "FundingFor": "sample string 13",
    "Introduction": "sample string 14",
    "FilterFields": "sample string 15",
    "ShowGraphs": true,
    "Closed": true,
    "AdditionalFundingText": "sample string 18",
    "FundingNotFor": "sample string 19",
    "Tags": "2c86e309-ff14-4232-849b-30518f0e5a96",
    "Provider": "sample string 21"
  }
]

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

HideRecipientColumn

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

FilterFields

System.String

Read only: False

ShowGraphs

System.Boolean

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-12-20T19:36:47.0519065Z",
  "PublicationDate": "2024-12-20T19:36:47.0519065Z",
  "DateCreated": "2024-12-20T19:36:47.0519065Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "AdditionalFundingTitle": "sample string 6",
  "Recipient": "sample string 7",
  "Description": "sample string 8",
  "HideRecipientColumn": "sample string 9",
  "Title": "sample string 10",
  "WhoCanApply": "sample string 11",
  "Departments": "c76572fc-3831-4f22-9cc7-57775939435c",
  "FundingFor": "sample string 13",
  "Introduction": "sample string 14",
  "FilterFields": "sample string 15",
  "ShowGraphs": true,
  "Closed": true,
  "AdditionalFundingText": "sample string 18",
  "FundingNotFor": "sample string 19",
  "Tags": "3bd13193-238a-49aa-8d0e-90f218342279",
  "Provider": "sample string 21"
}

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": "463fb927-a672-410a-968b-4dc3282da914"
}

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

HideRecipientColumn

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

FilterFields

System.String

Read only: False

ShowGraphs

System.Boolean

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-12-20T19:36:47.0519065Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AdditionalFundingTitle": "sample string 4",
  "Recipient": "sample string 5",
  "Description": "sample string 6",
  "HideRecipientColumn": "sample string 7",
  "Title": "sample string 8",
  "WhoCanApply": "sample string 9",
  "Departments": "b6726954-b351-4cf2-8552-8222dd232668",
  "FundingFor": "sample string 11",
  "Introduction": "sample string 12",
  "FilterFields": "sample string 13",
  "ShowGraphs": true,
  "Closed": true,
  "AdditionalFundingText": "sample string 16",
  "FundingNotFor": "sample string 17",
  "Tags": "5038c3a9-319f-4dcb-81cd-de5e687b7137"
}
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

HideRecipientColumn

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

FilterFields

System.String

Read only: False

ShowGraphs

System.Boolean

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-12-20T19:36:47.0519065Z",
  "PublicationDate": "2024-12-20T19:36:47.0519065Z",
  "DateCreated": "2024-12-20T19:36:47.0519065Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "AdditionalFundingTitle": "sample string 6",
  "Recipient": "sample string 7",
  "Description": "sample string 8",
  "HideRecipientColumn": "sample string 9",
  "Title": "sample string 10",
  "WhoCanApply": "sample string 11",
  "Departments": "5cadc29b-a100-4f88-8254-fd67c0036e06",
  "FundingFor": "sample string 13",
  "Introduction": "sample string 14",
  "FilterFields": "sample string 15",
  "ShowGraphs": true,
  "Closed": true,
  "AdditionalFundingText": "sample string 18",
  "FundingNotFor": "sample string 19",
  "Tags": "78eca9c7-69cd-4be8-939e-2d730a1e5cbc",
  "Provider": "sample string 21"
}

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

HideRecipientColumn

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

FilterFields

System.String

Read only: False

ShowGraphs

System.Boolean

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-12-20T19:36:47.0519065Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AdditionalFundingTitle": "sample string 4",
  "Recipient": "sample string 5",
  "Description": "sample string 6",
  "HideRecipientColumn": "sample string 7",
  "Title": "sample string 8",
  "WhoCanApply": "sample string 9",
  "Departments": "ceeec9bb-f8f9-4b75-9eeb-84d3d71bddf6",
  "FundingFor": "sample string 11",
  "Introduction": "sample string 12",
  "FilterFields": "sample string 13",
  "ShowGraphs": true,
  "Closed": true,
  "AdditionalFundingText": "sample string 16",
  "FundingNotFor": "sample string 17",
  "Tags": "94a4c1f9-7e3a-44ed-af07-05f2306f98c4"
}
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

HideRecipientColumn

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

FilterFields

System.String

Read only: False

ShowGraphs

System.Boolean

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-12-20T19:36:47.0519065Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 3",
  "AdditionalFundingTitle": "sample string 4",
  "Recipient": "sample string 5",
  "Description": "sample string 6",
  "HideRecipientColumn": "sample string 7",
  "Title": "sample string 8",
  "WhoCanApply": "sample string 9",
  "Departments": "cb3fcbb7-d026-4044-ac4b-c93bd0397fa4",
  "FundingFor": "sample string 11",
  "Introduction": "sample string 12",
  "FilterFields": "sample string 13",
  "ShowGraphs": true,
  "Closed": true,
  "AdditionalFundingText": "sample string 16",
  "FundingNotFor": "sample string 17",
  "Tags": "f8b4ed33-7e15-46ea-8121-b503262594dd"
}
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

DraftReviewText

System.String

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

ProjectEndDateText

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-12-20T19:36:47.0519065Z",
    "PublicationDate": "2024-12-20T19:36:47.0519065Z",
    "DateCreated": "2024-12-20T19:36:47.0519065Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "CloseDateText": "sample string 6",
    "Closed": true,
    "DraftReviewText": "sample string 8",
    "Title": "sample string 9",
    "OpenDate": "2024-12-20T19:36:47.0519065Z",
    "ProjectEndDate": "2024-12-20T19:36:47.0519065Z",
    "GrantsAwardedText": "sample string 12",
    "ProjectEndDateText": "sample string 13",
    "OpenDateText": "sample string 14",
    "ProjectStartDate": "2024-12-20T19:36:47.0519065Z",
    "DraftReviewStatus": "sample string 16",
    "AlwaysOpen": true,
    "CloseDate": "2024-12-20T19:36:47.0519065Z",
    "DraftReview": "2024-12-20T19:36:47.0519065Z",
    "GrantsAwarded": "2024-12-20T19:36:47.0519065Z",
    "ProjectStartDateText": "sample string 21",
    "ParentId": "b684612f-7cea-4d21-8ad5-6ca363f980b9",
    "Provider": "sample string 23"
  },
  {
    "LastModified": "2024-12-20T19:36:47.0519065Z",
    "PublicationDate": "2024-12-20T19:36:47.0519065Z",
    "DateCreated": "2024-12-20T19:36:47.0519065Z",
    "IncludeInSitemap": true,
    "UrlName": "sample string 5",
    "CloseDateText": "sample string 6",
    "Closed": true,
    "DraftReviewText": "sample string 8",
    "Title": "sample string 9",
    "OpenDate": "2024-12-20T19:36:47.0519065Z",
    "ProjectEndDate": "2024-12-20T19:36:47.0519065Z",
    "GrantsAwardedText": "sample string 12",
    "ProjectEndDateText": "sample string 13",
    "OpenDateText": "sample string 14",
    "ProjectStartDate": "2024-12-20T19:36:47.0519065Z",
    "DraftReviewStatus": "sample string 16",
    "AlwaysOpen": true,
    "CloseDate": "2024-12-20T19:36:47.0519065Z",
    "DraftReview": "2024-12-20T19:36:47.0519065Z",
    "GrantsAwarded": "2024-12-20T19:36:47.0519065Z",
    "ProjectStartDateText": "sample string 21",
    "ParentId": "b684612f-7cea-4d21-8ad5-6ca363f980b9",
    "Provider": "sample string 23"
  }
]

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

DraftReviewText

System.String

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

ProjectEndDateText

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-12-20T19:36:47.0519065Z",
  "PublicationDate": "2024-12-20T19:36:47.0519065Z",
  "DateCreated": "2024-12-20T19:36:47.0519065Z",
  "IncludeInSitemap": true,
  "UrlName": "sample string 5",
  "CloseDateText": "sample string 6",
  "Closed": true,
  "DraftReviewText": "sample string 8",
  "Title": "sample string 9",
  "OpenDate": "2024-12-20T19:36:47.0519065Z",
  "ProjectEndDate": "2024-12-20T19:36:47.0519065Z",
  "GrantsAwardedText": "sample string 12",
  "ProjectEndDateText": "sample string 13",
  "OpenDateText": "sample string 14",
  "ProjectStartDate": "2024-12-20T19:36:47.0519065Z",
  "DraftReviewStatus": "sample string 16",
  "AlwaysOpen": true,
  "CloseDate": "2024-12-20T19:36:47.0519065Z",
  "DraftReview": "2024-12-20T19:36:47.0519065Z",
  "GrantsAwarded": "2024-12-20T19:36:47.0519065Z",
  "ProjectStartDateText": "sample string 21",
  "ParentId": "b0a203d2-e855-490e-b3d6-3e46c84ff85b",
  "Provider": "sample string 23"
}

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.