Change Log


API Changes

June 30, 2016

  • New Feature Modification Activation Tree Foundation
  • Bug Fix Fix for failure to add "non-event" custom facts in TF.
  • Bug Fix Some 410 ("Gone") responses were being returned as 500 errors.
  • Bug Fix Errors when merging with source references.
  • Bug Fix Unable to read current user history that has some invalid ids.
  • Bug Fix Confidence levels in possible duplicates API weren't being honored correctly.
  • Bug Fix Incorrect link to "agent" of a change history entry.
  • Bug Fix Ugly XML namespace prefixes.
  • Bug Fix Incorrect german translation for display gender.
  • Bug Fix Throttled endpoint should be returning throttling headers.
  • Various documentation fixes, system stability enhancements, and performance improvements.

June 14, 2016

  • New Feature Prototype support for the Genealogies API, providing access to storage for non-collaborative, user-submitted genealogies.
  • New Feature Prototype support for the Places Feedback API, providing a way to submit feedback about the FamilySearch Place authority.
  • Various documentation fixes, system stability enhancements, and performance improvements.

April 5, 2016

  • New Pending Modification The include-non-subject-persons-and-relationships modification has been introduced. When reading a person and/or relationship(s), additional persons and relationships are available to be included at minimal cost, but will be dropped to preserve compatibility. This pending modification will include the extra "non-subject" persons and relationships. It is only effective when the new-backend-implementation pending modification is active.
  • Bug Fix Missing resourceId on merge analysis when new-backend-implementation pending modification is active.
  • Bug Fix descendancyNumber missing on ancestry call when new-backend-implementation pending modification is active.
  • Bug Fix "Non-subject" couple relationships in person-with-relationships don't have ids when new-backend-implementation pending modification is active.
  • Various documentation fixes, system stability enhancements, and performance improvements.

March 8, 2016

  • When the Redirect resource is used for a reference to a memory, the user will be redirected to the correct web page for the memory.
  • Metadata resource (OEmbed) now supports collection URI, title if available.
  • Various documentation fixes, system stability enhancements, and performance improvements.

February 23, 2016

  • Permanently enable '201-on-single-conclusion-create' pending modification. This modification changes the return code on a person/relationship update when there is only one new conclusion added. Under such conditions, a 201 will be returned with the id of the conclusion provided in the 'Location' header. If multiple conclusions created, the return code will be a 204.
  • Permanently enable 'local-source-description-references' pending modification. When source references are returned along with the source descriptions they refer to, there are some cases where the references are not local anchors (e.g. "#12345"). This pending modification fixes that oversight.
  • Performance enhancements to person portrait reads.
  • Bug Fix Occasional 500 errors when reading change history with invalid session.
  • Bug Fix Custom "non-event" facts weren't being represented as such.
  • Bug Fix Some text characters were causing 500 errors deleting persons and relationships.
  • Various documentation fixes, system stability enhancements, and performance improvements.

January 26, 2016

  • New Pending Modification The new-backend-implementation modification has been introduced to allow clients to try out the new database and back-end implementation of the Family Tree. Partners are encouraged to report any bugs or issues with the new backend implementation, noting that the data may be different than what is in the live database and that any edits or updates will not be reflected in the live database. This pending modification is currently not available in the production environment.
  • Bug Fix Incorrect report of 401 as a 500 on change history endpoint.
  • Bug Fix Memory id should be returned when uploading memories to the Person Memories resource. The id is returned in a Link header.
  • Various documentation fixes, system stability enhancements, and performance improvements.

January 12, 2016

  • New Feature Support for Place Attributes resource.
  • Bug Fix Metadata resource support for PALs.
  • Various documentation fixes, system stability enhancements, and performance improvements.

December 22, 2015

  • New Feature Significant performance improvement in the user history list resource.
  • New Pending Modification The user-history-requires-user-id modification has been introduced to apply an effort to speed up the user history list by requiring the user id to be provided in the URI when requesting the user history list. If this modification is active, requests for the user history list with the id "current" will redirect to the history list with the correct user id.
  • New Pending Modification The current-user-history-update-with-details modification has been introduced to allow the entry details to be returned when updating the user history list. In order to return the details, the successful return code had to change from 204 to 201.
  • New Pending Modification The current-user-history-without-current-user-or-starting-person modification has been introduced to apply an effort to speed up the user history list by not returning the current user and/or starting person in the history list.
  • New Feature Support for UUID on places, including parent jurisdictions.
  • Bug Fix Setting the preferred spouse using a child-and-parents relationship no longer returns a 404.
  • Bug Fix Issues with sources paging mechanism.
  • Various documentation fixes, system stability enhancements, and performance improvements.

December 8, 2015

  • Various documentation fixes, system stability enhancements, and performance improvements.

November 10, 2015

  • Modification Activation The person-delete-single-contributor-constraint modification has been permanently enabled. This applies a constraint that persons can only be deleted by their contributor if that contributor is the only contributor to that person.
  • New Feature The Current User History resource was made available as an Atom feed, and each entry in the feed also includes the display properties of the person that was added to the history list. The GEDCOM-X-based representations have been deprecated using a new pending modification named enhanced-user-history.
  • New Feature The Memory Artifact resource has been provided to support editing the text of a story that was uploaded as a memory.
  • New Feature Support for the "duplicates" value for the context parameter of a persistent identifier to redirect the user to the possible duplicates page. See Persistent Identifiers for more information.
  • New Pending Modification The local-source-description-references modification has been introduced to make sure that source references use local references when their source descriptions are included in the same document.
  • Removed the broken Person Change Summary resource.
  • Added a link from the ordinances collection resource to the ordinance policy resource.
  • Various documentation fixes, system stability enhancements, and performance improvements.

