Schema¶

Warning

This is a work in progress. It has not been approved yet.

Schema¶

Overall schema¶

For each grant, there is a new property deiDetails. This contains three properties: leadership, mission, and project which are all instances of DEI Application Area.

The DEI Application Area object contains some question-level metadata about how a question was asked (if it was asked), the reply status, and the options available to the respondant as well as some other fields. Each DEI Application Area also contains a response property containing the details of the response, taking the format of a DEI Response.

Each DEI Response contains fields for containing the answers given to that application area. There are spaces for a list of taxonomyCodes, as well as for the free-text entry fields for livedExperience and geography.

Reference¶

These is an overview of the extension schema structures.

Title	Description	Type	Required
`deiDetails`		object
DEI Details	The DEI Details for this grant. Contains information about separate application areas and the responses to them.
`deiDetails/leadership`		object	Required
DEI Application Area	A DEI Application area used to collect information about whether a particular question was asked, responded to, and additional information. It also contains the response information under the Response fields.
`deiDetails/leadership/askedStatus`		string	Required
Asked Status	A code referring to how this question was asked. The value for this field should be drawn from the Asked Status codelist.
`deiDetails/leadership/replyStatus`		string
Reply Status	A code referring to the status of the reply to this question. The value for this field should be drawn from the Reply Status codelist.
`deiDetails/leadership/availableOptions`		array[string]
Available Options	Code(s) referring to options which were available when the question was asked. The value for these codes should be drawn from the Available Options codelist.
`deiDetails/leadership/purposes`		string
Purposes	The purposes of collecting this data.
`deiDetails/leadership/additionalDetails`		string
Additional Details	A free text field to include any additional details or rationales that may be important to this context.
`deiDetails/leadership/response`		object
DEI Response	A response to a DEI Application area, containing information such as the taxonomy codes selected and any lived experience or geography responses.
`deiDetails/leadership/response/taxonomyCodes`		array[string]
Taxonomy Codes	The Taxonomy Codes selected from the DEI Taxonomies
`deiDetails/leadership/response/livedExperience`		string
Lived Experience	Description provided that are not drawn from a vocabulary but instead derived from lived experience
`deiDetails/leadership/response/geography`		string
Geography	Description provided that are not drawn from a vocabulary but instead drawn from Geography
`deiDetails/mission`		object	Required
DEI Application Area	A DEI Application area used to collect information about whether a particular question was asked, responded to, and additional information. It also contains the response information under the Response fields.
`deiDetails/mission/askedStatus`		string	Required
Asked Status	A code referring to how this question was asked. The value for this field should be drawn from the Asked Status codelist.
`deiDetails/mission/replyStatus`		string
Reply Status	A code referring to the status of the reply to this question. The value for this field should be drawn from the Reply Status codelist.
`deiDetails/mission/availableOptions`		array[string]
Available Options	Code(s) referring to options which were available when the question was asked. The value for these codes should be drawn from the Available Options codelist.
`deiDetails/mission/purposes`		string
Purposes	The purposes of collecting this data.
`deiDetails/mission/additionalDetails`		string
Additional Details	A free text field to include any additional details or rationales that may be important to this context.
`deiDetails/mission/response`		object
DEI Response	A response to a DEI Application area, containing information such as the taxonomy codes selected and any lived experience or geography responses.
`deiDetails/mission/response/taxonomyCodes`		array[string]
Taxonomy Codes	The Taxonomy Codes selected from the DEI Taxonomies
`deiDetails/mission/response/livedExperience`		string
Lived Experience	Description provided that are not drawn from a vocabulary but instead derived from lived experience
`deiDetails/mission/response/geography`		string
Geography	Description provided that are not drawn from a vocabulary but instead drawn from Geography
`deiDetails/project`		object	Required
DEI Application Area	A DEI Application area used to collect information about whether a particular question was asked, responded to, and additional information. It also contains the response information under the Response fields.
`deiDetails/project/askedStatus`		string	Required
Asked Status	A code referring to how this question was asked. The value for this field should be drawn from the Asked Status codelist.
`deiDetails/project/replyStatus`		string
Reply Status	A code referring to the status of the reply to this question. The value for this field should be drawn from the Reply Status codelist.
`deiDetails/project/availableOptions`		array[string]
Available Options	Code(s) referring to options which were available when the question was asked. The value for these codes should be drawn from the Available Options codelist.
`deiDetails/project/purposes`		string
Purposes	The purposes of collecting this data.
`deiDetails/project/additionalDetails`		string
Additional Details	A free text field to include any additional details or rationales that may be important to this context.
`deiDetails/project/response`		object
DEI Response	A response to a DEI Application area, containing information such as the taxonomy codes selected and any lived experience or geography responses.
`deiDetails/project/response/taxonomyCodes`		array[string]
Taxonomy Codes	The Taxonomy Codes selected from the DEI Taxonomies
`deiDetails/project/response/livedExperience`		string
Lived Experience	Description provided that are not drawn from a vocabulary but instead derived from lived experience
`deiDetails/project/response/geography`		string
Geography	Description provided that are not drawn from a vocabulary but instead drawn from Geography

asked_status values¶

The values in the asked_status property are:

askedStatus options¶
Code	Title	Description
AS100	Not Asked Not Applicable	Not asked because this was not applicable to this situation
AS101	Not Asked Historical Data	Not asked because this grant was made before any DEI process was adopted
AS200	Asked During The Application Process	This was asked before a decision was made to award the grant
AS201	Asked After The Application Process	This was asked after a decision was made to award the grant

Note every option starts with either:

NOT_ASKED to indicate the question was not asked for some reason
ASKED to indicate the question was asked at some point

