Template for authority documentation

NAME THE FILE: Connecting-to-AUTHORITY-NAME.md

Overview

REPLACE WITH an overview of the new authority.

Prerequisites

REPLACE WITH list of prerequisite steps like creating a password, downloading data, database setup, etc. OR include the phrase: No additional setup required.

Accessing via QA

Authority:	REPLACE WITH AUTHORITY_ABBREVIATION used to access the authority through QA (ex. loc, fast, getty, etc.)

Subauthorities:

REPLACE WITH bulleted list of supported subauthorities.
OR If a different set of authorities is supported for searching and term fetch, break the list as follows._

• for search: List of subauthorities for searching.
• for term: List of subauthorities for fetching terms.

OR If there are no subauthorities, include the phrase: None supported

REMOVE THESE INSTRUCTIONS If this authority is also supported under the linked data module for QA, include the following statement.

NOTE: The linked data module for QA also provides access to this authority. It returns additional data including the URI for terms. See Using-the-Linked-Data-module-to-access-authorities for more information.

---

Example search queries

REMOVE THESE INSTRUCTIONS Include one or two examples that can be used to test the connection to this authority's search API. Include search across subauthorities if supported. And include a subauthority example if supported.

Example search subauthority _SUBAUTHORITY_NAME_:

/qa/search/_AUTHORITY_ABBREVIATION_/_SUBAUTHORITY__?q=_query_string_

Result:

_REPLACE WITH example of first two results_   

REMOVE THESE INSTRUCTIONS It is recommended that you include the URL that the QA request is converted to for accessing the authority natively. This is helpful for debugging and general understanding of how the data is being produced.

NOTE: The qa request is converted to the following AUTHORITY_NAME request. This is for information only. You do not need to know this to use QA.

http://example.url.to.authority.api

---

Example term fetch request

REMOVE THESE INSTRUCTIONS Include one or two examples that can be used to test the connection to this authority's term API. Include a subauthority example if supported.

Example fetch from subauthority _SUBAUTHORITY_NAME_:

/qa/show/_AUTHORITY_ABBREVIATION_/_SUBAUTHORITY_/_id_

Result:

_REPLACE WITH example results (abbreviated if long)_   

REMOVE THESE INSTRUCTIONS It is recommended that you include the URL that the QA request is converted to for accessing the authority natively. This is helpful for debugging and general understanding of how the data is being produced.

NOTE: The qa request is converted to the following AUTHORITY_NAME request. This is for information only. You do not need to know this to use QA.

http://example.url.to.authority.api

---

Example list all terms

REMOVE THESE INSTRUCTIONS Include an example that lists all terms if supported. OR include phase... Not supported

/qa/terms/_AUTHORITY_ABBREVIATION_/_SUBAUTHORITY_/

Result:

_REPLACE WITH example results (abbreviated if long)_   

---

Documentation

REMOVE THESE INSTRUCTIONS Provide a link to the documentation that was used to build this connection to the authority.

Authority_name documents their API at... http://example.url.to.authority.documentation