The following gives a short overview about the project's structure:
ARMEP
├── /documents
│ └── :id
├── /map
├── /about
└── /documentation
From both the "documents" or the "map"-perspective all data records in the ARMEP database can be filtered by either thier metadata or their actual textual content:
All data can be filtered by fifteen metadata categories. This functionality can be accessed via the top bar. If two or more metadata categories are selected at once resulting data items must contain all of those. Within each metadata category multiple selections can be made. If so, valid data items may contain only of the selected fields. The metadata filter is connected with a logical “and” to the content filter.
All data can be filtered by four different categories of content (translations, transliterations, lemmata and signs). If tokens from multiple lists are selected then they interconnect with a logical “and” while tokens of the same category connect with a logical “or”. The content filter is connected with a logical “and” to the metadata filter.
Document retrieval is done via the Documents link. On this page you can manage the books.
The displayed list gives an overwiew of all data records in the ARMEP - database
Using the above panel: 
documents can be filtered and searched.
By clicking data records then detailed infomation to each item is shown:
Using the above panel:
Aside from general information detail views may also display:
The following gives a brief summary of the map tools functionalities and features.
The interactive map displays the find spots of about 23,500 inscribed artifacts, all of which bear cuneiform texts written in the Akkadian and Sumerian languages. To provide users with the best possible overview of the places where these rich and varied texts originate (or still exist today), the find spots are displayed as clusters when the map is initially loaded (or is reset). When a cluster is hovered over, the mouseover hover box shows the names of all locations. City/location clusters separate when one zooms in on that particular section of the map.
For an overview of the item(s) in a cluster, click on any cluster circle. The interface will load a dialogue box showing the “descriptor” (a text’s modern designation or primary publication), “genre” (the category of literature), and “period” (when the text was composed) of the available text(s). The order of each column can be sorted (alphabetically), in either ascending or descending order. The displayed information can be searched using the search filter. To get additional information on the find spot, click on the underlined name at the top of the dialogue box, in the area with the changing images.
To access the “Single Item” view of a text, click on the desired row in the “Cluster Overview” (described above). ARMEP will load a second dialogue box showing the text’s designation, provenience, language and script, genre, period (in which the text was written), ruler (during whose reign the text was composed), date (of composition), material (upon which the text was inscribed), (the type of) object, the text's author (if known) and a link to its edition (transliteration and translation) on Oracc (shown inside the red oval in the screenshot). Use the “Previous” and “Next” buttons to navigate between the “Single Item” views of the available texts. Click on the “Detail View” button to view photographs and/or editions of the texts (if they are currently available).
This section lists the available URLs of ARMEP's REST API. Each entry gives the request method (GET, POST or DELETE) in square brackets, the request path and the layout of the response data is listed. Additionally for POST requests the expected layout of the POST data is listed. You have to replace the parameters in the request path by valid ids:
document_id references a document in the database.Both routes api/documents and api/documents-list
can be filtered by either meta data or textual content. Therefore in post data the following filters can be stated:
{
"ancient_author": [...],
"date_of_origin": [...],
"dynastic_seat": [...],
"genre": [...],
"language": [...],
"material": [...],
"object_type": [...],
"period": [...],
"projects": [...],
"provenience": [...],
"ruler": [...],
"script": [...],
"tokens": {"transliterations": {},"lemmata":{},"translations":{},"signs":{}}
}The tokens field can contain objects of the four different content layers translations,lemmata,translations and signs. Each entry has the form {"token":"document_id"}. If one field contains multiple entries, then these a fields are interpreted as a logical or. The fields itself are connected via a logical and.
Returns filter lists to all meta data categories
{
"authors":[...],
"dates":[...],
"dynastic_seats":[...],
"genres":[...],
"languages":[...],
"materials":[...],
"objects":[...],
"periods":[...],
"projects":[...],
"proveniences":[...],
"rulers":[...],
"scripts":[...]
}In this section all API routes, concerning documents are described.
Returns documents in JSON-format
See Filters
[
{
"descriptor":"...",
"genre":"...",
"period":"...",
"provenience":"...",
"id":"..."
},
...
]Returns documents in JSON-format as required by DataTables.js .
{
"data": [
[
"descriptor",
"genre",
"period",
"provenience",
"id"
],
...
]
}Returns a single document.
{
"ancient_author:" ""
"date_of_origin": ""
"designation": "BMS 38"
"display_name": "BMS 38"
"dynastic_seat": ""
"genre": "Prayer/Incantation"
"id": "2316"
"id_composite": "P452899"
"language": "Akkadian"
"lat": "36.358684"
"lng": "43.151937"
"material": "clay"
"object_type": "tablet"
"period": "Neo-Assyrian"
"pleiades_id": "874621"
"popular_name": ""
"provenience": "Nineveh"
"ruler": ""
"script": ""
"title": ""
"vol_title": ""
}Routes, adressing queries on the content (tokens) of stored documents.
Lists all tokens to one of four available token indices (translations,transliterations,lemmata,signs)
translations|transliterations|lemmata|signs[
token1,
token2,
token3,
...
]Returns document_ids to a set of query tokens.
{
"transliterations": [
[
"token1":"token1_id",
"token2":"token3_id",
"token3":"token3_id",
...
],
"lemmata": [
...
],
"translations": [
...
]
"signs": [
...
]
]
}{
"transliterations": [
[
"token1":"document1_id,document2_id,document3_id,...",
"token2":"document1_id,document2_id,document3_id,...",
"token3":"document1_id,document2_id,document3_id,...",
...
],
"lemmata": [
...
],
"translations": [
...
]
"signs": [
...
]
]
}Tries to find a cdli link by a given document_id
HTML content from CDLI
Tries to find a oracc link by a given document_id
'oracc-link-with-document_id'HTML content from ORACC