§ 2.1 Common Schema Elements

Many additional schema items are reusable throughout the schema, such as the various address forms found throughout different tables.

§ 2.1.1 PostalAddress

‌The address to which physical mail and packages are delivered.

Property	Expected Type	Description
address1	String	The first part of a postal address such as the building number and street name.
address2	String or Null	The second part of a postal address, usually denoting a suite.
city	String	The city the address is located in.
country	String	The country the address is located in.
country_code	String	This is a geographical code that represents countries.
id	Integer	A unique and persistent identifier for the record.
local_reference_id	String or Null	This optional property is ephemeral and is only displayed in the object return during a POST or a PATCH operation for core objects (primarily those found in an @set array). This value will be returned in the response body for the object instance allowing you to identify the record using your key. A locally-unique, 16-byte string is recommended. The data in this property should be considered transient.
organization_fk	Integer	Organization foreign key.
person_fk	Integer	Person foreign key.
postal_code	String	The postal/zip code for the address.
state_territory_province	String	State, Territory or Province of an address.

‌§ 2.1.2 SocialAddresses

‌The various Internet locations that help disambiguate a person, group, or organization, such as their FaceBook, LinkedIn, YouTube, and Twitter Address. As each of these addresses are in Internet Message format, they must be entered in lowercase following the manual of style set HERE.

Property	Expected Type	Description
​ twitter ​	​ String or Null	The Twitter Handle for the person.
​ facebook ​	​ URL or Null	The Facebook URL for the person.
​ linkedin ​	​ URL or Null	The LinkedIn URL for the person.
​ youtube ​	​ String or Null	The YouTube handle for a person.

§ 2.1.3 PhoneNumbers

A collection of phone numbers. All telephone number fields will follow international ITU-T E.164 international phone number formatting of [+] [country code] [area code] [local phone number]. The styles for phone numbers are found HERE.

Property	Expected Type	Description
id	Integer	A unique and persistent identifier for the record.
local_reference_id	String or Null	This optional property is ephemeral and is only displayed in the object return during a POST or a PATCH operation for core objects (primarily those found in an @set array). This value will be returned in the response body for the object instance allowing you to identify the record using your key. A locally-unique, 16-byte string is recommended. The data in this property should be considered transient.
organization_fk	Integer	Organization foreign key.
person_fk	Integer	Person foreign key.
phone_number	TelephoneNumber	The main phone number registered to an Organization.
primary	Boolean or Null	Denotes whether an object is the primary record or not.

§ 2.1.4 NonStandardNames

Additional legal names used by an item.

Property	Expected Type	Description
name	String	The name of the item.
id	Integer	A unique and persistent identifier for the record.
organization_fk	Integer	Organization foreign key.

§ 2.1.5 HierarchicalMetaData

MetaData about a JSON Type's hierarchical information. If the record is in a non-hierarchical array this will be nulled.

Property	Expected Type	Description
id	Integer	A unique and persistent identifier for the record.
parent_id	Integer	ID of the associated parent for this record.
sort_value	Integer or Null	An integer given to a record relative to its siblings used to sort at each sibling level.
genealogy	String	The Authority Document genealogy.
ChildIDs	Thing	A collection of children identifiers.

§ 2.1.6 local_reference_id

This individual value is found in every record that can be changed. It was created for the sole purpose of contributors being able to track POST calls when creating new records with contents found in subtables within their database that become arrays within the JSON structure.

Property	Expected Type	Description
local_reference_id	String or Null	This optional property is ephemeral and is only displayed in the object return during a POST or a PATCH operation for core objects (primarily those found in an @set array). This value will be returned in the response body for the object instance allowing you to identify the record using your key. A locally-unique, 16-byte string is recommended. The data in this property should be considered transient.

§ 2.1.7 Emails

The only difference between email and Emails is that Emails is a list of email.

Property	Expected Type	Description
email	Email or Null	Electronic Mail address.
id	Integer	A unique and persistent identifier for the record.
local_reference_id	String or Null	This optional property is ephemeral and is only displayed in the object return during a POST or a PATCH operation for core objects (primarily those found in an @set array). This value will be returned in the response body for the object instance allowing you to identify the record using your key. A locally-unique, 16-byte string is recommended. The data in this property should be considered transient.
organization_fk	Integer	Organization foreign key.
person_fk	Integer	Person foreign key.
primary	Boolean or Null	Denotes whether an object is the primary record or not.

§ 2.1.8 AuditData

AuditData is a key element in managing federated information. In short, the two main objects within AuditData are current_object and previous_object which store exactly what they say – a snapshot of the current state of the record and the previous state of the record.

Property	Expected Type	Description
current_object	Object or Null	An object in the schema. Represents a current value in an audit record.
endpoint	String	An API endpoint for grcschema.
id	Integer	A unique and persistent identifier for the record.
object_id	Integer or Null	The id of an object in grcschema.
organization_fk	Integer	Organization foreign key.
person_fk	Integer	Person foreign key.
previous_object	Object or Null	The previous record of any object in the schema.
schema	String	The name of a Thing in grcschema for use in AuditData.
team_fk	Integer	The foreign key of a Team.
time_stamp	Datetime	A datetime in the schema.
type	String	The Authority Document type.