October 20, 2015

  • New Pending Modification The person-delete-single-contributor-constraint modification has been introduced to disallow any deletes of a person that has multiple contributions from different users. This change is not considered a breaking change and will therefore be permanently activated in a few short weeks. This pending modification was provided as a courtesy for developers to determine the effects on their clients before it goes active.
  • Modification Activation The 301-on-updates-to-merged-entities modification has been permanently enabled. This changes the error when updating a merged person or relationship. The error code is currently 410 (Gone), but it will change to be 301 (Moved Permanently).
  • Modification Activation The source-ref-query-param-change modification has been permanently enabled. The name of the parameter for the source description id in the source references query was changed from source to description.
  • Redirect resource no longers sets any cookies; the user will be prompted to log in if an active cookie is not already set.
  • Various documentation fixes, system stability enhancements, and performance improvements.

September 22, 2015

  • New Feature When a fact is created or updated without a normalized date, an attempt will be made to provide a normalized value for the date. This work can be disabled using the skipNormalization query parameter.
  • New Feature Places search results now include place jurisdictions.
  • New Feature If an invalid access token is provided to the collections resources, the response will be 401. This allows a quicker access token validity check.
  • Bug Fix Person sources resource no longer returns 404 upon void source references.
  • Bug Fix Broken hypermedia link person on the person matches resource.
  • Various documentation fixes, system stability enhancements, and performance improvements.

September 8, 2015

June 9, 2015

  • Performance optimizations for search/match and person sources.
  • Various documentation fixes, system stability enhancements, and performance improvements.

June 2, 2015

  • Various documentation fixes, system stability enhancements, and performance improvements.

May 19, 2015

  • New Feature Support for ARK on person search/match results.
  • New Feature Support for christening, burial, birth-like, and death-like events on a person search.
  • Various documentation fixes, system stability enhancements, and performance improvements.

May 5, 2015

  • Bug Fix Place Children endpoint wasn't returning property results.
  • Bug Fix Support for the "-" character on a date range on a Places search query.
  • Various documentation fixes, system stability enhancements, and performance improvements.

April 21, 2015

  • Bug Fix Invalid URL to the record hints page was being provided with the person match results.
  • Various documentation fixes, system stability enhancements, and performance improvements.

March 10, 2015

  • Various documentation fixes, system stability enhancements, and performance improvements.

February 28, 2015

January 27, 2015

  • New Pending Modification The 301-on-updates-to-merged-entities modification has been introduced to change the error when updating a merged person or relationship. The error code is currently 410 (Gone), but it will change to be 301 (Moved Permanently).
  • New Feature Added support for am identifier of type http://familysearch.org/v1/MemoryPerson on the Memories persona. This identifier can be used to associate memories personas who identify the same person, but have not been attached to the tree.
  • New Feature Added support for am identifier of type http://familysearch.org/v1/FamilyTreePerson on the Memories persona. This identifier is used to identify the Family Tree person.
  • New Feature Added a personName query parameter to the Person Memories Resource so the name of the person can be provided for the tag instead of just the id of the person.
  • New Feature Memories, Memory Personas, and Memory References will now start providing attribution, identifying the contributor. The contributor will not be immediately available on all resources until a pending data fix-up is performed, but new resources should have the contributor.
  • The set of ArtifactTypes has been adjusted to include just Photo, Story, Document, and Obituary. The other artifact types (Audio, Portrait, Video) were never supported and have been removed from the documentation.
  • Search results now contain an element called searchInfo that provides properties for totalHits and closeHits as a convenience. This is useful in case the number of close hits spans more than one page.
  • Bug Fix Last-Modified timestamps were being returned in CEST timezone when they should always be returned in GMT timezone.
  • Bug Fix sortKey on couple relationships was occasionally misaligned with the way the Family Tree sorts relationships.
  • Bug Fix Sometimes the normalized values for dates and places included a value with lang="*".
  • Various documentation fixes, system stability enhancements, and performance improvements.

January 15, 2015

  • Modification Activation The living-declaration-required modification has been permanently activated. When a person is created, the living property must be provided.
  • New Feature Person Search resource and Person Matches Query resource now support date ranges by placing a dash ("-") between the dates. For example, to search for a birth date between 1900 and 1910: birthDate:1900-1910.
  • Bug Fix Fix for errors about "ArtifactType.OTHER".
  • Bug Fix On an ancestry query for a female person, the spouse wasn't getting included.
  • Bug Fix Current User History resource was always empty.
  • Bug Fix Custom marriage facts weren't being returned correctly.
  • Various documentation fixes, system stability enhancements, and performance improvements.

December 9, 2014

  • Bug Fix Invalid ancestral number when same person was in the pedigree twice.
  • Bug Fix Unable to add a custom marriage fact.
  • Bug Fix Sort keys were missing on couple relationships.
  • Bug Fix Unable to set not-a-match declarations.
  • Bug Fix Relationship order should be deliberate on person-with-relationships resource.
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

