Permalink
Cannot retrieve contributors at this time
Name already in use
A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
schema/tap-attribute-dictionary2021-04.json
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
1490 lines (1488 sloc)
47 KB
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "$schema": "https://json-schema.org/draft/2019-09/schema", | |
| "$id": "https://github.internet2.edu/benno/core-schema/tree/draft/schema/json/attribute-dictionary.json", | |
| "title": "TAP Attribute Dictionary", | |
| "description": "JSON representation of TAP Attribute Dictionary attributes", | |
| "definitions": { | |
| "address": { | |
| "title": "Address", | |
| "description": "A physical or postal address.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "country": { | |
| "description": "Country in which the address is located.", | |
| "type": "string", | |
| "format": "country", | |
| "examples": [ "AU", "CA", "JP", "NZ", "UK", "US" ] | |
| }, | |
| "formatted": { | |
| "description": "Address rendered as a single string, possibly with embedded newlines (\n).", | |
| "type": "string" | |
| }, | |
| "language": { | |
| "description": "The language encoding of the address.", | |
| "type": "string", | |
| "format": "locale", | |
| "examples": [ "en_UK", "en_US", "es_ES", "es_US", "jp_JP" ] | |
| }, | |
| "locality": { | |
| "description": "Locality information from an address, such as a city name.", | |
| "type": "string", | |
| "examples": [ "London", "New York", "東京" ] | |
| }, | |
| "postalCode": { | |
| "description": "Postal code from an address.", | |
| "type": "string", | |
| "examples": [ "90210", "CB2 1PQ" ] | |
| }, | |
| "region": { | |
| "description": "Region information from an address, such as a state or province.", | |
| "type": "string", | |
| "format": "region", | |
| "examples": [ "New York", "Ontario" ] | |
| }, | |
| "room": { | |
| "description": "Room from an address.", | |
| "type": "string" | |
| }, | |
| "streetAddress": { | |
| "description": "Street or site information from an address, including street name, house number, etc. May include embedded newlines (\n).", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Address type.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "break", | |
| "campus", | |
| "home", | |
| "office", | |
| "parent", | |
| "postal", | |
| "former-break", | |
| "former-campus", | |
| "former-home", | |
| "former-office", | |
| "former-parent", | |
| "former-postal" | |
| ] | |
| }, | |
| "verified": { | |
| "description": "Whether the address has been verified, typically by delivery of a token that is subsequently confirmed by the subject.", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "addresses": { | |
| "title": "Addresses", | |
| "description": "Zero or more physical or postal addresses.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/address" | |
| } | |
| }, | |
| "citizenship": { | |
| "title": "Citizenship", | |
| "description": "Country of citizenship of the subject.", | |
| "type": "string", | |
| "format": "country" | |
| }, | |
| "citizenship-m": { | |
| "title": "Citizenship with Metadata", | |
| "description": "Country of citizenship of the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/citizenship" | |
| } | |
| } | |
| }, | |
| "citizenships": { | |
| "title": "Citizenships", | |
| "description": "Zero or more citizenships.", | |
| "type": "array", | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/citizenship" | |
| }, | |
| { | |
| "$ref": "#/definitions/citizenship-m" | |
| } | |
| ] | |
| }, | |
| "currentPage": { | |
| "title": "Current Page", | |
| "description": "A positive integer indicating the current page of results. This will typically correspond to the page request attribute if specified.", | |
| "type": "integer", | |
| "minimum": 1 | |
| }, | |
| "created": { | |
| "title": "Created", | |
| "description": "A Metadata attribute used to indicate the attribute or record creation time.", | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "dateOfBirth": { | |
| "title": "Date Of Birth", | |
| "description": "Date of birth of the subject.", | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "dateOfBirth-m": { | |
| "title": "Date Of Birth with Metadata", | |
| "description": "Date of birth of the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/dateOfBirth" | |
| } | |
| } | |
| }, | |
| "datesOfBirth": { | |
| "title": "Dates Of Birth", | |
| "description": "Dates of birth of the subject.", | |
| "type": "array", | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/dateOfBirth" | |
| }, | |
| { | |
| "$ref": "#/definitions/dateOfBirth-m" | |
| } | |
| ] | |
| }, | |
| "deleted": { | |
| "title": "Deleted", | |
| "description": "A Metadata attribute used to indicate that the attribute or record has been deleted.", | |
| "type": "boolean" | |
| }, | |
| "direction": { | |
| "title": "Direction", | |
| "description": "A string controlling the direction of the sort of the requested objects.", | |
| "type": "string", | |
| "enum": [ "asc", "desc" ] | |
| }, | |
| "emailAddress": { | |
| "title": "Email Address", | |
| "description": "An electronic mail address.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "address": { | |
| "description": "The email address. The expected value of this attribute is a string in RFC5322 addr-spec style (eg: foo@university.edu).", | |
| "type": "string", | |
| "format": "RFC 5322" | |
| }, | |
| "type": { | |
| "description": "Email Address type.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "delivery", | |
| "department", | |
| "forwarding", | |
| "official", | |
| "personal", | |
| "preferred", | |
| "former-delivery", | |
| "former-department", | |
| "former-forwarding", | |
| "former-official", | |
| "former-personal", | |
| "former-preferred" | |
| ] | |
| }, | |
| "verified": { | |
| "description": "Whether the email address has been verified, typically by delivery of a token that is subsequently confirmed by the subject.", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "emailAddresses": { | |
| "title": "Email Addresses", | |
| "description": "Zero or more electronic mail addresses.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/emailAddress" | |
| } | |
| }, | |
| "ethnicity": { | |
| "title": "Ethnicity", | |
| "description": "The ethnicity of the subject. The default values for this attribute are as per the US Census Bureau. These values may not be suitable for use outside of US federal reporting requirements.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "africanAmerican", | |
| "alaskaNative", | |
| "americanIndian", | |
| "asian", | |
| "hispanic", | |
| "nativeHawaiian", | |
| "other", | |
| "pacificIslander", | |
| "white" | |
| ] | |
| }, | |
| "ethnicity-m": { | |
| "title": "Ethnicity with Metadata", | |
| "description": "The ethnicity of the subject. The default values for this attribute are as per the US Census Bureau. These values may not be suitable for use outside of US federal reporting requirements.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/ethnicity" | |
| } | |
| } | |
| }, | |
| "ethnicities": { | |
| "title": "Ethnicities", | |
| "description": "The ethnicity of the subject. The default values for this attribute are as per the US Census Bureau. These values may not be suitable for use outside of US federal reporting requirements.", | |
| "type": "array", | |
| "items": [ | |
| { | |
| "$ref": "#/definitions/ethnicity" | |
| }, | |
| { | |
| "$ref": "#/definitions/ethnicity-m" | |
| } | |
| ] | |
| }, | |
| "gender": { | |
| "title": "Gender", | |
| "description": "Gender of the subject, self asserted.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "female", | |
| "male", | |
| "nonBinary" | |
| ] | |
| }, | |
| "gender-m": { | |
| "title": "Gender with Metadata", | |
| "description": "Gender of the subject, self asserted.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/gender" | |
| } | |
| } | |
| }, | |
| "id": { | |
| "title": "ID", | |
| "description": "A Metadata attribute used to uniquely identify the attribute value or record.", | |
| "type": "string", | |
| "format": "caseSensitive" | |
| }, | |
| "identifier": { | |
| "title": "Identifier", | |
| "description": "An identifier.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "identifier": { | |
| "description": "The identifier.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "Identifier type.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "applicant", | |
| "badge", | |
| "badge-barcode", | |
| "badge-chip", | |
| "badge-magstripe", | |
| "enterprise", | |
| "external", | |
| "national", | |
| "network", | |
| "orcid", | |
| "reference", | |
| "role", | |
| "sor" | |
| ] | |
| } | |
| } | |
| }, | |
| "identifiers": { | |
| "title": "Identifiers", | |
| "description": "Zero or more identifiers.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/identifier" | |
| } | |
| }, | |
| "identityDocument": { | |
| "title": "Identity Document", | |
| "description": "A representation of an identity document, as (eg) might be used for identity proofing.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "dateOfBirth": { | |
| "description": "Date of birth, as confirmed on the identity document.", | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "documentIssuer": { | |
| "description": "Name of agency issuing the identity document.", | |
| "type": "string" | |
| }, | |
| "documentType": { | |
| "description": "Type of document used to confirm identity.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "birthCertificate", | |
| "driversLicense", | |
| "local", | |
| "national", | |
| "nonDriver", | |
| "passport", | |
| "regional", | |
| "residency", | |
| "selfAssertion", | |
| "tribal", | |
| "visa" | |
| ] | |
| }, | |
| "fullName": { | |
| "description": "Full name, as confirmed on the identity document.", | |
| "type": "string" | |
| }, | |
| "status": { | |
| "description": "Status of the identity document.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "expired", | |
| "invalid", | |
| "valid" | |
| ] | |
| }, | |
| "timeVerified": { | |
| "description": "When the identity document was verified.", | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "validFrom": { | |
| "description": "Date identity document is valid from, as asserted by the document itself.", | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "validThrough": { | |
| "description": "Date identity document is valid through, as asserted by the document itself.", | |
| "type": "string", | |
| "format": "date" | |
| }, | |
| "verifiedAddress": { | |
| "description": "Physical address, as confirmed on the identity document.", | |
| "type": "string" | |
| } | |
| } | |
| }, | |
| "identityDocuments": { | |
| "title": "Identity Documents", | |
| "description": "Zero or more identity documents.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/identityDocument" | |
| } | |
| }, | |
| "itemsPerPage": { | |
| "title": "Items Per Page", | |
| "description": "A non-negative integer indicating the number of records in the current page of results. This will typically correspond to the limit request attribute if specified, though it may be less.", | |
| "type": "integer", | |
| "minimum": 0 | |
| }, | |
| "lastModified": { | |
| "title": "Last Modified", | |
| "description": "A Metadata attribute used to indicate the last modification time for the attribute or record.", | |
| "type": "string", | |
| "format": "date-time" | |
| }, | |
| "limit": { | |
| "title": "Limit", | |
| "description": "A positive integer indicating the maximum number of results to return per page. It is acceptable for the response to include fewer than limit records.", | |
| "type": "integer", | |
| "minimum": 1 | |
| }, | |
| "member": { | |
| "title": "Member", | |
| "description": "Indication of a group membership.", | |
| "type": "string" | |
| }, | |
| "member-m": { | |
| "title": "Member with Metadata", | |
| "description": "Indication of a group membership.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/member" | |
| } | |
| } | |
| }, | |
| "members": { | |
| "title": "Members", | |
| "description": "Zero or more members.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/member" | |
| } | |
| }, | |
| "name": { | |
| "title": "Name", | |
| "description": "A name for the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "family": { | |
| "description": "The subject’s family name, excluding any given, middle, or honorific components.", | |
| "type": "string" | |
| }, | |
| "formatted": { | |
| "description": "The subject’s fully formatted name, localized for the selected language.", | |
| "type": "string" | |
| }, | |
| "given": { | |
| "description": "The subject’s given name, excluding any middle, family, or honorific components. When a subject has only one name, it should typically be placed in this attribute.", | |
| "type": "string" | |
| }, | |
| "language": { | |
| "description": "The language encoding of the name.", | |
| "type": "string", | |
| "format": "locale" | |
| }, | |
| "prefix": { | |
| "description": "The honorific prefix of the subject’s name, such as \"Dr\" or \"Hon\".", | |
| "type": "string" | |
| }, | |
| "suffix": { | |
| "description": "The honorific suffix of the subject’s name, such as \"Jr\" or \"III\".", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "The type of this name.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "author", | |
| "fka", | |
| "official", | |
| "preferred" | |
| ] | |
| } | |
| } | |
| }, | |
| "names": { | |
| "title": "Names", | |
| "description": "Zero or more names.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/name" | |
| } | |
| }, | |
| "objectType": { | |
| "title": "Object Type", | |
| "description": "The type of record being described.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "department", | |
| "group", | |
| "organization", | |
| "person" | |
| ] | |
| }, | |
| "page": { | |
| "title": "Page", | |
| "description": "A positive integer indicating the number of the page to return results for. As a positive integer, the first page of results is 1.", | |
| "type": "integer", | |
| "minimum": 1 | |
| }, | |
| "pageCount": { | |
| "title": "Page Count", | |
| "description": "A non-negative integer indicating the total number of pages.", | |
| "type": "integer", | |
| "minimum": 0 | |
| }, | |
| "photo": { | |
| "title": "Photo", | |
| "description": "Encoding of a photo of the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "data": { | |
| "description": "Encoding of the subject’s photo.", | |
| "type": "binary" | |
| }, | |
| "encoding": { | |
| "description": "The type of encoding used for the subject’s photo.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "bmp", | |
| "gif", | |
| "jpg", | |
| "png", | |
| "tiff" | |
| ] | |
| }, | |
| "type": { | |
| "description": "The type or purpose of the photo, not the encoding.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "badge", | |
| "official", | |
| "personal" | |
| ] | |
| } | |
| } | |
| }, | |
| "photos": { | |
| "title": "Photos", | |
| "description": "Zero or more photos.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/photo" | |
| } | |
| }, | |
| "primaryAffiliation": { | |
| "title": "Primary Affiliation", | |
| "description": "The primary affiliation for the person, as defined by the organization.", | |
| "type": "string" | |
| }, | |
| "primaryAffiliation-m": { | |
| "title": "Primary Affiliation with Metadata", | |
| "description": "The primary affiliation for the person, as defined by the organization.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/primaryAffiliation" | |
| } | |
| } | |
| }, | |
| "primaryCampus": { | |
| "title": "Primary Campus", | |
| "description": "The primary campus location for the person, as defined by the organization.", | |
| "type": "string" | |
| }, | |
| "primaryCampus-m": { | |
| "title": "Primary Campus with Metadata", | |
| "description": "The primary campus for the person, as defined by the organization.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/primaryCampus" | |
| } | |
| } | |
| }, | |
| "pronouns": { | |
| "title": "Pronouns", | |
| "description": "Pronouns as asserted by the subject.", | |
| "type": "string" | |
| }, | |
| "pronouns-m": { | |
| "title": "Pronouns with Metadata", | |
| "description": "Pronouns as asserted by the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/pronouns" | |
| } | |
| } | |
| }, | |
| "release": { | |
| "title": "Release Policy", | |
| "description": "The release policy for the attribute value or record.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "internal", | |
| "private", | |
| "public" | |
| ] | |
| }, | |
| "residency": { | |
| "title": "Residency", | |
| "description": "Country of residency of the subject.", | |
| "type": "string" | |
| }, | |
| "residency-m": { | |
| "title": "Residency with Metadata", | |
| "description": "Country of residency of the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/residency" | |
| } | |
| } | |
| }, | |
| "residencies": { | |
| "title": "Residencies", | |
| "description": "Zero or more residencies.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/residency" | |
| } | |
| }, | |
| "revision": { | |
| "title": "Revision", | |
| "description": "A Metadata attribute used to indicate the revision number of the attribute value or record.", | |
| "type": "integer", | |
| "minimum": 0 | |
| }, | |
| "sort": { | |
| "title": "Sort", | |
| "description": "The attribute to sort the results on.", | |
| "type": "string" | |
| }, | |
| "source": { | |
| "title": "Source", | |
| "description": "A Metadata attribute used to indicate the authority or source of the attribute value or record.", | |
| "type": "string" | |
| }, | |
| "startIndex": { | |
| "title": "Start Index", | |
| "description": "A positive integer indicating the index of the first result (out of totalResults) in the current page, starting from 1 (the first result on the first page).", | |
| "type": "integer", | |
| "minimum": 1 | |
| }, | |
| "totalResults": { | |
| "title": "Total Results", | |
| "description": "A non-negative integer indicating the total number of records.", | |
| "type": "integer", | |
| "minimum": 0 | |
| }, | |
| "version": { | |
| "title": "Version", | |
| "description": "A Metadata attribute used to indicate the API version this record corresponds to.", | |
| "type": "string" | |
| }, | |
| "role": { | |
| "title": "Role", | |
| "description": "A representation of the subject’s role or association with the organization.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "addresses": { | |
| "$ref": "#/definitions/addresses" | |
| }, | |
| "affiliation": { | |
| "title": "Affiliation", | |
| "description": "The person's affiliation for this role, as defined by the organization.", | |
| "type": "string" | |
| }, | |
| "affiliation-m": { | |
| "title": "Affiliation with Metadata", | |
| "description": "The person's affiliation for this role, as defined by the organization.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/affiliation" | |
| } | |
| } | |
| }, | |
| "campus": { | |
| "title": "Campus", | |
| "description": "The person's campus location for this role, as defined by the organization.", | |
| "type": "string" | |
| }, | |
| "campus-m": { | |
| "title": "Campus with Metadata", | |
| "description": "The person's campus location for this role, as defined by the organization.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/campus" | |
| } | |
| } | |
| }, | |
| "campusCode": { | |
| "title": "Campus Code", | |
| "description": "The campus location this role is attached to, as defined by the organization and represented as a machine readable identifier.", | |
| "type": "string" | |
| }, | |
| "campusCode-m": { | |
| "title": "Campus Code with Metadata", | |
| "description": "The campus location this role is attached to, as defined by the organization and represented as a machine readable identifier.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/campusCode" | |
| } | |
| } | |
| }, | |
| "department": { | |
| "title": "Department", | |
| "description": "The name of the department this role is attached to.", | |
| "type": "string" | |
| }, | |
| "department-m": { | |
| "title": "Department with Metadata", | |
| "description": "The name of the department this role is attached to.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/department" | |
| } | |
| } | |
| }, | |
| "departmentCode": { | |
| "title": "Department Code", | |
| "description": "The department this role is attached to, as represented as a machine readable identifier.", | |
| "type": "string" | |
| }, | |
| "departmentCode-m": { | |
| "title": "Department Code with Metadata", | |
| "description": "The department this role is attached to, as represented as a machine readable identifier.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/departmentCode" | |
| } | |
| } | |
| }, | |
| "displayTitle": { | |
| "title": "Display Title", | |
| "description": "The display title for this role.", | |
| "type": "string" | |
| }, | |
| "displayTitle-m": { | |
| "title": "Display Title with Metadata", | |
| "description": "The display title for this role.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/displayTitle" | |
| } | |
| } | |
| }, | |
| "emailAddresses": { | |
| "$ref": "#/definitions/emailAddresses" | |
| }, | |
| "identifiers": { | |
| "$ref": "#/definitions/identifiers" | |
| }, | |
| "leaveBegins": { | |
| "title": "Leave Begins", | |
| "description": "Time at which leave from this role begins.", | |
| "type": "dateTime" | |
| }, | |
| "leaveBegins-m": { | |
| "title": "Leave Begins with Metadata", | |
| "description": "Time at which leave from this role begins.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/leaveBegins" | |
| } | |
| } | |
| }, | |
| "leaveEnds": { | |
| "title": "Leave Ends", | |
| "description": "Time after which leave from this role is no longer in effect.", | |
| "type": "dateTime" | |
| }, | |
| "leaveEnds-m": { | |
| "title": "Leave Ends with Metadata", | |
| "description": "Time after which leave from this role is no longer in effect.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/leaveEnds" | |
| } | |
| } | |
| }, | |
| "manager": { | |
| "$ref": "#/definitions/identifier" | |
| }, | |
| "manager-m": { | |
| "title": "Manager with Metadata", | |
| "description": "An identifier describing the manager for this role.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/identifier" | |
| } | |
| } | |
| }, | |
| "managers": { | |
| "title": "Managers", | |
| "description": "Zero or more managers for this role.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/identifier" | |
| } | |
| }, | |
| "organization": { | |
| "title": "Organization", | |
| "description": "The name of the organization or institution this role is attached to.", | |
| "type": "string" | |
| }, | |
| "organization-m": { | |
| "title": "Organization with Metadata", | |
| "description": "The name of the organization or institution this role is attached to.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/organization" | |
| } | |
| } | |
| }, | |
| "organizationCode": { | |
| "title": "Organization Code", | |
| "description": "The organization or institution this role is attached to, as represented as a machine readable identifier.", | |
| "type": "string" | |
| }, | |
| "organizationCode-m": { | |
| "title": "Organization Code with Metadata", | |
| "description": "The organization or institution this role is attached to, as represented as a machine readable identifier.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/organizationCode" | |
| } | |
| } | |
| }, | |
| "percentTime": { | |
| "title": "Percent Time", | |
| "description": "The percentage time for this role, from 0 (no time allocated) to 100 (full time).", | |
| "type": "integer" | |
| }, | |
| "percentTime-m": { | |
| "title": "Percent Time with Metadata", | |
| "description": "The percentage time for this role, from 0 (no time allocated) to 100 (full time).", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/percentTime" | |
| } | |
| } | |
| }, | |
| "rank": { | |
| "title": "Rank", | |
| "description": "The rank of this role relative to all roles from all Systems of Record.", | |
| "type": "integer" | |
| }, | |
| "rank-m": { | |
| "title": "Rank with Metadata", | |
| "description": "The rank of this role relative to all roles from all Systems of Record.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/rank" | |
| } | |
| } | |
| }, | |
| "rankSor": { | |
| "title": "SOR Rank", | |
| "description": "The rank of this role relative to only roles from this System of Record.", | |
| "type": "integer" | |
| }, | |
| "rankSor-m": { | |
| "title": "SOR Rank with Metadata", | |
| "description": "The rank of this role relative to only roles from this System of Record.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/rankSor" | |
| } | |
| } | |
| }, | |
| "roleBegins": { | |
| "title": "Role Begins", | |
| "description": "Time at which this role officially begins.", | |
| "type": "dateTime" | |
| }, | |
| "roleBegins-m": { | |
| "title": "Role Begins with Metadata", | |
| "description": "Time at which this role officially begins.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/roleBegins" | |
| } | |
| } | |
| }, | |
| "roleEnds": { | |
| "title": "Role Ends", | |
| "description": "Time after which this role is no longer in effect.", | |
| "type": "dateTime" | |
| }, | |
| "roleEnds-m": { | |
| "title": "Role Ends with Metadata", | |
| "description": "Time after which this role is no longer in effect.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/roleEnds" | |
| } | |
| } | |
| }, | |
| "sor": { | |
| "title": "SOR", | |
| "description": "Label identifying the System of Record authoritative for this role.", | |
| "type": "string" | |
| }, | |
| "sor-m": { | |
| "title": "SOR with Metadata", | |
| "description": "Label identifying the System of Record authoritative for this role.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/sor" | |
| } | |
| } | |
| }, | |
| "sponsor": { | |
| "$ref": "#/definitions/identifier" | |
| }, | |
| "sponsor-m": { | |
| "title": "Sponsor with Metadata", | |
| "description": "An identifier describing the sponsor for this role.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/identifier" | |
| } | |
| } | |
| }, | |
| "sponsors": { | |
| "title": "Sponsors", | |
| "description": "Zero or more sponsors for this role.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/identifier" | |
| } | |
| }, | |
| "status": { | |
| "title": "Role Status", | |
| "description": "Status associated with this role.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "accepted", | |
| "applied", | |
| "active", | |
| "offered", | |
| "onLeave", | |
| "registered", | |
| "suspended", | |
| "terminated" | |
| ] | |
| }, | |
| "status-m": { | |
| "title": "Role Status with Metadata", | |
| "description": "Status associated with this role.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/status" | |
| } | |
| } | |
| }, | |
| "telephoneNumbers": { | |
| "$ref": "#/definitions/telephoneNumbers" | |
| }, | |
| "terminationReason": { | |
| "title": "Role Termination Reason", | |
| "description": "Reason for termination of this role.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "deceased", | |
| "graduated", | |
| "involuntary", | |
| "resigned", | |
| "retired", | |
| "withdrew" | |
| ] | |
| }, | |
| "title": { | |
| "title": "Role Title", | |
| "description": "The official title for this role.", | |
| "type": "string" | |
| }, | |
| "title-m": { | |
| "title": "Role Title with Metadata", | |
| "description": "The official title for this role.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/title" | |
| } | |
| } | |
| }, | |
| "type": { | |
| "title": "Role Type", | |
| "description": "The type associated with this role.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "consultant", | |
| "continuing", | |
| "contractor", | |
| "emeritus", | |
| "exempt", | |
| "graduate", | |
| "nondegree", | |
| "professional", | |
| "regular", | |
| "secondary", | |
| "summer", | |
| "tenured", | |
| "undergraduate", | |
| "vendor", | |
| "visiting", | |
| "workStudy" | |
| ] | |
| }, | |
| "type-m": { | |
| "title": "Role Type with Metadata", | |
| "description": "The type associated with this role.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/type" | |
| } | |
| } | |
| }, | |
| "urls": { | |
| "$ref": "#/definitions/urls" | |
| }, | |
| "validFrom": { | |
| "title": "Valid From", | |
| "description": "Time at which services associated with this role should begins.", | |
| "type": "dateTime" | |
| }, | |
| "validFrom-m": { | |
| "title": "Valid From with Metadata", | |
| "description": "Time at which services associated with this role should begins.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/validFrom" | |
| } | |
| } | |
| }, | |
| "validThrough": { | |
| "title": "Valid Through", | |
| "description": "Time after which services associated with this role should be terminated.", | |
| "type": "dateTime" | |
| }, | |
| "validThrough-m": { | |
| "title": "Valid Through with Metadata", | |
| "description": "Time after which services associated with this role should be terminated.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/role/validThrough" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "roles": { | |
| "title": "Roles", | |
| "description": "Zero or more roles.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/role" | |
| } | |
| }, | |
| "status": { | |
| "title": "Status", | |
| "description": "Status of the subject.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "accepted", | |
| "applied", | |
| "active", | |
| "offered", | |
| "onLeave", | |
| "registered", | |
| "suspended", | |
| "terminated" | |
| ] | |
| }, | |
| "status-m": { | |
| "title": "Status with Metadata", | |
| "description": "Status of the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/status" | |
| } | |
| } | |
| }, | |
| "telephoneNumber": { | |
| "title": "Telephone Number", | |
| "description": "Telephone number for the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "number": { | |
| "description": "Telephone number, preferably in E.164 notation.", | |
| "type": "string", | |
| "format": "E.164" | |
| }, | |
| "type": { | |
| "description": "Telephone Number type.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "campus", | |
| "fax", | |
| "home", | |
| "mobile", | |
| "office", | |
| "summer", | |
| "former-campus", | |
| "former-fax", | |
| "former-home", | |
| "former-mobile", | |
| "former-office", | |
| "former-summer" | |
| ] | |
| }, | |
| "verified": { | |
| "description": "Whether the telephone number has been verified, typically by delivery of a token that is subsequently confirmed by the subject.", | |
| "type": "boolean" | |
| } | |
| } | |
| }, | |
| "telephoneNumbers": { | |
| "title": "Telephone Numbers", | |
| "description": "Zero or more telephone numbers.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/telephoneNumber" | |
| } | |
| }, | |
| "test": { | |
| "title": "Test Entry", | |
| "description": "Whether this record represents a test entry.", | |
| "type": "boolean" | |
| }, | |
| "test-m": { | |
| "title": "Test Entry with Metadata", | |
| "description": "Whether this record represents a test entry.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "value": { | |
| "$ref": "#/definitions/test" | |
| } | |
| } | |
| }, | |
| "url": { | |
| "title": "URL", | |
| "description": "URL for the subject.", | |
| "type": "object", | |
| "properties": { | |
| "meta": { | |
| "$ref": "#/properties/attributeMeta" | |
| }, | |
| "url": { | |
| "description": "URL for the subject.", | |
| "type": "string" | |
| }, | |
| "type": { | |
| "description": "URL type.", | |
| "type": "string", | |
| "format": "extensible", | |
| "enum": [ | |
| "official", | |
| "personal" | |
| ] | |
| } | |
| } | |
| }, | |
| "urls": { | |
| "title": "URLs", | |
| "description": "Zero or more URLs.", | |
| "type": "array", | |
| "items": { | |
| "$ref": "#/definitions/url" | |
| } | |
| } | |
| }, | |
| "type": "object", | |
| "properties": { | |
| "attributeMeta": { | |
| "type": "object", | |
| "properties": { | |
| "created": { "$ref": "#/definitions/created" }, | |
| "deleted": { "$ref": "#/definitions/deleted" }, | |
| "id": { "$ref": "#/definitions/id" }, | |
| "lastModified": { "$ref": "#/definitions/lastModified" }, | |
| "release": { "$ref": "#/definitions/release" }, | |
| "revision": { "$ref": "#/definitions/revision" }, | |
| "source": { "$ref": "#/definitions/source" } | |
| } | |
| }, | |
| "paginationRequest": { | |
| "type": "object", | |
| "properties": { | |
| "direction": { "$ref": "#/definitions/direction" }, | |
| "limit": { "$ref": "#/definitions/limit" }, | |
| "page": { "$ref": "#/definitions/page" }, | |
| "sort": { "$ref": "#/definitions/sort" } | |
| } | |
| }, | |
| "paginationResponse": { | |
| "type": "object", | |
| "properties": { | |
| "currentPage": { "$ref": "#/definitions/currentPage" }, | |
| "itemsPerPage": { "$ref": "#/definitions/itemsPerPage" }, | |
| "pageCount": { "$ref": "#/definitions/pageCount" }, | |
| "startIndex": { "$ref": "#/definitions/startIndex" }, | |
| "totalResults": { "$ref": "#/definitions/totalResults" } | |
| } | |
| }, | |
| "recordMeta": { | |
| "type": "object", | |
| "properties": { | |
| "created": { "$ref": "#/definitions/created" }, | |
| "deleted": { "$ref": "#/definitions/deleted" }, | |
| "id": { "$ref": "#/definitions/id" }, | |
| "lastModified": { "$ref": "#/definitions/lastModified" }, | |
| "release": { "$ref": "#/definitions/release" }, | |
| "revision": { "$ref": "#/definitions/revision" }, | |
| "source": { "$ref": "#/definitions/source" } | |
| } | |
| }, | |
| "responseMeta": { | |
| "type": "object", | |
| "properties": { | |
| "objectType": { "$ref": "#/definitions/objectType" }, | |
| "version": { "$ref": "#/definitions/version" } | |
| } | |
| }, | |
| "singular": { | |
| "type": "object", | |
| "properties": { | |
| "address": { "$ref": "#/definitions/address" }, | |
| "citizenship": { "$ref": "#/definitions/citizenship" }, | |
| "citizenship-m": { "$ref": "#/definitions/citizenship-m" }, | |
| "dateOfBirth": { "$ref": "#/definitions/dateOfBirth" }, | |
| "dateOfBirth-m": { "$ref": "#/definitions/dateOfBirth-m" }, | |
| "emailAddress": { "$ref": "#/definitions/emailAddress" }, | |
| "ethnicity": { "$ref": "#/definitions/ethnicity" }, | |
| "ethnicity-m": { "$ref": "#/definitions/ethnicity-m" }, | |
| "gender": { "$ref": "#/definitions/gender" }, | |
| "gender-m": { "$ref": "#/definitions/gender-m" }, | |
| "identifier": { "$ref": "#/definitions/identifier" }, | |
| "identityDocument": { "$ref": "#/definitions/identityDocument" }, | |
| "member": { "$ref": "#/definitions/member" }, | |
| "name": { "$ref": "#/definitions/name" }, | |
| "photo": { "$ref": "#/definitions/photo" }, | |
| "primaryAffiliation": { "$ref": "#/definitions/primaryAffiliation" }, | |
| "primaryAffiliation-m": { "$ref": "#/definitions/primaryAffiliation-m" }, | |
| "primaryCampus": { "$ref": "#/definitions/primaryCampus" }, | |
| "primaryCampus-m": { "$ref": "#/definitions/primaryCampus-m" }, | |
| "pronouns": { "$ref": "#/definitions/pronouns" }, | |
| "pronouns-m": { "$ref": "#/definitions/pronouns-m" }, | |
| "residency": { "$ref": "#/definitions/residency" }, | |
| "residency-m": { "$ref": "#/definitions/residency-m" }, | |
| "role": { "$ref": "#/definitions/role" }, | |
| "status": { "$ref": "#/definitions/status" }, | |
| "status-m": { "$ref": "#/definitions/status-m" }, | |
| "telephoneNumber": { "$ref": "#/definitions/telephoneNumber" }, | |
| "test": { "$ref": "#/definitions/test" }, | |
| "test-m": { "$ref": "#/definitions/test-m" }, | |
| "url": { "$ref": "#/definitions/url" } | |
| } | |
| }, | |
| "plural": { | |
| "type": "object", | |
| "properties": { | |
| "addresses": { "$ref": "#/definitions/addresses" }, | |
| "citizenships": { "$ref": "#/definitions/citizenships" }, | |
| "datesOfBirth": { "$ref": "#/definitions/datesOfBirth" }, | |
| "emailAddresses": { "$ref": "#/definitions/emailAddresses" }, | |
| "ethnicities": { "$ref": "#/definitions/ethnicities" }, | |
| "identifiers": { "$ref": "#/definitions/identifiers" }, | |
| "identityDocuments": { "$ref": "#/definitions/identityDocuments" }, | |
| "members": { "$ref": "#/definitions/members" }, | |
| "names": { "$ref": "#/definitions/names" }, | |
| "photos": { "$ref": "#/definitions/photos" }, | |
| "residencies": { "$ref": "#/definitions/residencies" }, | |
| "roles": { "$ref": "#/definitions/roles" }, | |
| "telephoneNumbers": { "$ref": "#/definitions/telephoneNumbers" }, | |
| "urls": { "$ref": "#/definitions/urls" } | |
| } | |
| }, | |
| "mixed": { | |
| "type": "object", | |
| "properties": { | |
| "address": { "$ref": "#/definitions/address" }, | |
| "addresses": { "$ref": "#/definitions/addresses" }, | |
| "citizenship": { "$ref": "#/definitions/citizenship" }, | |
| "citizenship-m": { "$ref": "#/definitions/citizenship-m" }, | |
| "citizenships": { "$ref": "#/definitions/citizenships" }, | |
| "dateOfBirth": { "$ref": "#/definitions/dateOfBirth" }, | |
| "dateOfBirth-m": { "$ref": "#/definitions/dateOfBirth-m" }, | |
| "datesOfBirth": { "$ref": "#/definitions/datesOfBirth" }, | |
| "emailAddress": { "$ref": "#/definitions/emailAddress" }, | |
| "emailAddresses": { "$ref": "#/definitions/emailAddresses" }, | |
| "ethnicity": { "$ref": "#/definitions/ethnicity" }, | |
| "ethnicity-m": { "$ref": "#/definitions/ethnicity-m" }, | |
| "ethnicities": { "$ref": "#/definitions/ethnicities" }, | |
| "gender": { "$ref": "#/definitions/gender" }, | |
| "gender-m": { "$ref": "#/definitions/gender-m" }, | |
| "identifier": { "$ref": "#/definitions/identifier" }, | |
| "identifiers": { "$ref": "#/definitions/identifiers" }, | |
| "identityDocument": { "$ref": "#/definitions/identityDocument" }, | |
| "identityDocuments": { "$ref": "#/definitions/identityDocuments" }, | |
| "member": { "$ref": "#/definitions/member" }, | |
| "members": { "$ref": "#/definitions/members" }, | |
| "name": { "$ref": "#/definitions/name" }, | |
| "names": { "$ref": "#/definitions/names" }, | |
| "photo": { "$ref": "#/definitions/photo" }, | |
| "photos": { "$ref": "#/definitions/photos" }, | |
| "primaryAffiliation": { "$ref": "#/definitions/primaryAffiliation" }, | |
| "primaryAffiliation-m": { "$ref": "#/definitions/primaryAffiliation-m" }, | |
| "primaryCampus": { "$ref": "#/definitions/primaryCampus" }, | |
| "primaryCampus-m": { "$ref": "#/definitions/primaryCampus-m" }, | |
| "pronouns": { "$ref": "#/definitions/pronouns" }, | |
| "pronouns-m": { "$ref": "#/definitions/pronouns-m" }, | |
| "residency": { "$ref": "#/definitions/residency" }, | |
| "residency-m": { "$ref": "#/definitions/residency-m" }, | |
| "residencies": { "$ref": "#/definitions/residencies" }, | |
| "role": { "$ref": "#/definitions/role" }, | |
| "roles": { "$ref": "#/definitions/roles" }, | |
| "status": { "$ref": "#/definitions/status" }, | |
| "status-m": { "$ref": "#/definitions/status-m" }, | |
| "telephoneNumber": { "$ref": "#/definitions/telephoneNumber" }, | |
| "telephoneNumbers": { "$ref": "#/definitions/telephoneNumbers" }, | |
| "test": { "$ref": "#/definitions/test" }, | |
| "test-m": { "$ref": "#/definitions/test-m" }, | |
| "url": { "$ref": "#/definitions/url" }, | |
| "urls": { "$ref": "#/definitions/urls" } | |
| } | |
| } | |
| } | |
| } |