Companion for a collection, containing details, people, folders, reminders, pins, relationships and reading text. Derived and informative; the archive is authoritative. Recognize it by schema == urn:showpapers:companion:2.
Top Level
| Member | Type | Rules |
|---|---|---|
schema required | "urn:showpapers:companion:2" | |
generator required | generator | |
about required | string | min length 1; max length 2000 |
collection required | object | closed |
archive required | object | closed |
pdf required | null or object | |
papers required | array of object | max items 100 |
notes required | array of object | max items 100 |
folders required | array of object | max items 64 |
people required | array of object | max items 64 |
relationships required | array of object | max items 5000 |
notIncluded required | array of string | max items 16; unique |
handBack required | string | min length 1; max length 2000 |
Definitions
id
string · pattern ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
sha256
string · pattern ^[a-f0-9]{64}$
isoDate
string · min length 10; max length 10; pattern ^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])$
generator
The program that wrote this file, not a signature. Apps write {"name":"ShowPapers","platform":"android"|"ios","version":<app version>}.
| Member | Type | Rules |
|---|---|---|
name required | string | min length 1; max length 80; pattern ^(?![ \u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000])(?![\s\S]*[ \u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000]$)[^\u0000-\u001f\u007f-\u009f\ud800-\udfff]+$ |
platform required | string | min length 1; max length 40; pattern ^(?![ \u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000])(?![\s\S]*[ \u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000]$)[^\u0000-\u001f\u007f-\u009f\ud800-\udfff]+$ |
version required | string | min length 1; max length 40; pattern ^(?![ \u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000])(?![\s\S]*[ \u00a0\u1680\u2000-\u200a\u2028\u2029\u202f\u205f\u3000]$)[^\u0000-\u001f\u007f-\u009f\ud800-\udfff]+$ |
fieldKey
one of "program-start-date", "program-end-date", "sevis-id", "admission-date", "admit-until", "class-of-admission", "admission-record-number", "given-name", "family-name", "date-of-birth", "country-of-birth", "country-of-citizenship", "nationality", "document-number", "passport-number", "issuing-country", "issue-date", "expiration-date", "place-of-birth", "sex", "full-name", "receipt-number", "case-type", "notice-type" … (78 values)
valueType
one of "text", "date", "duration-of-status"