From 89ddbbedb1dc5228d7e42fa2192ea3560fcf8e38 Mon Sep 17 00:00:00 2001 From: Keith Hazelton Date: Thu, 16 Apr 2020 17:05:55 -0500 Subject: [PATCH] Update bannerSoMjsonSchema.json --- schema/bannerSoMjsonSchema.json | 240 ++++++++++++++++++-------------- 1 file changed, 139 insertions(+), 101 deletions(-) diff --git a/schema/bannerSoMjsonSchema.json b/schema/bannerSoMjsonSchema.json index 52f6719..f115fe7 100644 --- a/schema/bannerSoMjsonSchema.json +++ b/schema/bannerSoMjsonSchema.json @@ -1,9 +1,11 @@ { "$schema": "http://json-schema.org/draft-07/schema", - "$id": "http://id.internet2.edu/bannerSoM.json", + "$id": "http://example.com/example.json", "type": "object", - "title": "Banner Person Schema", - "description": "This provides a JSON Schema 07 version of the implicit Banner Person Schema.", + "title": "The Root Schema", + "description": "The root schema comprises the entire JSON document.", + "default": {}, + "additionalProperties": true, "required": [ "addRequest" ], @@ -17,15 +19,35 @@ "examples": [ { "psoID": { - "psoContainerID": null, "ID": "ALPHA", - "targetID": "x" + "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": { @@ -34,80 +56,55 @@ } }, { - "institutionalrole": null, "context": "INTCOMP", + "institutionalrole": null, "role": "INTACCEPT" } ], "Extension": [ { "Attribute": { - "name": "CWID", - "value": 1075463499.0 - } - }, - { - "Attribute": { - "name": "PIDM", - "value": 44396499.0 + "value": 1075463499.0, + "name": "CWID" } }, { "Attribute": { - "name": "PIDM", - "value": 44396499.0 + "value": 44396499.0, + "name": "PIDM" } }, { "Attribute": { - "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO", - "value": "CC|2015-07-28 14:32:49|202080|UG|1" + "value": "IE|2015-07-28 14:33:39|202080|UG|1", + "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" } }, { "Attribute": { - "name": "GOBTPAC_USER", - "value": "GLEE" + "value": "CC|2015-07-28 14:32:49|202080|UG|1", + "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" } }, { "Attribute": { - "name": "GOBTPAC_USER", - "value": "GLEE" + "value": "GLEE", + "name": "GOBTPAC_USER" } } - ], - "PersonIdentity": { - "Gender": "M", - "PUBLISHER_NAME": "Banner", - "action": "UPDATE", - "PersonName": { - "FormattedName": "given family", - "Affix typeFormOfAddress": "Mr.", - "Affix typeQualification": "Sr.", - "FamilyName": "x", - "GivenName": "x" - }, - "Birthdate": { - "BirthDay": 1.0, - "BirthMonth": 1.0, - "BirthYear": 1997.0 - } - }, - "UDCIdentity": { - "UDCIdentifier": "E286607965E09B09BC1183030991013099" - } + ] }, "targetID": "x", "executionMode": "x", "requestID": "x", "capabilityData": { - "capabilityURI": "x", - "mustUnderstand": "x" + "mustUnderstand": "x", + "capabilityURI": "x" }, "returnData": "x" } ], + "additionalProperties": true, "required": [ "executionMode", "requestID", @@ -172,6 +169,7 @@ "psoContainerID": null } ], + "additionalProperties": true, "required": [ "ID", "targetID", @@ -200,6 +198,7 @@ }, "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, @@ -221,6 +220,7 @@ "targetID": "x" } ], + "additionalProperties": true, "required": [ "ID", "targetID" @@ -264,64 +264,58 @@ } }, { - "institutionalrole": null, "context": "INTCOMP", + "institutionalrole": null, "role": "INTACCEPT" } ], "Extension": [ { "Attribute": { - "name": "CWID", - "value": 1075463499.0 + "value": 1075463499.0, + "name": "CWID" } }, { "Attribute": { - "name": "PIDM", - "value": 44396499.0 + "value": 44396499.0, + "name": "PIDM" } }, { "Attribute": { - "name": "PIDM", - "value": 44396499.0 + "value": "IE|2015-07-28 14:33:39|202080|UG|1", + "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" } }, { "Attribute": { - "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO", - "value": "CC|2015-07-28 14:32:49|202080|UG|1" + "value": "CC|2015-07-28 14:32:49|202080|UG|1", + "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" } }, { "Attribute": { - "name": "GOBTPAC_USER", - "value": "GLEE" - } - }, - { - "Attribute": { - "name": "GOBTPAC_USER", - "value": "GLEE" + "value": "GLEE", + "name": "GOBTPAC_USER" } } ], "PersonIdentity": { "Birthdate": { - "BirthYear": 1997.0, + "BirthMonth": 1.0, "BirthDay": 1.0, - "BirthMonth": 1.0 + "BirthYear": 1997.0 }, "Gender": "M", - "PUBLISHER_NAME": "Banner", "action": "UPDATE", + "PUBLISHER_NAME": "Banner", "PersonName": { - "GivenName": "x", - "FormattedName": "given family", "Affix typeFormOfAddress": "Mr.", + "FormattedName": "given family", "Affix typeQualification": "Sr.", - "FamilyName": "x" + "FamilyName": "x", + "GivenName": "x" } }, "UDCIdentity": { @@ -329,6 +323,7 @@ } } ], + "additionalProperties": true, "required": [ "UDCIdentity", "PersonIdentity", @@ -347,6 +342,7 @@ "UDCIdentifier": "E286607965E09B09BC1183030991013099" } ], + "additionalProperties": true, "required": [ "UDCIdentifier" ], @@ -372,22 +368,23 @@ "examples": [ { "Birthdate": { - "BirthDay": 1.0, + "BirthYear": 1997.0, "BirthMonth": 1.0, - "BirthYear": 1997.0 + "BirthDay": 1.0 }, "Gender": "M", - "PUBLISHER_NAME": "Banner", "action": "UPDATE", + "PUBLISHER_NAME": "Banner", "PersonName": { - "Affix typeQualification": "Sr.", - "FamilyName": "x", "GivenName": "x", + "Affix typeFormOfAddress": "Mr.", "FormattedName": "given family", - "Affix typeFormOfAddress": "Mr." + "Affix typeQualification": "Sr.", + "FamilyName": "x" } } ], + "additionalProperties": true, "required": [ "PUBLISHER_NAME", "action", @@ -424,13 +421,14 @@ "default": {}, "examples": [ { + "FamilyName": "x", "GivenName": "x", - "FormattedName": "given family", "Affix typeFormOfAddress": "Mr.", - "Affix typeQualification": "Sr.", - "FamilyName": "x" + "FormattedName": "given family", + "Affix typeQualification": "Sr." } ], + "additionalProperties": true, "required": [ "FormattedName", "GivenName", @@ -509,11 +507,12 @@ "default": {}, "examples": [ { - "BirthDay": 1.0, "BirthMonth": 1.0, + "BirthDay": 1.0, "BirthYear": 1997.0 } ], + "additionalProperties": true, "required": [ "BirthDay", "BirthMonth", @@ -527,7 +526,7 @@ "description": "An explanation about the purpose of this instance.", "default": 0, "examples": [ - 1 + 1.0 ] }, "BirthMonth": { @@ -537,7 +536,7 @@ "description": "An explanation about the purpose of this instance.", "default": 0, "examples": [ - 1 + 1.0 ] }, "BirthYear": { @@ -547,7 +546,7 @@ "description": "An explanation about the purpose of this instance.", "default": 0, "examples": [ - 1997 + 1997.0 ] } } @@ -560,6 +559,22 @@ "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", @@ -574,11 +589,12 @@ } }, { - "institutionalrole": null, "context": "INTCOMP", + "institutionalrole": null, "role": "INTACCEPT" } ], + "additionalProperties": true, "required": [ "institutionalrole" ], @@ -595,6 +611,7 @@ "role": "UGRAD" } ], + "additionalProperties": true, "required": [ "role", "context" @@ -631,6 +648,29 @@ "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", @@ -640,41 +680,36 @@ "examples": [ { "Attribute": { - "name": "CWID", - "value": 1075463499.0 - } - }, - { - "Attribute": { - "name": "PIDM", - "value": 44396499.0 + "value": 1075463499.0, + "name": "CWID" } }, { "Attribute": { - "name": "PIDM", - "value": 44396499.0 + "value": 44396499.0, + "name": "PIDM" } }, { "Attribute": { - "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO", - "value": "CC|2015-07-28 14:32:49|202080|UG|1" + "value": "IE|2015-07-28 14:33:39|202080|UG|1", + "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" } }, { "Attribute": { - "name": "GOBTPAC_USER", - "value": "GLEE" + "value": "CC|2015-07-28 14:32:49|202080|UG|1", + "name": "APDC_CODE||'|'||APDC_DATE||'|'||TERM_CODE_ENTRY||'|'||LEVL_CODE||'|'||APPL_NO" } }, { "Attribute": { - "name": "GOBTPAC_USER", - "value": "GLEE" + "value": "GLEE", + "name": "GOBTPAC_USER" } } ], + "additionalProperties": true, "required": [ "Attribute" ], @@ -687,10 +722,11 @@ "default": {}, "examples": [ { - "name": "CWID", - "value": 1075463499.0 + "value": 1075463499.0, + "name": "CWID" } ], + "additionalProperties": true, "required": [ "name", "value" @@ -713,7 +749,7 @@ "description": "An explanation about the purpose of this instance.", "default": 0, "examples": [ - 1075463499 + 1075463499.0 ] } } @@ -735,6 +771,7 @@ "capabilityURI": "x" } ], + "additionalProperties": true, "required": [ "capabilityURI", "mustUnderstand" @@ -766,3 +803,4 @@ } } } +