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?
person/schema/bannerSoMjsonSchema.json
Go to fileThis commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
805 lines (805 sloc)
42 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": "http://json-schema.org/draft-07/schema", | |
"$id": "http://id.internet2.edu/schema", | |
"type": "object", | |
"title": "Banner Person Schema", | |
"description": "Full representation of the Banner Registry Person from TAP Person Schema with SoM extensions in JSON", | |
"default": {}, | |
"additionalProperties": true, | |
"required": [ | |
"addRequest" | |
], | |
"properties": { | |
"addRequest": { | |
"$id": "#/properties/addRequest", | |
"type": "object", | |
"title": "The Addrequest Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"psoID": { | |
"ID": "ALPHA", | |
"targetID": "x", | |
"psoContainerID": null | |
}, | |
"containerID": { | |
"targetID": "x", | |
"ID": "x" | |
}, | |
"data": { | |
"PersonIdentity": { | |
"Birthdate": { | |
"BirthMonth": 1.0, | |
"BirthDay": 1.0, | |
"BirthYear": 1997.0 | |
}, | |
"Gender": "M", | |
"action": "UPDATE", | |
"PUBLISHER_NAME": "Banner", | |
"PersonName": { | |
"Affix typeFormOfAddress": "Mr.", | |
"FormattedName": "given family", | |
"Affix typeQualification": "Sr.", | |
"FamilyName": "x", | |
"GivenName": "x" | |
} | |
}, | |
"UDCIdentity": { | |
"UDCIdentifier": "E286607965E09B09BC1183030991013099" | |
}, | |
"InstitutionalRoles": [ | |
{ | |
"institutionalrole": { | |
"context": "INTCOMP", | |
"role": "UGRAD" | |
} | |
}, | |
{ | |
"context": "INTCOMP", | |
"institutionalrole": null, | |
"role": "INTACCEPT" | |
} | |
], | |
"Extension": [ | |
{ | |
"Attribute": { | |
"value": 1075463499.0, | |
"name": "CWID" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": 44396499.0, | |
"name": "PIDM" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "IE|2015-07-28 14:33:39|202080|UG|1", | |
"name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "CC|2015-07-28 14:32:49|202080|UG|1", | |
"name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "GLEE", | |
"name": "GOBTPAC_USER" | |
} | |
} | |
] | |
}, | |
"targetID": "x", | |
"executionMode": "x", | |
"requestID": "x", | |
"capabilityData": { | |
"mustUnderstand": "x", | |
"capabilityURI": "x" | |
}, | |
"returnData": "x" | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"executionMode", | |
"requestID", | |
"returnData", | |
"targetID", | |
"psoID", | |
"containerID", | |
"data", | |
"capabilityData" | |
], | |
"properties": { | |
"executionMode": { | |
"$id": "#/properties/addRequest/properties/executionMode", | |
"type": "string", | |
"title": "The Executionmode Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"requestID": { | |
"$id": "#/properties/addRequest/properties/requestID", | |
"type": "string", | |
"title": "The Requestid Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"returnData": { | |
"$id": "#/properties/addRequest/properties/returnData", | |
"type": "string", | |
"title": "The Returndata Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"targetID": { | |
"$id": "#/properties/addRequest/properties/targetID", | |
"type": "string", | |
"title": "The Targetid Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"psoID": { | |
"$id": "#/properties/addRequest/properties/psoID", | |
"type": "object", | |
"title": "The Psoid Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"ID": "ALPHA", | |
"targetID": "x", | |
"psoContainerID": null | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"ID", | |
"targetID", | |
"psoContainerID" | |
], | |
"properties": { | |
"ID": { | |
"$id": "#/properties/addRequest/properties/psoID/properties/ID", | |
"type": "string", | |
"title": "The Id Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"ALPHA" | |
] | |
}, | |
"targetID": { | |
"$id": "#/properties/addRequest/properties/psoID/properties/targetID", | |
"type": "string", | |
"title": "The Targetid Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"psoContainerID": { | |
"$id": "#/properties/addRequest/properties/psoID/properties/psoContainerID", | |
"type": "null", | |
"title": "The Psocontainerid Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": null, | |
"examples": [ | |
null | |
] | |
} | |
} | |
}, | |
"containerID": { | |
"$id": "#/properties/addRequest/properties/containerID", | |
"type": "object", | |
"title": "The Containerid Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"ID": "x", | |
"targetID": "x" | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"ID", | |
"targetID" | |
], | |
"properties": { | |
"ID": { | |
"$id": "#/properties/addRequest/properties/containerID/properties/ID", | |
"type": "string", | |
"title": "The Id Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"targetID": { | |
"$id": "#/properties/addRequest/properties/containerID/properties/targetID", | |
"type": "string", | |
"title": "The Targetid Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
} | |
} | |
}, | |
"data": { | |
"$id": "#/properties/addRequest/properties/data", | |
"type": "object", | |
"title": "The Data Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"InstitutionalRoles": [ | |
{ | |
"institutionalrole": { | |
"context": "INTCOMP", | |
"role": "UGRAD" | |
} | |
}, | |
{ | |
"context": "INTCOMP", | |
"institutionalrole": null, | |
"role": "INTACCEPT" | |
} | |
], | |
"Extension": [ | |
{ | |
"Attribute": { | |
"value": 1075463499.0, | |
"name": "CWID" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": 44396499.0, | |
"name": "PIDM" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "IE|2015-07-28 14:33:39|202080|UG|1", | |
"name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "CC|2015-07-28 14:32:49|202080|UG|1", | |
"name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "GLEE", | |
"name": "GOBTPAC_USER" | |
} | |
} | |
], | |
"PersonIdentity": { | |
"Birthdate": { | |
"BirthMonth": 1.0, | |
"BirthDay": 1.0, | |
"BirthYear": 1997.0 | |
}, | |
"Gender": "M", | |
"action": "UPDATE", | |
"PUBLISHER_NAME": "Banner", | |
"PersonName": { | |
"Affix typeFormOfAddress": "Mr.", | |
"FormattedName": "given family", | |
"Affix typeQualification": "Sr.", | |
"FamilyName": "x", | |
"GivenName": "x" | |
} | |
}, | |
"UDCIdentity": { | |
"UDCIdentifier": "E286607965E09B09BC1183030991013099" | |
} | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"UDCIdentity", | |
"PersonIdentity", | |
"InstitutionalRoles", | |
"Extension" | |
], | |
"properties": { | |
"UDCIdentity": { | |
"$id": "#/properties/addRequest/properties/data/properties/UDCIdentity", | |
"type": "object", | |
"title": "The Udcidentity Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"UDCIdentifier": "E286607965E09B09BC1183030991013099" | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"UDCIdentifier" | |
], | |
"properties": { | |
"UDCIdentifier": { | |
"$id": "#/properties/addRequest/properties/data/properties/UDCIdentity/properties/UDCIdentifier", | |
"type": "string", | |
"title": "The Udcidentifier Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"E286607965E09B09BC1183030991013099" | |
] | |
} | |
} | |
}, | |
"PersonIdentity": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity", | |
"type": "object", | |
"title": "The Personidentity Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"Birthdate": { | |
"BirthYear": 1997.0, | |
"BirthMonth": 1.0, | |
"BirthDay": 1.0 | |
}, | |
"Gender": "M", | |
"action": "UPDATE", | |
"PUBLISHER_NAME": "Banner", | |
"PersonName": { | |
"GivenName": "x", | |
"Affix typeFormOfAddress": "Mr.", | |
"FormattedName": "given family", | |
"Affix typeQualification": "Sr.", | |
"FamilyName": "x" | |
} | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"PUBLISHER_NAME", | |
"action", | |
"PersonName", | |
"Gender", | |
"Birthdate" | |
], | |
"properties": { | |
"PUBLISHER_NAME": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/PUBLISHER_NAME", | |
"type": "string", | |
"title": "The Publisher_name Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"Banner" | |
] | |
}, | |
"action": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/action", | |
"type": "string", | |
"title": "The Action Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"UPDATE" | |
] | |
}, | |
"PersonName": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/PersonName", | |
"type": "object", | |
"title": "The Personname Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"FamilyName": "x", | |
"GivenName": "x", | |
"Affix typeFormOfAddress": "Mr.", | |
"FormattedName": "given family", | |
"Affix typeQualification": "Sr." | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"FormattedName", | |
"GivenName", | |
"FamilyName", | |
"Affix typeFormOfAddress", | |
"Affix typeQualification" | |
], | |
"properties": { | |
"FormattedName": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/PersonName/properties/FormattedName", | |
"type": "string", | |
"title": "The Formattedname Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"given family" | |
] | |
}, | |
"GivenName": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/PersonName/properties/GivenName", | |
"type": "string", | |
"title": "The Givenname Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"FamilyName": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/PersonName/properties/FamilyName", | |
"type": "string", | |
"title": "The Familyname Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"Affix typeFormOfAddress": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/PersonName/properties/Affix typeFormOfAddress", | |
"type": "string", | |
"title": "The Affix typeformofaddress Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"Mr." | |
] | |
}, | |
"Affix typeQualification": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/PersonName/properties/Affix typeQualification", | |
"type": "string", | |
"title": "The Affix typequalification Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"Sr." | |
] | |
} | |
} | |
}, | |
"Gender": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/Gender", | |
"type": "string", | |
"title": "The Gender Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"M" | |
] | |
}, | |
"Birthdate": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/Birthdate", | |
"type": "object", | |
"title": "The Birthdate Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"BirthMonth": 1.0, | |
"BirthDay": 1.0, | |
"BirthYear": 1997.0 | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"BirthDay", | |
"BirthMonth", | |
"BirthYear" | |
], | |
"properties": { | |
"BirthDay": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/Birthdate/properties/BirthDay", | |
"type": "integer", | |
"title": "The Birthday Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": 0, | |
"examples": [ | |
1.0 | |
] | |
}, | |
"BirthMonth": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/Birthdate/properties/BirthMonth", | |
"type": "integer", | |
"title": "The Birthmonth Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": 0, | |
"examples": [ | |
1.0 | |
] | |
}, | |
"BirthYear": { | |
"$id": "#/properties/addRequest/properties/data/properties/PersonIdentity/properties/Birthdate/properties/BirthYear", | |
"type": "integer", | |
"title": "The Birthyear Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": 0, | |
"examples": [ | |
1997.0 | |
] | |
} | |
} | |
} | |
} | |
}, | |
"InstitutionalRoles": { | |
"$id": "#/properties/addRequest/properties/data/properties/InstitutionalRoles", | |
"type": "array", | |
"title": "The Institutionalroles Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": [], | |
"examples": [ | |
[ | |
{ | |
"institutionalrole": { | |
"context": "INTCOMP", | |
"role": "UGRAD" | |
} | |
}, | |
{ | |
"context": "INTCOMP", | |
"institutionalrole": null, | |
"role": "INTACCEPT" | |
} | |
] | |
], | |
"additionalItems": true, | |
"items": { | |
"$id": "#/properties/addRequest/properties/data/properties/InstitutionalRoles/items", | |
"type": "object", | |
"title": "The Items Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"institutionalrole": { | |
"context": "INTCOMP", | |
"role": "UGRAD" | |
} | |
}, | |
{ | |
"context": "INTCOMP", | |
"institutionalrole": null, | |
"role": "INTACCEPT" | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"institutionalrole" | |
], | |
"properties": { | |
"institutionalrole": { | |
"$id": "#/properties/addRequest/properties/data/properties/InstitutionalRoles/items/properties/institutionalrole", | |
"type": "object", | |
"title": "The Institutionalrole Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"context": "INTCOMP", | |
"role": "UGRAD" | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"role", | |
"context" | |
], | |
"properties": { | |
"role": { | |
"$id": "#/properties/addRequest/properties/data/properties/InstitutionalRoles/items/properties/institutionalrole/properties/role", | |
"type": "string", | |
"title": "The Role Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"UGRAD" | |
] | |
}, | |
"context": { | |
"$id": "#/properties/addRequest/properties/data/properties/InstitutionalRoles/items/properties/institutionalrole/properties/context", | |
"type": "string", | |
"title": "The Context Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"INTCOMP" | |
] | |
} | |
} | |
} | |
} | |
} | |
}, | |
"Extension": { | |
"$id": "#/properties/addRequest/properties/data/properties/Extension", | |
"type": "array", | |
"title": "The Extension Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": [], | |
"examples": [ | |
[ | |
{ | |
"Attribute": { | |
"value": 1075463499.0, | |
"name": "CWID" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": 44396499.0, | |
"name": "PIDM" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "IE|2015-07-28 14:33:39|202080|UG|1", | |
"name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" | |
} | |
} | |
] | |
], | |
"additionalItems": true, | |
"items": { | |
"$id": "#/properties/addRequest/properties/data/properties/Extension/items", | |
"type": "object", | |
"title": "The Items Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"Attribute": { | |
"value": 1075463499.0, | |
"name": "CWID" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": 44396499.0, | |
"name": "PIDM" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "IE|2015-07-28 14:33:39|202080|UG|1", | |
"name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "CC|2015-07-28 14:32:49|202080|UG|1", | |
"name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" | |
} | |
}, | |
{ | |
"Attribute": { | |
"value": "GLEE", | |
"name": "GOBTPAC_USER" | |
} | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"Attribute" | |
], | |
"properties": { | |
"Attribute": { | |
"$id": "#/properties/addRequest/properties/data/properties/Extension/items/properties/Attribute", | |
"type": "object", | |
"title": "The Attribute Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"value": 1075463499.0, | |
"name": "CWID" | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"name", | |
"value" | |
], | |
"properties": { | |
"name": { | |
"$id": "#/properties/addRequest/properties/data/properties/Extension/items/properties/Attribute/properties/name", | |
"type": "string", | |
"title": "The Name Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"CWID" | |
] | |
}, | |
"value": { | |
"$id": "#/properties/addRequest/properties/data/properties/Extension/items/properties/Attribute/properties/value", | |
"type": "integer", | |
"title": "The Value Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": 0, | |
"examples": [ | |
1075463499.0 | |
] | |
} | |
} | |
} | |
} | |
} | |
} | |
} | |
}, | |
"capabilityData": { | |
"$id": "#/properties/addRequest/properties/capabilityData", | |
"type": "object", | |
"title": "The Capabilitydata Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": {}, | |
"examples": [ | |
{ | |
"mustUnderstand": "x", | |
"capabilityURI": "x" | |
} | |
], | |
"additionalProperties": true, | |
"required": [ | |
"capabilityURI", | |
"mustUnderstand" | |
], | |
"properties": { | |
"capabilityURI": { | |
"$id": "#/properties/addRequest/properties/capabilityData/properties/capabilityURI", | |
"type": "string", | |
"title": "The Capabilityuri Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
}, | |
"mustUnderstand": { | |
"$id": "#/properties/addRequest/properties/capabilityData/properties/mustUnderstand", | |
"type": "string", | |
"title": "The Mustunderstand Schema", | |
"description": "An explanation about the purpose of this instance.", | |
"default": "", | |
"examples": [ | |
"x" | |
] | |
} | |
} | |
} | |
} | |
} | |
} | |
} |