HOME

{
	"title": "Institution",
	"description": "An institution, such as a university, that may be used to track usage statistics, handle subscriptions, and more.",
	"required": [
		"contextId",
		"name"
	],
	"properties": {
		"_href": {
			"type": "string",
			"description": "The URL to this institution in the REST API.",
			"format": "uri",
			"readOnly": true,
			"apiSummary": true
		},
		"contextId": {
			"type": "integer",
			"description": "The context which added this institution.",
			"writeDisabledInApi": true,
			"apiSummary": true
		},
		"id": {
			"type": "integer",
			"description": "The unique id of the institution in the database.",
			"readOnly": true,
			"apiSummary": true
		},
		"name": {
			"type": "string",
			"description": "The name of this institution.",
			"multilingual": true,
			"apiSummary": true,
			"validation": [
				"nullable"
			]
		},
		"ror": {
			"type": "string",
			"description": "The [ROR](https://ror.org/) id of this institution.",
			"apiSummary": true,
			"validation": [
				"nullable",
				"regex:#https://ror.org/0[^ILOU]{6}\\d{2}#"
			]
		},
		"deletedAt": {
			"type": "string",
			"description": "The date this institution was deleted, if it has been deleted. Institutions are kept after being deleted because they may be referenced in statistics data.",
			"readOnly": true,
			"apiSummary": true
		},
		"ipRanges": {
			"type": "array",
			"description": "A list of IP ranges belonging to this institution. Used to track usage statistics and subscription access by institution.",
			"apiSummary": true,
			"items": {
				"type": "string"
			}
		}
	}
}