December 2, 2014

  • Bug Fix JSON serialization errors when requesting person details on a looping pedgiree.
  • Bug Fix Relationship order should be preserved when applicable and available.
  • Bug Fix Current user resource should return 401 instead of 400 when access token is missing or invalid.
  • Beta Change Memories artifact type was renamed from http://familysearch.org/v1/Image to http://familysearch.org/v1/Photo to better align with the Memories system vocabulary.
  • Beta Change Memories artifact description metadata now use qualifiers instead of type to specify artifact type(s). (Artifacts might have multiple types in the future.)
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

November 18, 2014

  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

November 11, 2014

  • New Feature Templated link from the FamilySearch Family Tree resource to the Person Matches resource.
  • New Feature Link from the Person resource to the Person Sources Query.
  • Bug Fix 500 errors in change history resource.
  • Bug Fix Person display properties name not honoring the locale of the request.
  • Bug Fix The reason wasn't being persisted when deleting a conclusion.
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

October 28, 2014

  • Bug Fix Dates without months or days were being rejected on create or update.
  • Bug Fix Cleaned up some unintelligible ordinance warnings on some change history requests.
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

October 14, 2014

  • New Pending Modification The living-declaration-required modification has been introduced. When a new person is created with this modification active, a living declaration is required or the operation will fail. A living declaration can be either explicit by using the "living" property of the person, or it can be implicit by including a death-like event. The modification will be permanently activated on January 14, 2015.
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

September 30, 2014

  • Bug Fix Contributor names were missing from the change history. For more information, see the specific FSDN thread.
  • Bug Fix Merge OPTIONS were not providing a correct Allow header. For more information, see the specific FSDN thread.
  • Bug Fix Conditional POST was failing even when a valid ETag was provided.
  • Bug Fix Order of name parts was incorrect for non-western names.
  • Bug Fix Incorrect 404 error code when updating an invalid reference of the source references of a person or relationship. Fixed to be 400.
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

September 16, 2014

  • New Feature The Current User History resource maintains a history of resources visited by a user.
  • Bug Fix Throttling is now correctly applying the throttling policies.
  • Bug Fix Content-Type headers are now being ignored on read requests (GET, HEAD, OPTIONS).
  • Bug Fix Some source citations weren't getting provided.
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

September 9, 2014

  • New Pending Modification The birth-date-not-considered-death-declaration modification has been introduced. When a new person is created with this modification active, a birth or christening date over 110 years will no longer considered as an implicit death declaration. The modification will be permanently activated on December 31, 2014.
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

September 2, 2014

  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

August 26, 2014

  • Bug Fix Newly-created living persons were being marked as dead.
  • Modification In conformance to "private spaces," the living status of a person is no longer calculated; it is set when the person is created. If the living property is explicitly provided when the person is created, it will be used to determine the living status of the person. If the living property is not provided, the person will be considered dead only if there is a death-like event. Otherwise, the person will be considered living.
  • The "Current User Person" resource was renamed to "Current Tree Person".
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

August 19, 2014

  • New Feature Support for a conditional update (POST, DELETE) for a person, couple relationship, and child-and-parents relationship. For more information, see the example request.
  • New Feature Support for recordhints and sourcelinker as context parameters to the ARK. For more information, see the Persistent Identifiers guide.
  • New Feature The Person With Relationships resource now provides an Allow header. If the POST or DELETE methods are not included in the value of the Allow header, the person is in a read-only state.
  • Various documentation fixes, hypermedia link improvements, system stability enhancements, and performance improvements.

August 5, 2014

  • Modification Activation The current-user-person-401 modification has been permanently activated. The Current User Person resource used to return 404 when the access token is missing, invalid, or expired. This modification changes that return code to a more intuitive and consistent 401.
  • Modification Activation The root-xml-element-without-xmlns-prefix modification has been permanently activated. When resources are represented in XML, the root XML element had a noisy XML namespace prefix. This modification dropped that xmlns prefix. Note that this feature has no effect on JSON.
  • New Feature Place Type resource can be used to read a specific place group.
  • New Feature Place Types resource can be used to get a list of all place types.
  • New Feature Place Type resource can be used to read a specific place type.
  • New Feature Places Search resource now supports a partialName parameter for the purposes of supporting type-ahead place searches.
  • Searches for resources using an insufficient query now return 204 instead of 400. The Warning header is still provided, detailing why the results were empty.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.

July 25, 2014

  • New Feature Person Matches resource can now be accessed with an unauthenticated access token.
  • New Feature The X-Expect-Override header can now be used instead of the Expect header for clients that aren't allowed to use the Expect header.
  • Bug Fix The Places Search now correctly interprets the parentId correctly.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.

