diff --git a/tap-core-person-schema-create-json-representation.adoc b/tap-core-person-schema-create-json-representation.adoc index d1b1714..d768b6f 100644 --- a/tap-core-person-schema-create-json-representation.adoc +++ b/tap-core-person-schema-create-json-representation.adoc @@ -1,4 +1,4 @@ -TAP Core Person Schema: How to Create a JSON Representation +TAP Schema: How to Create a JSON Representation =============================== :Date: August 2020 :Revision: v1.0.0 @@ -10,16 +10,16 @@ University Corporation for Advanced Internet Development, Inc. About the JSON Representation ----------------------------- -The Core Schema JSON Representation describes how to represent Core Schema -attributes in JSON. For compactness, this document uses the term "CS-JSON" to -refer to the JSON Representation of the Core Schema. +The TAP Schema JSON Representation describes how to represent TAP +attributes in JSON. For compactness, this document uses the term "TS-JSON" to +refer to the JSON Representation of the TAP Schema. -CS-JSON is represented as a JSON object, that is a pair of curly braces +TS-JSON is represented as a JSON object, that is a pair of curly braces surrounding zero or more JSON members. It is possible for (and perhaps even -expected that) a CS-JSON object to itself be embedded in a broader JSON +expected that) a TS-JSON object to itself be embedded in a broader JSON document, for example for message transport purposes. -.Example CS-JSON Object +.Example TS-JSON Object ---- { "meta": { @@ -33,7 +33,7 @@ document, for example for message transport purposes. Attribute Data Types -------------------- -All Attribute Data Types defined in the Core Schema map to JSON strings, +All Attribute Data Types defined in the TAP Schema map to JSON strings, except as follows: * *boolean*: Maps to JSON `true` or `false` @@ -42,7 +42,7 @@ except as follows: Record Metadata --------------- Metadata attributes that apply to the entire record are defined in a JSON -member of the CS-JSON object, identified by the key `meta`, and consisting of +member of the TS-JSON object, identified by the key `meta`, and consisting of a JSON object whose key/value pairs are any Record Metadata attribute defined in the Core Schema. @@ -61,13 +61,13 @@ in the Core Schema. Attribute Representation ------------------------ -Within the CS-JSON object, each attribute key is the corresponding Core Schema +Within the TS-JSON object, each attribute key is the corresponding Core Schema attribute. The plural name is used when the attribute may have multiple values, regardless of whether or not multiple values are conveyed in any given transaction. In other words, the attribute name _EmailAddresses_ is always used even if only one email address is being sent across the wire. -CS-JSON defines several different representations for attributes. It is up to +TS-JSON defines several different representations for attributes. It is up to each Protocol to determine which formats to use in which context. Simple Attribute