Dallas Genealogical Society - API

ABOUT BROWSE FEED

Overview

The The Portal to Texas History provides public access to a number of application programming interfaces (APIs) to the collections within the system. Below are examples of APIs available for Dallas Genealogical Society that can be used openly by those interested in programatically accessing data from this system. You do not need to apply for a special key to use these APIs.

For additional information about these APIs or if you have general questions about machine interaction with the The Portal to Texas History please contact .

Note that all example URLs below use the same protocol and server name, https://texashistory.unt.edu/explore/partners/DGS/ . We only show the URL paths and parameters below to save space.

OAI-PMH

The Open Archives Initiative's Protocol for Metadata Harvesting (OAI-PMH) allows programmatic access to this partner's metadata. Two metadata formats are currently supported, the standard oai_dc and the UNT Libraries native metadata format untl.

Below are example URLs which demonstrate some of the standard views of this OAI-PMH repository:

oai/
base URL for OAI-PMH repository
oai/?verb=Identify
Display information about this repository
oai/?verb=ListMetadataFormats
List available metadata formats
oai/?verb=ListSets
List available sets
oai/?verb=ListRecords&metadataPrefix=oai_dc
Display records in the oai_dc metadata format
oai/?verb=ListRecords&metadataPrefix=untl
Display records in the untl metadata format

SRU

Search/Retrieval via URL (SRU) can be used to run advanced queries on the content of this partner. A human-readable stylesheet has been added to help demonstrate searches via SRU. You can see this interface at the following URL.

OpenSearch

OpenSearch is a search protocol which enables simple full-text searches to be performed on this partner's content. The availability of this protocol is advertised in a LINK header element of the site's HTML template as "Search Dallas Genealogical Society," using this OpenSearch Description document.

A human-readable stylesheet has been added to help demonstrate searches via OpenSearch. You can see this interface at the following url.

A custom search can be embedded on your local sites to query The Portal to Texas History. You can copy and paste this code into the page you'd like to feature this search form. Note, you may need to adjust the HTML to match your site's branding/style guidelines.

Thumbnails

Each item in this partner has a convenient way of obtaining the thumbnail image. This is accomplished by appending /thumbnail/ to the end of an objects ARK URL. For example:

The response will be application/jpeg containing a thumbnail for the item requested.

Identifiers

A convenient way to obtain a list of all identifiers for a given Dallas Genealogical Society is available by appending /identifiers/ to the base of the partner URL.

The response will be application/txt containing one ARK identifier per line.

Titles

A convenient way to obtain a list of all titles for the Dallas Genealogical Society is to append 'titles.txt' to the base of the collection URL. The response will be application/txt containing one title per line.

A JSON formatted response is also available by appending 'titles.json'. In addition to the title, a link to the search results for just that title in the system and the number of items associated with that title are given. An optional callback parameter can be used if needed.