Organization#
- pydantic model technote.config.Organization#
Model for describing an organization (often as an affiliation).
- Parameters:
data (
Any
) –
Show JSON schema
{ "title": "Organization", "description": "Model for describing an organization (often as an affiliation).", "type": "object", "properties": { "internal_id": { "title": "Internal Id", "description": "A user-specific identifier for an organization.", "type": "string" }, "ror": { "title": "Ror", "description": "The ROR (ror.org) identifier of the institution.", "minLength": 1, "maxLength": 2083, "format": "uri", "type": "string" }, "name": { "title": "Name", "description": "The display name of the institution.", "type": "string" }, "address": { "title": "Address", "description": "The address of the institution.", "type": "string" }, "url": { "title": "Url", "description": "The homepage of the institution.", "minLength": 1, "maxLength": 2083, "format": "uri", "type": "string" } } }
- Fields:
- Validators:
check_well_defined
»all fields
- field internal_id: Optional[str] = None#
A user-specific identifier for an organization.
- Validated by:
- field ror: Optional[Ror] = None#
The ROR (ror.org) identifier of the institution.
- Constraints:
minLength = 1
maxLength = 2083
format = uri
- Validated by:
- field url: Optional[HttpUrl] = None#
The homepage of the institution.
- Constraints:
minLength = 1
maxLength = 2083
format = uri
- Validated by:
- validator check_well_defined » all fields#
Ensure that at least the internal ID, ROR, or name are provided.