Decorative Arch, Resafa, Syria. Copyright, Daniel Schwartz.

Syriaca.org API documentation


Base url:

http://syriaca.org/api/search

Path Parameters Description Method
/persName
/placeName
/title
/author
/desc
/note
/event
/body
q

Accepts simple text string.

collection

Limits by collection.

  • Gateway to the Syriac Saints
  • The Syriac Biographical Dictionary
  • A Guide to Syriac Authors
  • Qadishe: A Guide to the Syriac Saints
  • The Syriac Gazetteer
  • Bibliotheca Hagiographica Syriaca Electronica
  • SPEAR: Syriac Persons, Events, and Relations
lang

Limits by xml:lang attribute.

author

Accepts simple text string. Used only with '/title' search.

Performs a simple keyword search across all Syriaca.org collections.

Provides results as JSON.

Example:

/api/search/persName?q=aaron&collection=The Syriac Biographical Dictionary

Example:

/api/search/placeName?q=edessa

Example:

/api/search/title?q=mary&author=ephrem

Example:

/api/search/title?q=mari&lang=fr

Example results for:

/api/search/title?q=mary
&collection=Bibliotheca Hagiographica Syriaca Electronica
&lang=en&author=ephrem
[
    {
        "id": "http://syriaca.org/work/1002",
        "title": "Mary Mother of God (text)"
    },
    {
        "id": "http://syriaca.org/work/1001",
        "title": "Mary Mother of God (text)"
    },
    {
        "id": "http://syriaca.org/work/1000",
        "title": "Mary Mother of God (text)"
    }
]
                                
GET

Geographic API

Base url:

http://syriaca.org/api/geo

Path Parameters Description Method
/json
type

accepted values:

  • building
  • church
  • diocese
  • fortification
  • island
  • monastery
  • mountain
  • open-water
  • parish
  • province
  • quarter
  • region
  • river
  • settlement
  • state
  • temple
  • unknown

Provides geoJSON results for all places within the gazetteer with geographic data. Places can be filtered by place type.

Example return all locations:

http://syriaca.org/api/geo/json

Example return only churches:

http://syriaca.org/api/geo/json?type=church

Example return churches and rivers:

http://syriaca.org/api/geo/json?type=church,river

GET
/kml
type

accepted values:

  • building
  • church
  • diocese
  • fortification
  • island
  • monastery
  • mountain
  • open-water
  • parish
  • province
  • quarter
  • region
  • river
  • settlement
  • state
  • temple
  • unknown

Provides KML results for all places within the gazetteer with geographic data. Places can be filtered by place type.

Example return all locations:

http://syriaca.org/api/geo/kml

Example return only churches:

http://syriaca.org/api/geo/kml?type=church

Example return churches and rivers:

http://syriaca.org/api/geo/kml?type=church,river

GET

OAI-PMH Provider API

Base url:

http://syriaca.org/api/oai

Full OAI-PMH documentation can be found: http://www.openarchives.org/OAI/2.0/openarchivesprotocol.htm

Path Parameters Description Method
none verb

OAI-PMH verb.

identifier

Syriaca.org record identifier. ex: http://syriaca.org/place/78

from

Date to start harvesting from. Uses publication/last modified date of record.

until

Date to end harvesting from. Uses publication/last modified date of record.

set

Syriaca.org sets are based on Syriaca.org submodules. Use verb=ListSets to view available sets.

resumptionToken

Where to start results list.

metadataPrefix

What type of data to return.

Syriaca.org currently supports OAI_DC and TEI. Use values: oai_dc or tei

Description of service

List Sets.

Example:

http://syriaca.org/modules/oai.xql?verb=ListSets

List records (Dublin Core)

Example:

http://syriaca.org/modules/oai.xql?verb=ListRecords&metadataPrefix=oai_dc

List records (TEI)

Example:

http://syriaca.org/modules/oai.xql?verb=ListRecords&metadataPrefix=tei

Get a single record

Example:

http://syriaca.org/modules/oai.xql?verb=GetRecord&identifier=http://syriaca.org/place/78

GET