Source Description

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.

Data Formats

If you make a GET request, specify the data format using the Accept header.

If you POST something, specify the media type using the Content-Type header.

Parameters

Name Type Description
Authorization header The authorization carrying the OAuth 2.0 access token. See OAuth 2.0 Bearer Tokens.
X-FS-Feature-Tag header The comma-separated list of features to enable for the request. This list is used to enable any specific Pending Modifications. For more information, see the API Evolution Guide
X-Reason header DELETE header giving the reason for deleting a person.
sdid path The id of the source description.
access_token query The id of the OAuth 2 access token used for identification and authorization of the user (and agent) making the request.

Operations

HEAD - Read a source description's header attributes.

Status Codes
200 Upon a successful read.
404 If the requested source description is not found.

GET - Read a source description.

Status Codes
200 Upon a successful read.
404 If the requested source description is not found.
429 If the request was throttled.
Warnings
301 Returned if the system failed to retrieve the Title and Citation.
302 Returned if the system failed to retrieve the Citation. The title is user contributed.

POST - Update a source description.

Status Codes
204 The update was successful.
404 If the requested source description is not found.
429 If the request was throttled.

DELETE - Delete a source description.

Status Codes
204 The delete was successful.
404 If the requested source description is not found.
429 If the request was throttled.

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.
Read Source Description How to read a source description.
Update Source Description How to update a source description.
Delete Source Description How to delete a source description.