July 9, 2014

  • New Feature The new Dates resource is now available. The Dates resource is used to interpret text that a user has supplied for a date, providing a normalized view of the date as well as a standardization in the form of the GEDCOM X Date Format. The new resource is expected to take the place of the old dates authority API.
  • New Feature An Ancestry Query now supports a descendants parameter that enables clients to request the first generation of descendants to be included in the response. For more information, see the Ancestry Query.
  • New Pending Modification The "Identity V2" authentication mechanism will be removed in January of 2015. All clients must move to the new OAuth2 authentication mechanisms.
  • New Feature The results of person matches (i.e. "possible duplicates") will now no longer include persons that have been declared "not a match". A new parameter includeNotAMatchDeclarations is now supported by the Person Matches resource that can be used to configure whether "not a match" declarations are returned. For more information, see the Person Matches resource and the Person Not A Match List.
  • New Feature The Relationships resource now supports the ability to update relationships in addition to the ability to create relationships. An update request is determined by the presence of an id on the relationship.
  • New Feature The Person resource now provides an Allow header. If the POST or DELETE methods are not included in the value of the Allow header, the person is in a read-only state.
  • Bug Fix The Descendancy Query now correctly interprets an empty value of the spouse parameter to be the "unknown" spouse.
  • Bug Fix Adjustments to align the match results with the results that users get when using the Family Tree web UI.
  • Bug Fix Fix for some unexpected behavior in the change history for couple facts.
  • Bug Fix Documents uploaded to memories as images did not display correctly.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.

June 19, 2014

  • Modification Activation The discussion-reference-json-fix modification has been permanently activated.
  • Modification Activation The parent-child-relationship-resources-consolidation modification has been permanently activated.
  • Bug Fix PDF memories being uploaded weren't showing up on the site.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.

May 29, 2014

  • Bug Fix Error code 417 was being returned when clients used the Expect: 100-continue procedure before doing a POST.
  • New Feature Ordinances resource now returns a 401 instead of a 403 when an access token was invalid or expired.
  • New Feature Ordinances resource now returns a 200 instead of a 204 and provides a description of the collection of all LDS ordinances.
  • New Feature User-Defined Collections resource now supports a GET that will redirect to the collections for the current user.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.

May 22, 2014

  • New Feature The Notes Resources of person, couple relationship, and child-and-parents relationships now returns the full note instead of just a summary.
  • New Feature Updates now accept relative URIs and fragment URIs as valid references, resolved on a per-context basis. For example, when creating or updating a relationship, persons can be referred to as "MMMM-MMM" and "#MMMM-MMM" in addition to the regular "https://familysearch.org/platform/tree/persons/MMMM-MMM".
  • New Feature Adding the Vary HTTP header to better support caching.
  • New Feature Any resource that results in a redirect can now be coerced into returning a 200-level status code instead of a 300-level status code by using the Expect header with value "200-ok". This is to accommodate a bug in Chrome on redirect. An example request to illustrate this is provided with the Current User resource.
  • New Feature Support for designating a custom fact as "not a Family Tree event" by using a fact qualifier. An example request to illustrate this is provided with the Person resource.
  • Bug Fix Change message wasn't cascading when updating a child-and-parents relationship.
  • Bug Fix 500 error when reading a child-and-parents relationship specifically when the persons parameter is included with the call.
  • Bug Fix NullPointerException fixed when reading a preferred spouse relationship that is actually a child-and-parents relationship.
  • Bug Fix Cyrillic-template names weren't providing the lang attribute on the name.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.

May 1, 2014

  • New Feature The Person Resource now provides links to the persons spouses, children, and parents.
  • Bug Fix Some invalid ids were returning valid persons.

April 24, 2014

  • Modification Activation The remove-conclusion-confidence-level modification has been permanently activated.
  • Modification Activation The throttled-response-429-replaces-503 modification has been permanently activated.
  • Modification Activation The relationship-persons-local-hrefs modification has been permanently activated.
  • Modification Activation The child-and-parents-relationship-change-object-rename modification has been permanently activated.
  • New Feature A new pending modification is initialized: the current-user-person-401 modification has been introduced. When active, the Current User Person resource returns 401 instead of 404 when an access token is invalid, expired, or missing. The modification is scheduled to be permanently activated on July 17, 2014.
  • New Feature Person portrait now returns a smaller thumbnail instead of the full portrait.
  • Bug Fix "restore" link was missing on a deleted person or relationship.
  • Bug Fix person sources query was failing because of a duplicate link.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.

April 15, 2014

  • New Feature Support for obtaining an "unauthenticated" access token. An unauthenticated access token is an access token that is not associated with the credentials (username/password) of a user. Only a limited number of resources support the use of an unauthenticated access token. For more information, see the Access Token resource, the OAuth2 Guide, and the example request.
  • New Feature Places API now supports access via unauthenticated access token.
  • Some pending modifications were delayed to June 5, 2014. For more information, see the post on FSDN.
  • New Feature Support for attribution on discussion references.
  • Person Portrait Resource now provides smaller "thumbnail" versions of the image instead of the "full" portrait.
  • Bug Fix You can now create and update discussion references in the new format specified by the discussion-reference-json-fix pending modification.
  • Bug Fix Links in the discussion reference are not associative arrays instead of just a plain array of links, in conformance to links on the other objects.
  • Bug Fix X-Entity-ID is now provided on a comment create.
  • Bug Fix Added missing links in the source box API for description and source-references-query on source descriptions, and collection on user-defined collections.
  • Bug Fix Redirect resource is now included in the discovery resource.
  • Bug Fix memory link on the Person Memory References now correctly resolves to the memory.
  • Bug Fix Support for updating the artifact type of a memory.
  • Bug Fix image link on a Story memory now resolves to the full image, and not the story text.
  • Bug Fix Person Memory References doesn't return invalid references to other personas on the same memory.
  • Bug Fix Memory Comments now support a "created" timestamp.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.

March 27, 2014

  • New Feature `POST` is now supported on the Person Sources Query as a convenience to upload and attach a memory directly to a person without worrying about memory references or personas. See the Upload Photo for Person Example Request.
  • New Feature GZIP encoding is now supported for API resources, reducing the size of the payload for clients that support it (such as the browser).
  • New Feature Support for the `partial` parameter on a place search.
  • New Feature Discussion references now have their own id, distinct from the discussion id. Discussion references now store the change message and contributor. Note: to leverage this functionality in JSON, the `discussion-reference-json-fix` must be enabled.
  • New Feature Persons now include a citation in their source description.
  • Various documentation fixes, hypermedia link improvements, and system stability enhancements.
  • Update to the latest version of the gedcomx-java libraries.

March 17, 2014

  • New Feature Places API. See the Places Guide for more information.
  • New Feature Support for user-uploaded sources. The API can now be used to upload and attach a birth certificate to a person by creating a memory and then creating a source description for the memory. See the Source Descriptions resource and associated example request for more information.
  • New Feature Person Matches Query now supports fatherId, motherId, and spouseId to assist in finding matches for persons that have parents or spouses that are already matched.
  • New Feature Person Source Query, Couple Relationship Sources Query, and Child-and-Parents Source Query to support reading all sources attached to a person or relationship in one request.
  • New Feature Person resources and collection resources now include a source description to aid in citing, referencing and other metadata usages.
  • New Feature Relationship create/update now supports the Persistent Identifier (ARK).
  • Bug Fix Portraits weren't being provided on some persons.
  • Bug Fix Filling in some hypermedia holes.
  • Bug Fix Lineage dates weren't getting saved on some creates.
  • Bug Fix Change message wasn't getting inherited from "parent" elements.
  • Bug Fix Search/match results sometimes returned duplicate persons and relationships.
  • Bug Fix Using the ARK in a browser with an invalid session wasn't directing to the login page.
  • Update to the latest version of the gedcomx-java libraries.

March 3, 2014

  • New Feature Persistent Identifier Enhancements, including support for using the ARK in the Web browser and support for ARK decorations. See the persistent identifiers guide for more information.
  • New Feature Added some example requests for Pending Modifications.
  • New Feature Memory artifact descriptions now directly describe the artifact instead of resolving a Memory Artifact redirect resource.
  • New Feature Memory Comments, Memory Personas, and Memory Persona now include a "skeleton" description that includes the memory id and a link to the memory.
  • New Feature Memory personas can now be read and updated via the Memory Persona resource.
  • New Feature Memory personas now include a link to their Memory Persona resource.
  • New Feature Hypermedia links now include the ".xml" and ".json" suffix that is used for shorthand content negotiation.
  • New Feature Discussion references now include a resourceId attribute.
  • New Feature Change history now includes valid entries for add/update/delete discussion references.
  • New Feature Various documentation updates.
  • New Feature Image width and height are now included in the memory artifact description.
  • Bug Fix Filling in some hypermedia holes in the discovery resource.
  • Bug Fix Filling in some hypermedia holes in the memories API.
  • Bug Fix Filling in some hypermedia holes in the user-defined sources API.
  • Bug Fix Person With Relationships resource now returns a 410 if the person is deleted.
  • Bug Fix Relationship lists sometimes included null items.
  • Update to the latest version of the gedcomx-java libraries.

January 17, 2014

  • Significant Change Reboot of the "Experimental Features".
    • "Experimental Features" are now called "Pending Modifications"
    • The activation date for all existing pending modifications has been reset to three months from now: April 17, 2014.
  • New Resource Redirect resource allows client developers to drop a user on a page using the already-obtained access token, without having to make the user go through the login screen again. It also supports a "person" parameter that can be used to drop the user on the UI page for a given person using the already-obtained access token.
  • New Resource Person Portraits resource provides a list of descriptions of the portraits on a person. Each description of a portrait contains the metadata as well as the links to the icon, thumbnail, and full image.
  • New Feature When facts (such as a birth or a death) have a place, the place will now support an extension property called "normalized" which will contain the normalized value of the place as a convenience so that client code doesn't have to resolve the reference to the place description. The "normalized" extension property can also be used to update the normalized text of a place on a fact.
  • New Feature Support for a "multipart/form-data" upload of a (single) memory. This is primarily to accommodate browser-based clients for uploading photos, stories, and documents.
  • New Feature Support for the "personDetails" and "marriageDetails" parameters on the Descendancy resource.
  • New Feature The Person Memories Query now includes the Personas that are used to associate the Person to the Memory. Each Persona has a link to the evidence reference on the Person that can be deleted in order to "detach" the memory from the person.
  • New Feature When a ".json" or a ".xml" suffix is supplied to override the Accept header, the returned hypermedia controls now include the suffix, instead of stripping it.
  • Bug Fix Uploading stories was failing when some parameters were not present.
  • Bug Fix If a request to create memory personas ends up being a no-op, a Location header was incorrectly being supplied.
  • Bug Fix Some JSON example requests weren't getting included in the documentation.
  • Bug Fix Incorrect warnings about undefined experimental features have been removed.
  • Update to the latest version of the gedcomx-java libraries.

