Commit fd84ef41 by Robbie Hott

Added more detail to the server API for Constellation objects.

parent d6984341
...@@ -52,8 +52,8 @@ The constellation structure has the following components: ...@@ -52,8 +52,8 @@ The constellation structure has the following components:
* `dataType` : the type of this object. It should always be "Constellation" for constellations. * `dataType` : the type of this object. It should always be "Constellation" for constellations.
* *required for ALL commands* * *required for ALL commands*
* `id` : snac identity number for this constellation * `id` : snac identity number for this constellation. Returned after a successful `insert` command.
* *required for the update command* * *required for the update and edit commands*
* `version` : snac version number for the state of this constellation * `version` : snac version number for the state of this constellation
* *required for the update command* * *required for the update command*
* `ark` : ark identifier for this constellation * `ark` : ark identifier for this constellation
...@@ -74,7 +74,7 @@ The constellation structure has the following components: ...@@ -74,7 +74,7 @@ The constellation structure has the following components:
* *required for the update command* * *required for the update command*
* `biogHists` : *note, should be singular and store only one (nrd)* * `biogHists` : *note, should be singular and store only one (nrd)*
* *required for the update command* * *required for the update command*
* `existDates` : exist dates for this entity * `existDates` : exist dates for this entity. See the SNAC Date Structure section for date format
* *required for the update command* * *required for the update command*
* `generalContext` : xml-formatted text from the general context tags * `generalContext` : xml-formatted text from the general context tags
* *required for the update command* * *required for the update command*
...@@ -87,7 +87,21 @@ The constellation structure has the following components: ...@@ -87,7 +87,21 @@ The constellation structure has the following components:
* `otherRecordIDs` : list of URIs that also describe this identity * `otherRecordIDs` : list of URIs that also describe this identity
* `legalStatuses` : xml-formatted text from the legal status tags * `legalStatuses` : xml-formatted text from the legal status tags
* `sources` : list of sources for this constellation * `sources` : list of sources for this constellation
* Each source must be an array (surrounded by `[]`) and have the following two keys:
* `type` : type of the source
* `href` : URI to the source
* `nameEntries` : list of name entries of this entity * `nameEntries` : list of name entries of this entity
* Each name Entry must be an object (surrounded by `{}`) and have the following keys:
* `dataType` : the type of this object. It should always be "NameEntry" for name entries.
* *required for ALL commands using a name entry*
* `id` : snac identity number for this name entry
* `version` : snac version number for the state of this name entry
* `original` : the original name as it was typed
* `preferenceScore` :
* `contributors` :
* `language` :
* `scriptCode` :
* `useDates` : use dates of this name. See the SNAC Date Structure section for date format
* `occupations` : list of occupations for this entity * `occupations` : list of occupations for this entity
* `functions` : list of functions for this entity * `functions` : list of functions for this entity
* `subjects` : list of subjects for this entity * `subjects` : list of subjects for this entity
...@@ -99,6 +113,10 @@ The constellation structure has the following components: ...@@ -99,6 +113,10 @@ The constellation structure has the following components:
*Notes: do we need language, script, and constellationLanguage/Script(Code)? We can deduce the language and script from the codes (controlled vocab), but do we need to store the language this CPF was written in?* *Notes: do we need language, script, and constellationLanguage/Script(Code)? We can deduce the language and script from the codes (controlled vocab), but do we need to store the language this CPF was written in?*
### SNAC Date Structure
Snac dates
## Server Responses ## Server Responses
The Server response API has the following form: The Server response API has the following form:
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment