Public tDAR APIs

Discovery

• OAI-PMH:
  • Endpoint: http://core.tdar.org/oai-pmh/oai
  • IdentifyVerb: http://core.tdar.org/oai-pmh/oai?verb=Identify
• OpenSearch: http://core.tdar.org/opensearch.xml
• RSS: Rss feeds are available via any search result; project; creator; or collection page
• TAG Gateway (SOAP)
• Lookup Controller (REST-  JSON):
  • Resources:http://core.tdar.org/lookup/resource
    • parameters:
      • term – general keyword search (most fields in resource)
      • title – title search
      • projectId – limit to project
      • collectionId – limit to collection
      • resourceTypes – Limit by resource type (DOCUMENT|DATASET|IMAGE|PROJECT|ONTOLOGY|CODING_SHEET|GIS|SENSORY_DATA); parameter repeats
  • Institutions: http://core.tdar.org/lookup/institution
    • parameters:
      • institution – specify the institution name
  • People: http://core.tdar.org/lookup/person
    • parameters:
      • term – general keyword search (all person fields)
      • firstName
      • lastName
      • institution – institution name
  • Collections: http://core.tdar.org/lookup/collection
    • parameters:
      • term – general keyword search (title and description)
  • Keyword: http://core.tdar.org/lookup/keyword
    • parameters:
      • keywordType – type of keyword to search (CultureKeyword|OtherKeyword|SiteNameKeyword|SiteTypeKeyword|MaterialKeyword|InvestigationType|GeographicKeyword|TemporalKeyword); required
      • term – general keyword search of keyword name and description
• Authentication: https://core.tdar.org/api/login
  • requires: HttpPost; also being added to the tDAR API User Group (contact us)
    • userLogin.loginUsername – your username
    • userLogin.loginPassword – your password
  • returns: xml document with result status, if successful, it will both:
    1. set a session cookie that can be used for authenticated results
    2. return an authentication token (eg. AUTHTOKEN) and parameter name (eg. APITOKENKEYNAME) that can be used in subsequent GET or POST requests for the length of the session; eg. &APITOKENKEYNAME=AUTHTOKEN
• sitemap.xml: http://core.tdar.org/sitemap/sitemap_index.xml

Linking (and Record Information)

• UNAPI
• Schema.org
• OpenURL
• FOAF

Data Creation / Update

• API Controller (REST)
• ODATA (optional)