Part III (B): Submission via JSON

Introduction

A JSON endpoint of grant data is one method available to sync your agency or department’s grant information with this portal. This method is ideal for departments with IT staff comfortable supporting JSON file development that aren’t using WordPress. Using this method, you’ll create a public JSON endpoint that contains your grant data following the specification defined below. Once this endpoint is available and contains at least one grant, an approved grant contributor can register your endpoint on the Grants Portal.

Once an endpoint has been registered, the portal will periodically (once per 24 hours) perform a /GET request to your endpoint to check for changes or additions to your grant data. If new grants, or updates to existing grants, are identified, the portal will update the information on the portal to reflect those.

JSON Specification

Your endpoint must return valid JSON and be publicly accessible from the internet. The response must contain an array of one or more grants objects.

EXAMPLE JSON RESPONSE

GRANT RESPONSE

[
    {
        "grantTitle": "Example Grant",
        "uniqueID": 29,
        "awardStats": [
            {
                "fiscalYear": "2022-2023",
                "applicationsSubmitted": 1,
                "grantsAwarded": 1,
            },
            {
                "fiscalYear": "2021-2022",
                "applicationsSubmitted": 1,
                "grantsAwarded": 1,
            },
            {
                "fiscalYear": "2020-2021",
                "applicationsSubmitted": 1,
                "grantsAwarded": 1,
            }
        ],
        "grantID": "example-grant",
        "isForecasted": "active",
        "opportunityType": [ "grant" ],
        "loiRequired": true,
        "grantCategories": [
            "agriculture",
            "disadvantaged-communities",
            "disaster-prevention-relief"
        ],
        "categorySuggestions": "",
        "purpose": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr...",
        "description": "Stet clita kasd gubergren, no sea takimata sanctus...",
        "applicantType": {
            "type": [
                "business",
                "individual"
            ],
            "notes": "Sed diam nonumy eirmod tempor invidunt ut labore et dolore..."
        },
        "geoLimitations": "No geographic limitations.",
        "fundingSource": {
            "type": "federal",
            "notes": "This is a federally funded grant."
        },
        "matchingFunds": {
            "required": false,
            "percent": 0,
            "notes": ""
        },
        "totalEstimatedFunding": "exactFundingAmount",
        "estimatedAvailableFunds": "10000",
        "estimatedAvailableFundNotes": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr...",
        "estimatedAwards": {
            "exact": 1
        },
        "estimatedAmounts": {
            "same": 10000
        },
        "fundingMethod": {
            "type": "advances-and-reimbursements",
            "notes": ""
        },
        "openDate": "2020-07-04T00:00",
        "anticipatedOpenDate": "",
        "periodOfPerformance": "12 days",
        "expectedAwardDate": "November, 2020",
        "deadline": "2021-07-04T23:59",
        "electronicSubmission": {
            "type": "url",
            "url": "https://grantsportal.test.com/"
        },
        "details": "https://grantsportal.test.com/",
        "agencyURL": "https://grantsportal.test.com/",
        "subscribe": "https://grantsportal.test.com/",
        "events": "https://grantsportal.test.com/",
        "contactInfo": {
            "name": "John Doe",
            "email": "noreply@castlg-stage.10upmanaged.com",
            "tel": "1-555-555-5555"
        },
        "internalContactInfo": [
            {
                "name": "Jane Doe",
                "email": "noreply@grantsportal.test.com",
                "tel": "1-555-555-5555",
                "primary": true
            },
            {
                "name": "Jack Doe",
                "email": "noreply@grantsportal.test.com",
                "tel": "1-555-555-5555"
            }
        ],
        "_links": {
            "award": [
                {
                    "href": "https://grantsportal.test.com/json-endpoint/grant-awards-29.json"
                }
            ]
        }
    }
]

GRANT Award RESPONSE