This should make it easy to filter the data for only one of these 2 options.

available_options values¶

The values in the available_options list property are:

availableOptions options¶
Code	Title	Description
AO100	Taxonomy Population Group	The respondant may select the DEI Taxonomy codes referring to Population Group
AO101	Taxonomy Category	The respondant may select the DEI Taxonomy codes referring to Categories within a Population Group
AO102	Taxonomy Subcategory	The respondant may select the DEI Taxonomy codes referring to Subcategories within a Category
AO200	Geography	The respondant may enter a description of the relevant geography in a field
AO201	Lived Experience	The respondant may enter a description of the relevant lived experience in a field
AO300	General	The respondant may declare that this is general and therefore not aimed at or consisting of a specific group of people
AO301	Prefer Not To Say	The respondant may select an option that they prefer not to say

reply_status values¶

The values in the reply_status property are:

reply_status options¶
Code	Title	Description
RS100	No Reply	No reply was received
RS200	Reply Got	A reply was received
RS201	Reply was General	The reply is general and is not aimed at or does not consist of a specific group of people
RS202	Reply was Prefer not to say	The reply was Prefer not to say
RS203	Reply Got but no permissions	A reply was received but is not permitted to be shared as open data

Note every option starts with either:

NO_REPLY to indicate a reply was not received for some reason
REPLY to indicate a reply was received at some point

This should make it easy to filter the data for only one of these 2 options.

codes values¶

The values in the codes array are from the taxonomy, and must follow the rules explained there. Taxonomy

Examples¶

Not asked because not applicable¶

A funder has decided that these questions are not applicable and has not asked them at all.

{
    "id": "EG-NOT-APPLICABLE",
    "title": "Test Grant: Not Asked, Not Applicable",
    "description": "An example grant where the funder did not ask any questions because they are not applicable",
    "currency": "GBP",
    "amountAwarded": 1000,
    "awardDate": "2021-01-01T00:00:00Z",
    "fundingOrganization": [
        {
            "id": "example-funder-001",
            "name": "Example Funding Organisation"
        }
    ],
    "recipientOrganization": [
        {
            "id": "example-recipient-001",
            "name": "Example Recipient Organisation"
        }
    ],
    "deiDetails": {
        "leadership": {
            "askedStatus": "AS100"
        },
        "mission": {
            "askedStatus": "AS100"
        },
        "project": {
            "askedStatus": "AS100"
        }
    }
}

Asked after grant was made and no reply was received¶

A funder has asked people it recently made grants to to answer the DEI questions, but no reply has been received from the organisation.

{
    "id": "EG-001-ASKED-AFTER-APPLICATION",
    "title": "Example Grant: Asked After Application with No Reply",
    "description": "An example grant where the DEI data was asked for after the application process, but there has been no reply",
    "currency": "GBP",
    "amountAwarded": 1000,
    "awardDate": "2021-01-01T00:00:00Z",
    "fundingOrganization": [
        {
            "id": "example-funder-001",
            "name": "Example Funding Organisation"
        }
    ],
    "recipientOrganization": [
        {
            "id": "example-recipient-002",
            "name": "Example Recipient Organisation"
        }
    ],
    "deiDetails": {
        "leadership": {
            "askedStatus": "AS201",
            "replyStatus": "RS100",
            "availableOptions": [
                "AO100",
                "AO101",
                "AO102",
                "AO200",
                "AO201"
            ]
        },
        "mission": {
            "askedStatus": "AS201",
            "replyStatus": "RS100",
            "availableOptions": [
                "AO100",
                "AO101",
                "AO102",
                "AO200",
                "AO201"
            ]
        },
        "project": {
            "askedStatus": "AS201",
            "replyStatus": "RS100",
            "availableOptions": [
                "AO100",
                "AO101",
                "AO102",
                "AO200",
                "AO201"
            ]
        }
    }
}

A simple example¶

A funder has asked people it recently made grants to to answer the DEI questions, and got a reply. The “dei_classification_available_options” field is missing.

{
    "id": "EG-SIMPLE-EXAMPLE",
    "title": "Example Grant: A Simple Grant with DEI Details",
    "description": "A simple grant with a basic DEI response",
    "currency": "GBP",
    "amountAwarded": 1000,
    "awardDate": "2021-01-01T00:00:00Z",
    "fundingOrganization": [
        {
            "id": "example-funder-001",
            "name": "Example Funding Organisation"
        }
    ],
    "recipientOrganization": [
        {
            "id": "example-recipient-001",
            "name": "Example Receipient Organisation"
        }
    ],
    "deiDetails": {
        "leadership": {
            "askedStatus": "AS200",
            "replyStatus": "RS200",
            "availableOptions": [
                "AO100",
                "AO101",
                "AO102"
            ],
            "purposes": "Monitoring",
            "response": {
                "taxonomyCodes": [
                    "DEI020330"
                ]
            }
        },
        "mission": {
            "askedStatus": "AS200",
            "replyStatus": "RS200",
            "availableOptions": [
                "AO100",
                "AO101",
                "AO102"
            ],
            "purposes": "Monitoring",
            "response": {
                "taxonomyCodes": [
                    "DEI020000"
                ]
            }
        },
        "project": {
            "askedStatus": "AS200",
            "replyStatus": "RS200",
            "availableOptions": [
                "AO100",
                "AO101",
                "AO102"
            ],
            "purposes": "Monitoring",
            "response": {
                "taxonomyCodes": [
                    "DEI020000"
                ]
            }
        }
    }
}

JSON Schema¶

You can download the JSON Schema merge file for the 360-giving-schema.json standard file.

You can download the JSON Schema file 360-giving-schema.json with both elements from the standard and the extension.