JSON Schema
This describes the FamilySearch Platform API Json schemas.
Link
A link.
Type: object
| Name | Description | Type |
|---|---|---|
| href | The target URI of the link. | string |
| template | A URI template per RFC 6570, used to link to a range of URIs, such as for the purpose of linking to a query. | string |
| type | Metadata about the available media type(s) of the resource being linked to. The value of the "type" attribute is as defined by the HTTP specification, RFC 2616, Section 3.7. Note that this attribute can be considered an "Update Control (CU)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly. | string |
| accept | Metadata about the available media type(s) of the resource being linked to update (i.e. change the state of) the resource being linked to. The value of the "accept" attribute is as defined by the HTTP specification, RFC 2616, Section 3.7. Note that this attribute can be considered an "Read Control (CR)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly. | string |
| allow | Metadata about the allowable methods that can be used to transition to the resource being linked. The value of the "allow" attribute is as defined by the HTTP specification, RFC 2616, Section 14.7. Note that this attribute can be considered an "Method Control (CM)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly. | string |
| hreflang | The language of the resource being linked to. Note that this attribute can be considered an "Update Control (CU)" per Amundsen, M. (2011). Hypermedia APIs with HTML5 and Node. O'Reilly. | string |
| title | Human-readable information about the link. | string |
| count | The number of elements in the page, if this link refers to a page of resources. Format: int32 | integer |
| offset | The index of the offset of the page, if this link refers to a page of resources. Format: int32 | integer |
| results | The total number of results in the page to which this links, if this link refers to a page of resources. Format: int32 | integer |
MediaType
Type: object
| Name | Description | Type |
|---|---|---|
| type | - | string |
| subtype | - | string |
| parameters | - | object |
| qualityValue | Format: double | number |
| wildcardType | - | boolean |
| wildcardSubtype | - | boolean |
| subtypeSuffix | - | string |
| concrete | - | boolean |
| charset | - | object |
TextValue
An element representing a text value that may be in a specific language.
Type: object
| Name | Description | Type |
|---|---|---|
| lang | The language of the text value. See http://www.w3.org/International/articles/language-tags/ | string |
| value | The text value. | string |
VocabConcept
A vocabulary concept.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| description | The vocabulary concept description. | string |
| note | The vocabulary concept note. | string |
| gedcomxUri | The Gedcomx URI associated with the concept. | string |
| vocabTerms | The terms associated with the concept. | array of VocabTerm |
| attributes | The attributes associated with the concept. | array of VocabConceptAttribute |
| definitions | The definitions associated with the concept. | array of TextValue |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
VocabConceptAttribute
A vocabulary concept attribute.
Type: object
| Name | Description | Type |
|---|---|---|
| id | The vocabulary concept attribute id. | string |
| name | The vocabulary concept attribute name. | string |
| value | The vocabulary concept attribute value. | string |
VocabConcepts
A list of vocabulary concepts.
Type: object
| Name | Description | Type |
|---|---|---|
| vocabConcepts | The list of vocabulary concepts. | array of VocabConcept |
VocabElement
Representation of a vocabulary element
Type: object
| Name | Description | Type |
|---|---|---|
| id | The id of the element. | string |
| uri | The URI of the element. | string |
| subclass | The subclass of the element. | string |
| type | The type of the element. | string |
| labels | The labels of the element. | array of TextValue |
| descriptions | The descriptions of the element. | array of TextValue |
| sublist | The sublist of the element. | string |
| position | Format: int32 | integer |
| sortName | - | string |
VocabElementList
Representation of a list of VocabElement objects
Type: object
| Name | Description | Type |
|---|---|---|
| title | The title of the list of elements. | string |
| description | The description of the list of elements. | string |
| uri | The URI of the list of elements. | string |
| id | The id of the list of elements. | string |
| elements | The list of elements. | array of VocabElement |
VocabTerm
A vocabulary term.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| typeUri | The vocabulary term type. | string |
| sublistUri | The URI of the sublist this vocabulary term is associated with. | string |
| sublistPosition | The position of this vocabulary term within it's associated sublist. Format: int32 | integer |
| values | The values of the vocabulary term. | array of TextValue |
| vocabConcept | - | string |
| vocabConceptUri | - | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
VocabTranslation
A vocabulary translation.
Type: object
| Name | Description | Type |
|---|---|---|
| id | A local, context-specific id for the data. | string |
| text | - | string |
| lang | - | string |
| extensionElement | - | object |
| links | The list of hypermedia links. Links are not specified by GEDCOM X core, but as extension elements by GEDCOM X RS. | array of Link |
composeNameSegments
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing the person with the name to be composed. At least one person is required. | array |
createChildAndParentsNote
Type: object
| Name | Description | Type |
|---|---|---|
| childAndParentsRelationships | Array containing the child-and-parents relationship with notes to be created. See ChildAndParentsRelationship Schema (JSON) | array |
createChildAndParentsRelationshipSourceReference
Type: object
| Name | Description | Type |
|---|---|---|
| childAndParentsRelationships | Array containing the child-and-parents relationship with source references to attach. See ChildAndParentsRelationship Schema (JSON) | array |
createCoupleRelationshipNote
Type: object
| Name | Description | Type |
|---|---|---|
| relationships | Array containing exactly one relationship with notes to add. See Relationship Schema (JSON) | array |
createCoupleRelationshipSourceReference
Type: object
| Name | Description | Type |
|---|---|---|
| relationships | Array containing exactly one relationship with source references to add. See Relationship Schema (JSON) | array |
createDiscussion
Type: object
| Name | Description | Type |
|---|---|---|
| discussions | Array containing exactly one discussion to create. See Discussion Schema (JSON) | array |
createFamilyNameCards
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array of persons with ordinance reservations to include in the family name cards. Maximum of 50 ordinance reservations total. | array |
createGenealogiesPerson
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing exactly one person to be created. See Person Schema (JSON) | array |
createGenealogiesTree
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array containing exactly one source description for the tree to be created. See SourceDescription Schema (JSON) | array |
createGroup
Type: object
| Name | Description | Type |
|---|---|---|
| groups | Array containing the user tree group to create. See Group Schema (JSON) | array |
createMemoryComment
Type: object
| Name | Description | Type |
|---|---|---|
| discussions | Array containing exactly one discussion with comments to create or update | array |
createMemoryPersona
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing one or more personas to create or update. At least one person must be provided. See Person Schema (JSON) | array |
createOrdinanceReservations
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing persons with ordinances to reserve. At least one person is required. See Person Schema (JSON) | array |
createPerson
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing exactly one person to create. See Person Schema (JSON) | array |
createPersonMemory
Type: object
| Name | Description | Type |
|---|---|---|
| artifact | The memory file to upload (photo, document, story, or obituary) Format: binary | string |
createPersonNote
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing the person with notes to add. Exactly one person must be provided. See Person Schema (JSON) | array |
createRelationship
Gedcomx object containing either a couple relationship or a child-and-parents relationship (or both). At least one relationship must be provided.
Type: object
| Name | Description | Type |
|---|---|---|
| relationships | Array of couple relationships to create. Each relationship connects two spouses. See Relationship Schema (JSON) | array |
| childAndParentsRelationships | Array of child-and-parents relationships to create. Each relationship connects a child to up to two parents. See ChildAndParentsRelationship Schema (JSON) | array |
createSourceDescription
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array containing the source description to create. Exactly one source description must be provided. See SourceDescription Schema (JSON) | array |
createSourceDescription-2
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array containing the source description to create. Only one source description may be created per request. See SourceDescription Schema (JSON) | array |
createSourceFolder
Type: object
| Name | Description | Type |
|---|---|---|
| collections | Array containing the source folder to create. Only one source folder may be created per request. | array |
createTree
Type: object
| Name | Description | Type |
|---|---|---|
| trees | Array containing the user tree to create. See Tree Schema (JSON) | array |
getArtifactGroupsPermissions
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array of source descriptions, each with an id set to an artifact group ID. | array |
getArtifactImagesPermissions
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array of source descriptions, each with an id set to an artifact image ID. | array |
getSourceDescriptionChanges
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array containing the source descriptions to check for changes. A maximum of 100 source descriptions is allowed. See SourceDescription Schema (JSON) | array |
mergePerson
Type: object
| Name | Description | Type |
|---|---|---|
| merges | Array containing exactly one merge specification. See Merge Schema (JSON) | array |
readPersonMatchesByExample
Type: object
| Name | Description | Type |
|---|---|---|
| description | Reference to the source description ID (e.g., '#sd1') | string |
| persons | Array of persons to match. Must include at least one primary person with an ID. See Person Schema (JSON) | array |
| relationships | Array of relationships between persons. Persons not specified in a relationship (other than the primary person) will be ignored when matching. See Relationship Schema (JSON) | array |
| sourceDescriptions | Array of source descriptions. Must include a main source description that points to the primary person. See SourceDescription Schema (JSON) | array |
setCoupleRelationshipSpousesOrder
Type: object
| Name | Description | Type |
|---|---|---|
| relationships | Array containing exactly one couple relationship with the desired spouse ordering. See Relationship Schema (JSON) | array |
setCurrentTree
Type: object
| Name | Description | Type |
|---|---|---|
| trees | Array containing the tree ID to set as current. | array |
setParentsOrder
Type: object
| Name | Description | Type |
|---|---|---|
| childAndParentsRelationships | Array containing exactly one child-and-parents relationship with the desired parent ordering. See ChildAndParentsRelationship Schema (JSON) | array |
updateChildAndParentsNote
Type: object
| Name | Description | Type |
|---|---|---|
| childAndParentsRelationships | Array containing the child-and-parents relationship with the note to be updated. See ChildAndParentsRelationship Schema (JSON) | array |
updateChildAndParentsRelationship
Type: object
| Name | Description | Type |
|---|---|---|
| childAndParentsRelationships | Array containing exactly one child-and-parents relationship to update. See ChildAndParentsRelationship Schema (JSON) | array |
updateComments
Type: object
| Name | Description | Type |
|---|---|---|
| discussions | Array containing exactly one discussion with comments to add or update. | array |
updateCoupleRelationship
Type: object
| Name | Description | Type |
|---|---|---|
| relationships | Array containing exactly one relationship to update. See Relationship Schema (JSON) | array |
updateCoupleRelationshipNote
Type: object
| Name | Description | Type |
|---|---|---|
| relationships | Array containing exactly one relationship with the note to update. See Relationship Schema (JSON) | array |
updateDiscussion
Type: object
| Name | Description | Type |
|---|---|---|
| discussions | Array containing exactly one discussion to update. See Discussion Schema (JSON) | array |
updateGroup
Type: object
| Name | Description | Type |
|---|---|---|
| groups | Array containing the user tree group to update. Only one group may be updated at a time. See Group Schema (JSON) | array |
updateMatchResolution
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing exactly one person with the match resolution details. See Person Schema (JSON) | array |
updateMemory
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array containing exactly one artifact description to update. Only one artifact description can be updated at a time. See SourceDescription Schema (JSON) | array |
updateMemoryPersona
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing exactly one persona to update. At least one person must be provided. See Person Schema (JSON) | array |
updatePerson
Gedcomx object containing the person with conclusions to update. Conclusions with an ID are updates; conclusions without an ID are creates.
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing the person to update. See Person Schema (JSON) | array |
updatePersonNotAMatches
Gedcomx object containing person(s) to declare as not a match with the specified person
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array of persons to declare as not a match. Each person represents someone who should NOT be merged with the primary person. | array |
updatePersonNote
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array containing the person with the note to update. Exactly one person must be provided. See Person Schema (JSON) | array |
updatePersonPortraits
Type: object
| Name | Description | Type |
|---|---|---|
| person | The person whose portraits are being updated. See Person Schema (JSON) | object |
updateRelationship
Type: object
| Name | Description | Type |
|---|---|---|
| relationships | Array containing exactly one relationship to update. See Relationship Schema (JSON) | array |
updateSourceDescription
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array containing the source description to update. Exactly one source description must be provided. See SourceDescription Schema (JSON) | array |
updateSourceDescription-2
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array containing the source description to update. Only one source description may be updated per request. See SourceDescription Schema (JSON) | array |
updateSourceDescriptionsToCollection
Type: object
| Name | Description | Type |
|---|---|---|
| sourceDescriptions | Array containing the source descriptions to add or move to the collection. | array |
updateSourceFolder
Type: object
| Name | Description | Type |
|---|---|---|
| collections | Array containing the source folder to update. Only one source folder may be updated per request. See Collection Schema (JSON) | array |
updateTree
Type: object
| Name | Description | Type |
|---|---|---|
| persons | Array of persons to add or update in the tree. See Person Schema (JSON) | array |
| relationships | Array of relationships to create in the tree. Can be ChildAndParentsRelationship or CoupleRelationship. | array |
updateTree-2
Type: object
| Name | Description | Type |
|---|---|---|
| trees | Array containing the user tree to update. See Tree Schema (JSON) | array |
updateUserHistory
Type: object
| Name | Description | Type |
|---|---|---|
| entries | Array containing the person to add to the user's recently viewed history. | array |