[
    {
        "uniqueID": 76,
        "grantID": 29,
        "fiscalYear": "2022-2023",
        "projectTitle": "Grant Award Title",
        "recipientType": "business",
        "primaryRecipientName": "Award Recipient Name",
        "primaryRecipientFirstName": "Example",
        "primaryRecipientLastName": "Grant Award",
        "secondaryRecipients": "no",
        "totalAwardAmount": 1000000,
        "totalAwardUsed": 10000,
        "matchingFundingAmount": 1000,
        "awardAmountNotes": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr...",
        "grantFundedStartDate": "2022-06-03T14:06",
        "grantFundedEndDate": "2022-08-03T14:08",
        "projectAbstract": "Lorem ipsum dolor sit amet, consetetur sadipscing...",
        "geoLocationServed": "county",
        "countiesServed": [
            "amador"
        ],
        "geoServedNotes": "Lorem ipsum dolor sit amet, consetetur sadipscing...",
        "awardCancellingNotes": "Lorem ipsum dolor sit amet, consetetur sadipscing..."
  }
]

GRANT SCHEMA

grantTitle

Example:

{
  ...
  "grantTitle": "My Grant Title",
  ...
}

{
  ...
  "uniqueID": "grant-101",
  ...
}

{
  ...
  "awardStats": [
      {
          "fiscalYear": "2022-2023",
          "applicationsSubmitted": 1,
          "grantsAwarded": 1,
      },
      {
          "fiscalYear": "2021-2022",
          "applicationsSubmitted": 1,
          "grantsAwarded": 1,
      },
      {
          "fiscalYear": "2020-2021",
          "applicationsSubmitted": 1,
          "grantsAwarded": 1,
      }
  ],
  ...
}

isForecasted

Example:

{
  ...
  "isForecasted": "active",
  ...
}

opportunityType

Example:

{
  ...
  "opportunityType": [ "grant", "loan" ],
  ...
}

loiRequired

Example:

{
  ...
  "loiRequired": true,
  ...
}

grantCategories

Example:

{
  ...
  "grantCategories": [
    "agriculture",
    "energy"
  ],
  ...
}

{
  ...
  "categorySuggestions": "Astronomy, Ornithology",
  ...
}

purpose

Example:

{
  ...
  "purpose": "Lorem ipsum dolor sit amet.",
  ...
}

description

Example:

{
  ...
  "description": "Lorem ipsum dolor sit amet.",
  ...
}

applicantType

applicantType Object:

Example:

{
  ...
  "applicantType": {
    "type": [
      "business",
      "individual"
    ],
    "notes": "Lorem ipsum dolor sit amet."
  },
  ...
}

{
  ...
  "geoLimitations": "Only businesses headquartered in California may apply.",
  ...
}

fundingSource

fundingSource Object

Example:

{
  ...
  "fundingSource": {
    "type": "federal",
    "notes": "Lorem ipsum dolor sit amet."
  },
  ...
}

{
  ...
  "matchingFunds": {
    "required": true,
    "percent": 50,
    "notes": "Requires match of 50% of grant awarded."
  },
  ...
}

{
  ...
  "totalEstimatedFunding": "exactFundingAmount",
  ...
}

Example:

{
  ...
  "estimatedAvailableFunds": 10000,
  ...
}

{
  ...
  "estimatedAvailableFundNotes": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr...",
  ...
}

{
  ...
  "estimatedAwards": {
    "between":[ 0, 100 ]
  },
  ...
}

{
  ...
  "estimatedAwards": {
    "exact": 100 
  },
  ...
}

{
  ...
  "estimatedAwards": {
    "dependent": "Dependant on number of awards."
  },
  ...
}

estimatedAmounts

Valid Values: Required one of following value.

Example:

“same”:

{
  ...
  "estimatedAmounts": {
    "same": 10000
  },
  ...
}

“range”:

{
  ...
  "estimatedAwards": {
    "range": [ 5000, 1000 ]
  },
  ...
}

“dependent”:

{
  ...
  "estimatedAwards": {
    "dependent": "Depends on the number of applications received"
  },
  ...
}

{
  ...
  "fundingMethod": {
    "type": "advances-and-reimbursements",
    "notes": ""
  },
  ...
}

{
  ...
  "openDate": "2020-07-04T00:00",
  ...
}

{
  ...
  "anticipatedOpenDate": "Summer 2020",
  ...
}

