Properties

Use the Authorities Properties service to get a list of name/value pairs that pertain to the Authorities module.

URI

The response will include such information as limits on the number of entities that can be queried and the number of results that can be requested.

https://api.familysearch.org/authorities/v1/properties

HTTP Method

GET

Parameters

None

Properties


  • culture.max.ids: The maximum number of culture ids that can used in a request to the Culture Authority endpoint. The default is 10.
  • date.max.dates: The maximum number of date phrases that can used in a request to the Date Authority endpoint. The default is 10.
  • name.max.names: The maximum number of place-name phrases that can used in a request to the Name Authority endpoint. The default is 10.
  • place.max.ids: The maximum number of place ids that can used in a request to the Place Authority endpoint. The default is 10.
  • place.max.places: The maximum number of place-name phrases that can used in a request to the Place Authority endpoint. The default is 10.

Errors

Error Possible Causes Implemented
500 Server Error. A generic server error or multiple server errors occurred. If you get this error, please report it through devsupport@familysearch.org. You can also post it to the FamilySearch Developer Network (FSDN). Yes
503 Service Unavailable. FamilySearch or the service that you are using is not currently available. Or you are being throttled. Yes

Example

Request

https://api.familysearch.org/authorities/v1/properties

Response

<?xml version='1.0' encoding='UTF-8'?>
<authorities xmlns="http://api.familysearch.org/authorities/v1" xmlns:fsapi-v1="http://api.familysearch.org/v1" version="1.0.20080320.1495" statusMessage="OK" statusCode="200">
    <fsapi-v1:properties>
        <fsapi-v1:property name="culture.max.ids">10</fsapi-v1:property>
        <fsapi-v1:property name="date.max.dates">10</fsapi-v1:property>
        <fsapi-v1:property name="name.max.names">10</fsapi-v1:property>
        <fsapi-v1:property name="place.max.ids">10</fsapi-v1:property>
        <fsapi-v1:property name="place.max.places">10</fsapi-v1:property>
    </fsapi-v1:properties>
</authorities>