Wlliam Gilmore Simms

Application Programming Interface (API)


Supported formats:
json JavaScript Object Notation (JSON)
xml eXtensible Markup Language (XML)
txt PHP's print_r() format
var_export PHP's var_export() format
serialize PHP serialized format
csv Comma-separated values
tab Tab-separated values
html HTML Tables (Default)- Not stable. Use for debugging only

Example:
Supported actions:
version Returns the current api version

Example:
test Returns a test set of data

Example:
list Returns a list of data as specfied by prop
Options:
prop: (Req.)
titles
Options:
type Item type/hierarchy placement (Opt.)
parent Parent id (Opt.)
people
Options:
type Type of person
places
Options:
type Type of place
sources
Options:
type Type of source
digital_collections
periods
add Adds data

update Updates existing entries

records Outputs full records

Response codes:
1 Success
100 Invalid action
101 Invalid property (prop)
102 Invalid type
103 Not authenticated
104 You do not have permission to access this feature
105 Duplicate entry
106 Required data is missing
107 Item not found