360-giving-schema.json

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "360Giving Data Standard Schema",
  "type":"object",
  "definitions": {
      "currency": {
        "type": "string",
        "description": "The currency used in amounts. Use the three-letter currency code from [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) eg: Use GBP for Pounds Sterling.",
        "weight": 5.02,
        "enum": ["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GGP","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","IMP","INR","IQD","IRR","ISK","JEP","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LVL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SPL","SRD","STD","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TVD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XDR","XOF","XPF","YER","ZAR","ZMW","ZWD"],
        "title": "Currency"
      },
    "Transaction": {
      "type": "object",
      "properties": {
        "id": {
            "type": "string",
            "description": "Identifier",
            "weight": 0.001,
            "title": "Identifier"
        },
        "transactionDate": {
          "format": "date-time",
          "type": "string",
          "description": "When did this transaction take place? Please use YYYY-MM-DD format.",
          "weight": 5,
          "title": "Transaction date"
        },
        "currency": {
          "$ref": "#/definitions/currency"
        },
        "value": {
          "type": "integer",
          "description": "The total value of this transaction.",
          "weight": 6,
          "title": "Value"
        },
        "valueDate": {
          "format": "date-time",
          "type": ["string","null"],
          "description": "The date that this value was set (to allow historical currency conversion). The date must be in ISO 8601 format (YYYY-MM-DD).",
          "weight": 6.1,
          "title": "Value date"
        },
        "description": {
          "type": ["string","null"],
          "description": "A description of this transaction.",
          "weight": 9,
          "title": "Description"
        },
        "provider": {
          "type": ["string","null"],
          "description": "The organisation identifier of the provider of transaction funds.",
          "weight": 0.6,
          "title": "Provider"
        },
        "recipient": {
         "type": ["string","null"],
          "description": "The organisation identifier of the recipient of transaction funds.",
          "weight": 0.7,
          "title": "Recipient"
        },
        "dateModified": {
          "format": "date-time",
          "type": "string",
          "description": "The date and time when information about this transaction was last updated.",
          "weight": 25,
          "title": "Last modified"
        }
      }
    },
    "Documents": {
      "type": "object",
      "properties": {
        "id": {
            "type": "string",
            "description": "An identifier for this document.",
            "weight": 0.001,
            "title": "Identifier"
        },
        "title": {
          "type": ["string","null"],
          "description": "The document title",
          "weight": 1.05,
          "title": "Title"
        },
        "url": {
          "type": ["string","null"],
          "format": "uri",
          "description": "The URL of the document.",
          "weight": 11.01,
          "title": "Web Address"
        },
        "description": {
          "type": ["string","null"],
          "description": "A description of the document",
          "weight": 9,
          "title": "Description"
        },
        "documentType": {
          "type": ["string","null"],
          "description": "A document category. For example, 'Application Form', 'Photo' or 'Project Report'. In future, 360Giving will provide a codelist of document types.",
          "weight": 0.8,
          "title": "Document Type"
        },
        "dateModified": {
          "format": "date-time",
          "type": "string",
          "description": "The date and time when information about this document was last updated.",
          "weight": 25,
          "title": "Last modified"
        }
      }
    },
    "Location": {
      "type": "object",
      "properties": {
       "id": {
         "type": "string",
         "description": "Location identifier",
         "weight": 0.001,
         "title": "Identifier"
        },
        "name": {
          "type": ["string","null"],
          "description": "A name for this location.",
          "weight": 1.1,
          "title": "Name"
        },
        "countryCode": {
          "type": ["string","null"],
          "enum": ["AF","AX","AL","DZ","AS","AD","AO","AI","AQ","AG","AR","AM","AW","AU","AT","AZ","BS","BH","BD","BB","BY","BE","BZ","BJ","BM","BT","BO","BQ","BA","BW","BV","BR","IO","BN","BG","BF","BI","KH","CM","CA","CV","KY","CF","TD","CL","CN","CX","CC","CO","KM","CG","CD","CK","CR","CI","HR","CU","CW","CY","CZ","DK","DJ","DM","DO","EC","EG","SV","GQ","ER","EE","ET","FK","FO","FJ","FI","FR","GF","PF","TF","GA","GM","GE","DE","GH","GI","GR","GL","GD","GP","GU","GT","GG","GN","GW","GY","HT","HM","VA","HN","HK","HU","IS","IN","ID","IR","IQ","IE","IM","IL","IT","JM","JP","JE","JO","KZ","KE","KI","KP","KR","KW","KG","LA","LV","LB","LS","LR","LY","LI","LT","LU","MO","MK","MG","MW","MY","MV","ML","MT","MH","MQ","MR","MU","YT","MX","FM","MD","MC","MN","ME","MS","MA","MZ","MM","NA","NR","NP","NL","NC","NZ","NI","NE","NG","NU","NF","MP","NO","OM","PK","PW","PS","PA","PG","PY","PE","PH","PN","PL","PT","PR","QA","RE","RO","RU","RW","BL","SH","KN","LC","MF","PM","VC","WS","SM","ST","SA","SN","RS","SC","SL","SG","SX","SK","SI","SB","SO","ZA","GS","SS","ES","LK","SD","SR","SJ","SZ","SE","CH","SY","TW","TJ","TZ","TH","TL","TG","TK","TO","TT","TN","TR","TM","TC","TV","UG","UA","AE","GB","US","UM","UY","UZ","VU","VE","VN","VG","VI","WF","EH","YE","ZM","ZW"],
          "description": "The ISO Country Code of the location of this activity.",
          "weight": 2,
          "title": "Country Code"
        },
        "latitude": {
          "type": ["string","null"],
          "description": "The latitude of a point location",
          "weight": 4.001,
          "title": "Latitude"
        },
        "longitude": {
          "type": ["string","null"],
          "description": "The longitude of a point location",
          "weight": 4.002,
          "title": "Longitude"
        },
        "description": {
          "type": ["string","null"],
          "description": "A description of this location. This could include details of the element of the activity that takes place here.",
          "weight": 9,
          "title": "Description"
        },
        "geoCode": {
          "type": ["string","null"],
          "description":"A code referring to a geographical area, drawn from an established gazetteer. For example, the code for a local authority ward, or parliamentary constituency.",
          "weight":5,
          "title":"Geographic Code"
        },
        "geoCodeType": {
          "type": ["string","null"],
          "description":"The type of Geographic Code (geoCode) used (e.g. Ward, Parliamentary Constituency etc.). This value for this field should be drawn from the [codelist of geographic code types](https://github.com/ThreeSixtyGiving/standard/tree/master/codelists/geoCodeType.csv).",
          "weight":5.01,
          "title":"Geographic Code Type"
        },
        "dateModified": {
          "format": "date-time",
          "type": "string",
          "description": "The date and time when information about this location was last updated.",
          "weight": 25,
          "title": "Last modified"
        }
      }
    },
    "Classification": {
      "type": "object",
      "properties": {
        "vocabulary": {
          "type": "string",
          "description": "A vocabulary used for this classification.",
          "weight": 8,
          "title": "Vocabulary"
        },
        "code": {
          "type": "string",
          "description": "A codelist value in the chosen vocabulary.",
          "weight": 9,
          "title": "Code"
        },
        "title": {
          "type": ["string","null"],
          "description": "The title of this classification.",
          "weight": 1.05,
          "title": "Title"
        },
        "description": {
          "type": ["string","null"],
          "description": "A description of this classification.",
          "weight": 9,
          "title": "Description"
        },    
        "url": {
          "type": ["string","null"],
          "format": "uri",
          "description": "A web link to more details of this classification.",
          "weight": 9,
          "title": "URL"
        },
        "dateModified": {
          "format": "date-time",
          "type": "string",
          "description": "The date and time when the information was last updated",
          "weight": 25,
          "title": "Last modified"
        }
      }
    },
    "GrantProgramme": {
              "type": "object",
              "properties": {
               "code": {
                 "type": "string",
                 "description": "An identifier for this grant programme.",
                 "weight": 9,
                 "title": "Code"
               },
               "title": {
                 "type": ["string","null"],
                 "description": "The title of this grant programme.",
                 "weight": 1.05,
                 "title": "Title"
               },
               "description": {
                 "type": ["string","null"],
                 "description": "A description of this grant programme.",
                 "weight": 9,
                 "title": "Description"
               },    
               "url": {
                 "type": ["string","null"],
                 "format": "uri",
                 "description": "A web link to more details of this grant programme.",
                 "weight": 9,
                 "title": "URL"
               },
               "dateModified": {
                 "format": "date-time",
                 "type": "string",
                 "description": "The date and time when information about this grant programme was last updated.",
                 "weight": 25,
                 "title": "Last modified"
               }
              }
            },
    
    "Organization": {
      "type": "object",
      "required":["id","name"],
      "properties": {
        "id": {
          "type": "string",
          "description": "A globally unique identifier for this organisation. This is important to enable data on funders and recipients to be linked up across different grant-makers. The [Organisation Identifier Standard](http://www.threesixtygiving.org/standard/identifiers/#toc-organisation-identifier) guidance explains how to create this ID, based either on the known company or charity number, or upon identifiers held in the grant-maker's internal systems.",
          "weight": 0.001,
          "title": "Identifier"
        },
        "name": {
          "type": "string",
          "description": "Organisation name",
          "weight": 1.1,
          "title": "Name"
        },
        "department": {
            "type":"string",
            "description":"The department or sub-unit of this organisation making or receiving the grant.",
            "title":"Department"
        },
        "contactName": {
          "type": "string",
          "description": "The contact person at this organisation.",
          "weight": 2,
          "title": "Contact Name"
        },
        "charityNumber": {
              "type": "string",
              "description": "Registered charity number, if applicable.",
              "weight": 6.01,
              "title": "Charity Number"
        },
        "companyNumber": {
          "type": "string",
          "description": "Registered UK company number, if applicable.",
          "weight": 6.02,
          "title": "Company Number"
        },
        "streetAddress": {
          "type": "string",
          "description": "Building number and street name.",
          "weight": 3.1,
          "title": "Street Address"
        }, 
        "addressLocality": {
          "type": "string",
          "description": "City or town.",
          "weight": 3.2,
          "title": "City"
        },
        "addressRegion": {
          "type": "string",
          "description": "County",
          "weight": 3.3,
          "title": "County"
        },
        "addressCountry": {
          "type": "string",
          "description": "Country",
          "weight": 3.5,
          "title": "Country"
        },
        "postalCode": {
          "type": "string",
          "description": "Postal code (please try and provide a post code whenever possible)",
          "weight": 3.4,
          "title": "Postal Code"
        },
        "telephone": {
         "type":"string",
         "description":"Contact phone number.",
         "weight":3.5,
         "title": "Phone Number"
        },
        "alternateName": {
          "type": "string",
          "description": "An alternative name for this organisation (e.g. trading name)",
          "weight": 6,
          "title": "Alternate Name"
        },
      "email": {
          "type": "string",
          "description": "The email address for this organisation.",
          "weight": 5,
          "title": "Email"
        },
        "description": {
          "type": "string",
          "description": "A short description of this organisation and its area of work",
          "weight": 9,
          "title": "Description"
        },
        "organisationType": {
          "type": ["string","null"],
          "description": "A description of this organisation",
          "enum":["Registered Charity","Registered Company","Community Group","List to be updated"],
          "weight": 5,
          "title": "Organisation Type"
        },
        "url": {
          "type": "string",
          "format": "uri",
          "description": "A web address for the Organisation",
          "weight": 11.01,
          "title": "Web Address"
        },
        "location": {
          "items": {
            "$ref": "#/definitions/Location"
          },
          "type": "array",
          "description": "-",
          "weight": 5,
          "title": "Location"
        },
        "dateModified": {
          "format": "date-time",
          "type": "string",
          "description": "The date and time when information about this organisation was last updated.",
          "weight": 25,
          "title": "Last modified"
        }
      }
    },
    "Event": {
      "definitions": {},
      "type": "object",
      "title":"Event",
      "description":"An event in the life of the grant activity",
      "properties": {
        "title": {
            "type": "string",
            "description": "-",
            "weight": 1.05,
            "title": "Title"
        },
        "startDate": {
          "format": "date-time",
          "type": "string",
          "description": "All events should have a start date. Dates should be in YYYY-MM-DD format. If the month or day are not available, these may be omitted.",
          "weight": 4.1,
          "title": "Start Date"
        },
        "endDate": {
          "format": "date-time",
          "type": "string",
          "description": "Events or activities lasting more than one day should have either a duration (in months) or an end date. Dates should be in YYYY-MM-DD format. If the month or day are not available, these may be omitted.",
          "weight": 4.3,
          "title": "End Date"
        },
        "duration": {
          "type": "string",
          "description": "Events or activities lasting more than one day should have either a duration (in months) or an end date.",
          "weight": 4.2,
          "title": "Duration (months)"
        },
        "description": {
          "type": "string",
          "description": "-",
          "weight": 9,
          "title": "Description"
        },
         "dateModified": {
              "format": "date-time",
              "type": "string",
              "description": "The date and time when information about this event was last updated.",
              "weight": 25,
              "title": "Last modified"
            }
      }
    }
  },
  "required":["id","title","description","currency","amountAwarded","awardDate", "recipientOrganization", "fundingOrganization"],
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this grant. Made up of your 360Giving prefix, and an identifier from your records. See the [360Giving Grant identifier guidance](http://www.threesixtygiving.org/standard/identifiers/#toc-grant-identifier) for details.",
      "weight": 0.001,
      "title": "Identifier"
    },
    "title": {
      "type": "string",
      "description": "A title for this grant activity. This should be under 140 characters long.",
      "weight": 1.05,
      "title": "Title"
    },
    "description": {
      "type": "string",
      "description": "A short description of this grant activity.",
      "weight": 9,
      "title": "Description"
    },
    "currency": {
      "$ref": "#/definitions/currency"
    },
    "amountAppliedFor": {
      "type": "number",
      "description": "Total amount applied for in numbers (do not include commas or currency symbols such as £). If you have provided detailed transaction information on a separate table, this should equal the sum of all the application transactions for this grant.",
      "weight": 5.03,
      "title": "Amount Applied For"
    },
    "amountAwarded": {
      "type": "number",
      "description": "Total amount awarded in numbers (do not include commas or currency symbols such as £). If you have provided detailed transaction information on a separate table, this should equal the sum of all the award transactions for this grant.",
      "weight": 5.04,
      "title": "Amount Awarded"
    },
    "amountDisbursed": {
         "type": "number",
         "description": "Total amount disbursed (paid) to this grantee when this record was last updated (in numbers: do not include commas or currency symbols such as £)). If you have provided detailed transaction information on a separate table, this should equal the sum of all the disbursement transactions for this grant.",
         "weight": 5.04,
         "title": "Amount Disbursed"
    },
    "awardDate": {
      "format": "date-time",
      "type": "string",
      "description": "When was the decision to award this grant made. Dates should be in YYYY-MM-DD format.",
      "weight": 4.3,
      "title": "Award Date"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "A URL (Web Address) where further information about this grant can be found. This could point to the website of the recipient organisation, or might link to further details on the funders website.",
      "weight": 11.01,
      "title": "URL"
    },
    "plannedDates": {
      "items": {
        "$ref": "#/definitions/Event"
      },
      "type": "array",
      "weight": 5.041,
      "title": "Planned Dates",
      "description":"When the applicant / implementing organisation originally intend this activity to take place. ",
      "rollUp": ["startDate","endDate","duration"]      
    },
    "actualDates": {
      "items": {
        "$ref": "#/definitions/Event"
      },
      "type": "array",
      "description": "When did this grant activity actually take place. Dates should be in YYYY-MM-DD format. A date range can include a start date and duration in months, or a start and end date.",
      "weight": 5.041,
      "title": "Actual Dates"
    },
    "recipientOrganization": {
      "items": {
        "$ref": "#/definitions/Organization"
      },
      "minItems": 1,
      "type": "array",
      "weight": 5,
      "title": "Recipient Org",
      "description":"Details of the recipient of this grant.",
      "rollUp": ["id","name","charityNumber","companyNumber","streetAddress","addressLocality","addressRegion","postalCode","addressCountry","description","url"]      
    },
    "beneficiaryLocation": {
      "items": {
        "$ref": "#/definitions/Location"
      },
      "type": "array",
      "description": "Beneficiary locations",
      "weight": 6.01,
      "title": "Beneficiary Location",
      "description":"Information about the location of beneficiaries. Further information about beneficiaries can be provided through classifications.",
      "rollUp": ["name","countryCode","latitude","longitude","geoCode","geoCodeType"]
    },
    "fundingOrganization": {
      "items": {
        "$ref": "#/definitions/Organization"
      },
      "minItems": 1,
      "type": "array",
      "description": "Details of the funder",
      "weight": 4,
      "title": "Funding Org",
      "rollUp": ["id","name","department"]
    },
    "grantProgramme": {
      "items": {
        "$ref": "#/definitions/GrantProgramme"
      },
      "type": "array",
      "description": "-",
      "weight": 5,
      "title": "Grant Programme",
      "rollUp": ["code","title","url"]
    },
    "fromOpenCall": {
      "type": "string",
      "enum": ["Yes","No"],
      "description": "Was this grant made as the result of an open call for applications? Values should be 'Yes' or 'No'",
      "weight": 12,
      "title": "From an open call?"
    },
    "fundingType": {
      "items": {
        "$ref": "#/definitions/Classification"
      },
      "type": "array",
      "description": "-",
      "weight": 5,
      "title": "Funding Type"
    },
    "classifications": {
      "items": {
        "$ref": "#/definitions/Classification"
      },
      "type": "array",
      "description": "-",
      "weight": 5,
      "title": "Classifications"
    },
    "relatedDocument": {
      "items": {
        "$ref": "#/definitions/Documents"
      },
      "type": "array",
      "description": "-",
      "weight": 5,
      "title": "Related Document"
    },
    "applicationTransaction": {
      "items": {
        "$ref": "#/definitions/Transaction"
      },
      "type": "array",
      "description": "-",
      "weight": 5.02
    },
    "commitmentTransaction": {
      "items": {
        "$ref": "#/definitions/Transaction"
      },
      "type": "array",
      "description": "-",
      "weight": 5.02
    },
    "disbursementTransaction": {
         "items": {
           "$ref": "#/definitions/Transaction"
         },
         "type": "array",
         "description": "-",
         "weight": 5
       },
    "relatedActivity": {
      "type": "array",
      "items": {
        "type":"string"
      },
      "description": "The identifiers of any related activities (e.g. other grants given as part of a multi-grant project)",
      "weight": 15,
      "title": "Related Activity"
    },
    "dateModified": {
      "format": "date-time",
      "type": "string",
      "description": "The date and time when information about this grant was last updated.",
      "weight": 25,
      "title": "Last modified"
    },
    "dataSource": {
      "format": "uri",
      "type": ["string","null"],
      "description": "A web link pointing to the source of this data. This may be an original 360Giving data file, a file from which the data was converted, or an organisation website.",
      "weight": 25,
      "title": "Data Source"
    }
  }
}