Source Description
Path
/platform/sources/descriptions/{sdid} |
|
| Production: | https://api.familysearch.org/platform/sources/descriptions/{sdid} |
| Beta: | https://apibeta.familysearch.org/platform/sources/descriptions/{sdid} |
| Integration (Integration): | https://api-integ.familysearch.org/platform/sources/descriptions/{sdid} |
Description
The Source Description resource gets/updates/deletes a user's source description.
The FamilySearch implementation of the Source Description resource does not support all properties of a source description as defined by GEDCOM X. Support is limited to the following:
| property | description |
|---|---|
| id | A local identifier for the source description. |
| about | URI to the resource being described, if any. |
| title | Label, title, or other name to display to the user for the source. |
| citation | The citation for the source. FamilySearch only supports the value of the citation and not any template or associated citation fields. |
| notes | Notes about the source provided by a user. |
Operations
|
HEAD - Read the headers for a source description. Produces - Specify a returned data format using the
Accept
header.
Parameters
Status Codes
|
||||||||||
|
GET - Read a source description. Produces - Specify a returned data format using the
Accept
header.
Parameters
Status Codes
Warnings
|
||||||||||
|
POST - Update a source description. Produces - Specify a returned data format using the
Accept
header.
Consumes - Specify the incoming data format using the
Content-Type header.
Parameters
Status Codes
|
||||||||||
|
DELETE - Delete a source description. Produces - Specify a returned data format using the
Accept
header.
Parameters
Status Codes
|
Example Requests
| Create Source Description | How to create a source description. |
| Create User-Uploaded Source | How to create a source for an artifact that a user has uploaded. |
| Delete Source Description | How to delete a source description. |
| Read Source Description | How to read a source description. |
| Update Source Description | How to update a source description. |