{
  ...
  "periodOfPerformance": "12 weeks.",
  ...
}

{
  ...
  "expectedAwardDate": "Q3 2021",
  ...
}

{
  ...
  "deadline": "2021-07-04T23:59",
  ...
}

{
  ...
  "electronicSubmission": {
    "type": "none"
  },
  ...
}

{
  ...
  "electronicSubmission": {
    "type": "url",
    "url": "https://www.grants.ca.gov"
  },
  ...
}

{
  ...
  "electronicSubmission": {
    "type": "email",
    "email": "noreply@grantsportal.test.com"
  },
  ...
}

{
  ...
  "details": "https://www.grants.ca.gov/",
  ...
}

agencyURL

Example:

{
  ...
  "agencyURL": "https://www.grants.ca.gov/",
  ...
}

subscribe

Example:

{
  ...
  "subscribe": "https://www.grants.ca.gov/",
  ...
}

events

Example:

{
  ...
  "events": "https://www.grants.ca.gov/",
  ...
}

{
  ...
  "contactInfo": {
    "name": "John Doe",
    "email": "noreply@castlg-stage.10upmanaged.com",
    "tel": "1-555-555-5555"
  },
  ...
}

{
  ...
  "internalContactInfo": [
    {
      "name": "John Doe",
      "email": "noreply@grants.ca.gov",
      "tel": "1-555-555-5555",
      "primary": true
    },
    {
      "name": "Jane Doe",
      "email": "noreply@grants.ca.gov",
      "tel": "1-555-555-5555"
    },
  ],
  ...
}

{
  ...
  "_links": {
    "award": [
      {
        "href": "https://grantsportal.test.com/json-endpoint/grant-awards-29.json"
      }
    ]
  },
  ...
}

GRANT Award SCHEMA

{
  ...
  "uniqueID": "76",
  ...
}

grantID

Example:

{
  ...
  "grantID": "29",
  ...
}

fiscalYear

Example:

{
  ...
  "fiscalYear": "2022-2023",
  ...
}

projectTitle

Example:

{
  ...
  "projectTitle": "Grant Award Title",
  ...
}

recipientType

Example:

{
  ...
  "recipientType": "business",
  ...
}

primaryRecipientName

Example:

{
  ...
  "primaryRecipientName": "Award Recipient Name",
  ...
}

primaryRecipientFirstName

Example:

{
  ...
  "primaryRecipientFirstName": "Example",
  ...
}

primaryRecipientLastName

Example:

{
  ...
  "primaryRecipientLastName": "Grant Award",
  ...
}

secondaryRecipients

Example:

{
  ...
  "secondaryRecipients": "no",
  ...
}

totalAwardAmount

Example:

{
  ...
  "totalAwardAmount": 1000000,
  ...
}

totalAwardUsed

Example:

{
  ...
  "totalAwardUsed": 10000,
  ...
}

matchingFundingAmount

Example:

{
  ...
  "matchingFundingAmount": 1000,
  ...
}

awardAmountNotes

Example:

{
  ...
  "awardAmountNotes": "Lorem ipsum dolor sit amet, consetetur sadipscing elitr...",
  ...
}

grantFundedStartDate

Example:

{
  ...
  "grantFundedStartDate": "2022-06-03T14:06",
  ...
}

grantFundedEndDate

Example:

{
  ...
  "grantFundedEndDate": "2022-08-03T14:08",
  ...
}

projectAbstract

Example:

{
  ...
  "projectAbstract": "Lorem ipsum dolor sit amet, consetetur sadipscing...",
  ...
}

geoLocationServed

Example:

{
  ...
  "geoLocationServed": "county",
  ...
}

countiesServed

Example:

{
  ...
  "countiesServed": [
     "amador"
  ],
  ...
}

geoServedNotes

Example:

{
  ...
  "geoServedNotes": "Lorem ipsum dolor sit amet, consetetur sadipscing..."
  ...
}

awardCancellingNotes

Example:

{
  ...
  "awardCancellingNotes": "Lorem ipsum dolor sit amet, consetetur sadipscing..."
  ...
}

Last Updated: 11/12/2024