January 6, 2014

  • New Resource: Person Spouses: read the list of spouses of a person, including the couple relationships and/or child-and-parents relationships.
  • Memories: Memories resource now includes support to upload a _single_ image, story, document, etc. by POSTing the raw bytes of the image, story, document, etc. and specifying title, description, and other metadata with query parameters. (See the example requests for more information.)
  • Bug fix: expose resources to describe the collection hierarchy of the FamilySearch API. Root Collection, Root Collections, Discussions Collection, Family Tree Collection, User-Defined Sources Collection, Records Collection, Memories Collection.
  • Verified that throttling is working on sandbox.
  • Fixed sample app authentication.
  • Fixed web UI issues on sandbox.
  • Bug fix: reading a user's list memories was returning an invalid id.
  • Cleaning up some other miscellaneous error handling, messages, and UI issues.

December 19, 2013

  • Ancestry Query support for the marriageDetails query parameter to include marriage date, marriage place in the display properties for a person.
  • Person Portrait Resource now returns 204 instead of 404 if a portrait is not provided for a person.
  • New resource: Person Parents: read the list of parents of a person, including the parent-child relationships, child-and-parents relationships, and couple relationships (if applicable) between the pairs of parents.
  • New resource: Person Children: read the list of children of a person, including the parent-child relationships and child-and-parents relationships.
  • New experimental feature: remove-conclusion-confidence-level to remove support for confidence on conclusions in the FamilySearch Family Tree. Developers are expected to evaluate their use of the confidence of a conclusion and account for the pending removal of support for the feature.
  • Some dates are now localized in the display properties of a person.
  • New resources to describe the collection hierarchy of the FamilySearch API. Root Collection, Root Collections, Discussions Collection, Family Tree Collection, User-Defined Sources Collection, Records Collection, and Memories Collection. These collection resources are provided to accommodate APIs for anticipated future resources.
  • Minor feature to add links to the OAuth2 endpoints when an unauthorized request is made.
  • Update to the latest GEDCOM X Java version.

December 5, 2013

  • Support for http://familysearch.org/v1/LifeSketch fact type.
  • New Relationships resource is provided as a convenience for creating relationships. Both couple relationships and child-and-parents relationships can now be created at the same resource, rather than having to go to separate resources for each one. Also, multiple relationships can now be created at the same time instead of requiring one at a time.
  • Support for a new search parameter, name, defined as the full name of the person so you don't have to classify the name parts as given or surname.
  • Support for a new query parameter on the Person Portrait resource called default which can be used to supply a default image if no portrait is available.
  • Various documentation enhancements and minor bug fixes.

November 20, 2013

  • Bug fix: NullPointerException on ancestry reads with person details.
  • Bug fix: invalid error on unauthenticated portrait read.
  • Bug fix: artifact ids from memories artifacts occasionally showed up as "0".
  • Bug fix: when listing parent-child relationships, an invalid parent showed up in the list.
  • Documentation and example request updates.

November 7, 2013

  • The Ancestry Query now supports an additional query parameter personDetails which allows clients to request the full person details from the server at the expense of making that request even slower than it is.
  • The Memories API has been refactored to support the notion of a Memory as a container of multiple artifacts.
  • Support for the Person Memories Query to return the list of memories attached to a tree person.
  • Support for the User Memories Query to return the list of memories supplied by a specific user.
  • Support for the Person Memory References to create, read, update, delete references from the tree person to a memories persona.
  • Bug fix: http://familysearch.org/v1/CoupleChildRelationship was renamed to http://familysearch.org/v1/ChildAndParentsRelationship. This fix has been wrapped behind the child-and-parents-relationship-change-object-rename experimental feature and will be permanently activated in February 2014.
  • Bug fix: change entries should refer to their "parent" entries by full URI if the parent entry is not included in the same page.
  • Bug fix: binary parent-child relationships are returned in the Person With Relationships Query in addition to the child-and-parent relationships.
  • Bug fix: Person With Relationships Query now supports the GEDCOM X data format.
  • Bug fix: change history was not correctly providing information about Person Not-A-Match declarations.
  • Update to the latest GEDCOM X Java version.
  • Adding and fixing hypermedia links to/from Memories resources.
  • A ton of documentation and example request updates.

