For Software Developers: Online retrieval of The Word (.twd 1.1) files
You may retrieve a list of available .twd files. Each item includes a link (URL) to download an individual .twd file.
The list is available as HTML, Atom, CSV and JSON, for all files = archive files or “current” files (= of the current year and the year to come).
Web Services in /service/TheWord/
The URLs follow the pattern: https://bible2.net/service/TheWord/<url fragment>?<parameter> .
Resource twd11
| Method | URL fragment | Parameter | Side-effect, Response, Example |
|---|---|---|---|
| GET | twd11/ |
format=csv |
See below: Format of CSV Listhttps://bible2.net/service/TheWord/twd11/?format=csv |
twd11/ |
format=atom |
Feed with files, see below: Atom Listhttps://bible2.net/service/TheWord/twd11/?format=atom |
|
twd11/ |
format=json |
Feed with files, see below: JSON Listhttps://bible2.net/service/TheWord/twd11/?format=json |
|
twd11/ |
format=html (default) |
XHTML 1.0
table, see below: HTML Listhttps://bible2.net/service/TheWord/twd11/format=htmlhttps://bible2.net/service/TheWord/twd11/ |
|
| GET | twd11/current |
ditto | Same as twd11/, but only files of current year and years to come.https://bible2.net/service/TheWord/twd11/current |
| GET | twd11/archive |
ditto | Same as twd11/, but only files of past years.https://bible2.net/service/TheWord/twd11/archive |
| GET | twd11/$lang_$bible_$year |
format=twd |
delivers .twd file.https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2008 |
twd11/$lang_$bible_$year.twd |
same as format=twd.https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2008.twd |
Format of CSV List
Example:
category;year;lang;bible;biblename;updated;url;info file;2009;de;Schlachter2000;Schlachter 2000;2008-09-02T20:20:56+02:00;https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2009.twd; file;2008;de;Schlachter2000;Schlachter 2000;2008-09-02T20:20:56+02:00;https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2008.twd; file;2007;de;Schlachter2000;Schlachter 2000;2008-09-02T20:20:56+02:00;https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2007.twd;
- The file starts with a header line.
- The order of columns is not guaranteed - use the header names to find the column index of a specific column.
- The structure of the following lines depends on the value of the first cell („category”) of the respective line.
- The list is sorted descending by 1. year, 2. „updated”.
Categories
| Category | Structure of line (columns) |
|---|---|
| info | cell in „info” column is information to be displayed to the user, see below: Columns for category „info" |
| file | cells in the following columns are specified by the header line, see below: Columns for category „file" |
Columns for category „info“
| Column | Description |
|---|---|
| info | information to be displayed to the user, newlines are written as \n (two characters), no semi-colon contained. |
| updated | date of last modification of this info item (ISO format) |
| lang | language of the info text (at least a line with lang=“en” will be available) |
Columns for category „file“
| Column | Description |
|---|---|
| year | 4-digit year number |
| lang | ISO language code |
| bible | short name (A-Za-z0-9) of Bible, e.g. Schlachter2000 |
| biblename | name of Bible, e.g. Schlachter 2000 (Unicode characters) |
| updated | date of last modification of the .twd file (ISO format) |
| url | URL to retrieve the .twd file. e.g. https://bible20.local/service/TheWord/twd11/de_Schlachter2000_2009.twd
Note: the URL is meant to be used as is. Its format may change (e.g. whether a query part ?… is used or not).
Its value may change - do not publish the URL value, use the API to retrieve the URL. |
| info | info about the last modification, other important info about the file. Newlines are written as „\n” (two characters), no semi-colon contained. |
Atom List
Feed with multiple entries. Each entry has one of the categories listed above for .csv.
The list is sorted descending by the field updated.
The feed top level elements
| Element | Description |
|---|---|
| id | the url of the service, e.g. https://bible20.local/service/TheWord/twd11 |
| title | "twd11" followed by info from the URL fragment (from "Resource twd" above) |
| updated | the newest "updated" value from the feed entries |
| author | in a name sub-element: "Team Bible 2.0" |
| link rel='self' | the url of the service (as in "id"), with the format "atom" |
| link rel='alternate' | the url of the service (as in "id"), with the format "html" |
| entry | each one represents an information or a file, as described in the next chapters. |
Elements for category „info“
| Element | Description |
|---|---|
| content | information to be displayed to the user. |
Elements for category „file“
For the following, $year, $lang, $bible, $biblename and $url have the respective values described above for csv format.
| Element | Description |
|---|---|
| id | $url
Note 2014-01-31 HSteeb: the description until today said $year.$bible. But actually, the implementation returns $url since 2010-04-21, to pass the verification with https://feedvalidator.org (The atom spec in RFC 4287 4.2.6. requires for the atom:id element: "Its content MUST be an IRI"). |
| title | $year $lang $biblename |
| link rel='alternate' | URL of .twd file for download |
| content | „info” of csv format |
Example
<?xml version='1.0' encoding='UTF-8'?> <feed xmlns='http://www.w3.org/2005/Atom' xml:lang='en' > <id>https://bible2.net/service/TheWord/twd11</id> <title>twd11</title> <author><name>Team Bible 2.0</name></title> <link rel='self'>https://bible2.net/service/TheWord/twd11?format=atom</link> <link rel='alternate'>https://bible2.net/service/TheWord/twd11?format=html</link> <updated>2008-09-02T20:20:56+02:00</updated> <entry> <id>https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2008</id> <title>2008 de Schlachter 2000</title> <updated>2008-09-02T20:20:56+02:00</updated> <link rel='alternate' href='https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2008.twd'/> <content>2008-09-02: new version<br /> 2008-09-01: initial version</content> </entry> <entry> <id>https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2007</id> <title>2007 de Schlachter 2000</title> <updated>2008-09-02T20:20:56+02:00</updated> <link rel='alternate' href='https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2007.twd'/> </entry> <entry> <id>https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2009</id> <title>2009 de Schlachter 2000</title> <updated>2008-09-02T20:20:56+02:00</updated> <link rel='alternate' href='https://bible2.net/service/TheWord/twd11/de_Schlachter2000_2009.twd'/> </entry> </feed>
JSON List
Returns a JSON formatted string which contains an array of objects with the fields "category", "year", "lang", "bible", "biblename", "updated", "url" and optionally "info".
Example
Note: the example is pretty-printed for display on this page, actually it has no blanks and line breaks around the JSON parts.
[
{
"category": "file",
"year": 2008,
"lang": "de",
"bible": "Schlachter2000",
"biblename": "Schlachter 2000",
"updated": "2010-01-23T05:40:00Z",
"url": "https:\/\/bible2.net\/service\/TheWord\/twd11\/de_Schlachter2000_2008.twd",
},
{
"category": "file",
"year": 2008,
"lang": "it",
"bible": "NuovaRiveduta1994",
"biblename": "Nuova Riveduta 1994",
"updated": "2008-12-29T17:00:00Z",
"url": "https:\/\/bible2.net\/service\/TheWord\/twd11\/it_NuovaRiveduta1994_2008.twd",
"info": "With the text version of 2008-12-29,\nthe Italian texts have been completed\n(they now contain the same bible verses as the other languages).\nSpecial characters are in Unicode notation: \u00f6\u00e4u\u00df"
}
]
HTML List
HTML page with a table containing one row per file. Each row has one of the categories listed above for .csv.
The table is sorted descending by the fields year and updated.