October 23, 2013

  • Experimental Features have been implemented. Partners are now expected to regularly check for experimental features and update their code if needed. For more information, see the Experimental Features Resource.
  • The following experimental features have been defined and will be activated in January 2014:
    • The throttled-response-429-replaces-503 experimental feature will ensure that the 429 response is issued for throttled requests instead of a 503 all consumers of the API.
    • The root-xml-element-without-xmlns-prefix experimental feature removes the gx: prefix for all XML responses. (The elements are still in the same namespace, so the feature shouldn't break your namespace-aware XML parsers.)
    • The relationship-persons-local-hrefs experimental feature uses local hrefs to refer to persons and relationships that are returned in the same document (e.g., person with relationships query).
    • The parent-child-relationship-resources-consolidation experimental feature consolidates the parent-child and child-and-parents resources into a single resource where both sets of relationships are returned.
    • The discussion-reference-json-fix experimental feature fixes a bug in the JSON representation of discussion references, making it an object instead of a string, allowing links to be provided to delete the references.
  • The "media" endpoints have been renamed to "memories".
  • New Memories resources:
    • Retrieving memories artifacts (photos).
    • Specifying personas and tags on a memory.
  • Additional documentation and use cases for Authorization and Access Token resources.
  • Discussion references and source references are now validated before being returned so the list can be used to determine an accurate count of discussions and sources on a person or relationship.
  • Bug Fix: 'accept versioned' warning only applies if the resource produces a versioned media type.

September 16, 2013

  • Media (Prototype): Features for Photos and Stories. There is a partial implementation available, covering creating, reading, updating, and deleting a media artifact. Since this is simply a prototype, things are subject to change. Please provide feedback.
  • Example Requests Renamed: Naming of example requests was inconsistent. The naming has been updated for better consistency.
  • The error when you try to update zero resources has now been distinguished from the error when you try to update two or more resources.
  • Bug Fix: (PLTAPI-181) No Attribution on ChildAndParents Relationship Facts (fixed).
  • Bug Fix: Gracefully catch and report search api timeouts.
  • Bug Fix: Full person details not returned with &persons query parameter on relationship resources (fixed).

August 29, 2013

August 6, 2013

  • Loosen Person Search criteria - given name and surname are no longer required.
  • Loosen Person Matches Query criteria - given name, surname, gender, and two other parameters are required.
  • Fix OutOfMemory errors when doing searches with &s in the search parameters.
  • Support escaping quotes with a \ in Search and Match queries.
  • Persons with Relationships resource now correctly returns the X-entity-forwarded-id header when appropriate.
  • Return a 500 status code when appropriate instead of a 404 on Person Search.
  • Enrich content of Change History to better explain what the old and new values are.
  • Further optimize HEAD requests for Change History.
  • Return a warning header when an unknown name type is provided.
  • Fix rare NullPointerExceptions when updating a person.

July 12, 2013

  • Allow for up to 9 generations to be returned from the Ancestry resource and 3 generations from the Descendancy resource.
  • The GET method on all relationships resources now supports a persons parameter. When the persons parameter is present (the value is ignored), full person details will be returned for all people referenced in all of the relationships that are also returned. See the Relationships To Spouses with Persons example request for a simple example of this.
  • Change History is now paged and returns 20 results by default.
  • Update Person Merge constraints.
  • Format the lifespan display property of persons according to the Accept-Language header.
  • Add support for the locale query parameter as an override or alternative for the Accept-Language header.
  • Add JSON to the Get Source Description example request.
  • Fix NullPointerExceptions when creating Person Source References.
  • Fix error when requesting text/html from the Discussion resources.

June 13, 2013

  • Add the Source Reference Query resource to get a list of persons and relationships that a source is attached to.
  • Support for the X-Reason header on creates and updates in addition to deletes.
  • Fix NullPointerException when doing a person match caused by an empty query parameter.
  • Ignore match parameters during validation when they're empty.
  • Return a warning header when multiple normalized date values are given.
  • Return a warning header when the language for a normalized date value is given.
  • Add display properties to the Person Get example request.
  • Remove the contributor and modified date from the Source Reference Create example requests.
  • Return a warning header when the contributor or modifed date is given on a POST.
  • Add a reason to the Person Not-A-Match Get example request.
  • Fix a bug where the Persons with Relationships resource was returning a 303 while the Persons resource was returning a 404.
  • Update the registration URL in the Discovery Resource to point to the new registration page.
  • Fix bug where some person change events were being labeled as couple changes.
  • Return warning headers with a 409 Conflict response to explain what the conflict was.

June 4, 2013

  • Fix for illegal Unicode characters that were being returned.
  • Return the reason for Update and Create changes in the Change History.
  • Fix the results value returned in searches so that it reflects the total number of results instead of the number returned in that page.
  • Add links to conclusions returned by the Person With Relationships resource.
  • Fix NullPointerExceptions being thrown on matches when the value of a search term was just a space, such as " ". Those search terms are now ignored.
  • When a 301 is returned due to a merge, the details of the forwarded person are now also included in the response. This enables you to retrieve details of the old person when necessary, such as displaying the name of the person that was merged.

May 22, 2013

  • Add support for updating source references.
  • Restore links in Change History will not appear if the change can't be restored.
  • Fix more 500 errors on person reads do to the user not having rights to see the person. A 403 is returned.

May 17, 2013

  • Fix 500 errors being returned when trying to access a person you didn't have rights to see. A 403 is now correctly returned.
  • Fix 500 errors sometimes being returned when a person has been forwarded (merged) to another person.
  • Fix 500 errors occasionally being returned on matches due to a NullPointerException.

May 16, 2013

  • Fix the 500 error on Person Discussion References resource when a person has been forwarded. A forwarded response is now correctly returned.
  • Revert XML changes made the day before.

May 15, 2013

  • Fix a NullPointerException that was causing 500s on the Person With Relationships resource.

May 15, 2013

  • Turned on throttling. Response code 429 is used to indicate that the request has been denied for the purposes of rate limiting. A Retry-After header is provide to suggest a number of milliseconds to wait before trying the request again.
  • Added the Not a Match resource.
  • The time-to-live value has been removed from cache directives to avoid stale data. We expect it to come back once we leverage natural cache invalidation.
  • Cache directives (ETag, Last-Modified) were applied to person spouse relationships, person child relationships, person parent relationships, and person-with-relationships.
  • The restore link in change history will only be available when the change is restoreable.
  • Person change history now includes changes to the person's relationships.
  • Changes to notes on a couple and parent-child relationship changes now correctly identify the object modifier.
  • Search query now honors multiple values for the same query key.
  • Confidence levels were changes to Low, Medium, and High.
  • A reason may be passed on a merge request using the X-Reason header.
  • The name forms on a person are now being provided with the "primary" name form first in the list.
  • Support for escaping illegal XML characters.
  • Minor change to the XML namespacing to make the XML cleaner.
  • Minor documentation fixes and enhancements.

Certification Changes

December 15, 2015

  • Update Certification Tree Write Merging Requirements. Merging must provide the ability to reconcile sources for the person being merged in addition to comparing vital, family, and other information. Certification requirements will be Effective March 15, 2016

November 24, 2015

  • Update Certification Updated the Add Person and Tree Write certification requirements to optionally redirect the user to the FamilySearch Possible Duplicates page to merge duplicates or flag persons as not a match. These changes do not add additional certification requirements but provide options for existing requirements.

October 8, 2015

  • Update Certification Tree Write for Standardized Events. Data for vital events such as birth, marriage, and death can now be standardized using normalized values from partner standards or FamilySearch standards. FamilySearch Authorities API is preferred. Certification requirements will be Effective October 15, 2015

August 15, 2015

  • Update Certification requirements for saving data of living and deceased ancestors on web applications. Authentication Requirements, Read Person Requirements, and Read a Pedigree have been updated to show the requirements for partner applications saving person data on behalf of the users. Certification requirements will be Effective August 15, 2015

July 30, 2015

  • Update Certification requirements for temple ordinance reservations. FamilySearch family tree developers performing temple ordinance reservations are now required to enforce the 110-Year Reservation Rule. Certification requirements will be Effective July 30, 2015

July 15, 2015

  • New Certification Add Person requirements. Certification table of contents has been modified and Add Person Checklist have been added so that certification is possible for properly adding a person to family tree. Certification requirements will be Effective October 15, 2015
  • Update Certification Tree Write for Standardized Events. Data for vital events such as birth, marriage, and death should be standardized using FamilySearch’s Place and Date Authorities. Certification requirements will be Effective October 15, 2015
  • Update Certification Documentation for Source Write. Checklist divided by Create Sources, Attach Sources and Update Sources. No certification requirements have changed.
  • Update Certification Overview for Certification Compliance Enforcement Measures. Provides an overview of non-compliance situations, determining non-compliance, and enforcement escalation steps. No certification requirements have changed.

June 18, 2015

  • Update Certification Source Write requirements. Source Write Checklist , Create Source and Source Comparison have been modified to reflect the need to reduce duplication of sources by saving and checking SrcIDs. Certification requirements will be Effective September 15, 2015
  • Updated Certification Update Redirect requirements and instructions to Other certification section so that redirect message is required one-time for only applications that write to Family Tree. Certification requirements will be Effective September 15, 2015

May 11, 2015

  • New Certification Added Redirect Certification instructions to Other certification section. Requirements are provided for redirecting to FamilySearch pages and for framing FamilySearch pages. Certification requirements were updated June 18, 2015

March 31, 2015

March 30, 2015

December 8, 2014

  • Updated Certification Tree Write Person Modification now requires that the prior reason be the default entry in the reason box for the modified entry. Certification requirement is Effective March 25, 2015
  • Updated Certification Tree Write Person Compare and Transfer now requires that the prior reason be the default entry in the reason box for the modified entry. Certification requirement is Effective March 25, 2015
  • Updated Certification Source Write now requires that the prior reason be the default entry in the reason box for the modified entry. Certification requirement is Effective March 25, 2015
  • Updated Certification Source Compare and Transfer now requires that the prior reason be the default entry in the reason box for the modified entry. Certification requirement is Effective March 25, 2015

December 3, 2014

  • Updated Certification Overview has section added for suggestions regarding Browser Plug-ins

November 18, 2014

  • Updated Certification Authentication for web applications was updated to show the new flow which has a "Permission Acceptance" screen after the the "Sign In" screen.
  • Updated Certification Authentication desktop and mobile applications was updated to require that a special message needs to be displayed indicating that profile and ancestor data from FamilySearch will be accessible by the application. Certification requirement is Effective February 25, 2015

Guides Changes

November 24,2015

  • Updated Guide Added New Feature Support for using a persistent identifier to redirect users to the FamilySearch Possible Duplicates page. The value of the persistent identifier is found in the context parameter of a persistent identifier. For more information, see Redirecting and Persistent Identifiers.

October 28,2015

  • Updated Guide Added the process for joining the FamilySearch Developer Network (FSDN) to the Get Started Guide.

September 29,2015

  • Updated Guide The Throttling document now includes an explanation of how to invoke throttling for testing purposes.

September 10, 2015

  • Updated Article Added instruction to the Ordinances resource section of the API resources docs on how to obtain a copy of the Ordinance Reservation Service API document.

August 14, 2015

  • App Key Enablement The Get Started Guide has been updated with an explanation of how to enable your app key to access the "beta" collection and the "production" collection of FamilySearch data.

July 7, 2015

  • Reorganized the guide topics. Created the API Resources Guide to align with the Resources API and put all the concepts topics into the API Concepts Guide

June 5, 2015

April 15, 2015

March 31, 2015

November 18, 2014


Tools Changes

September 23, 2015

  • New Tool Other Tools now has a Tree Data Copy Utility.

December 3, 2014


Partnering Changes

December 17, 2015

September 29, 2015

  • Updated Documentation The Compatible Product Affiliate Agreement was added to the Partnering Resources Legal Agreements. It replaces the Family History Center Affiliate Agreement and the Certified Web Service Affiliate Agreement.

July 10, 2015