{ "openapi": "3.0.0", "info": { "title": "Digital Bible Platform", "description": "Fast, easy, and free API access to video, audio, and text Bibles.", "termsOfService": "http://digitalbibleplatform/terms/", "contact": { "email": "support@digitalbibleplatform.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "4.0.0-beta" }, "servers": [ { "url": "http://localhost:8080/api", "description": "Production Server", "variables": { "schema": { "enum": [ "https" ], "default": "https" } } } ], "paths": { "/timestamps": { "get": { "tags": [ "Audio Timing" ], "summary": "Returns Bible Filesets which have audio timestamps", "description": "This call returns a list of fileset that have timestamp metadata associated with them. This data could be used to search audio bibles for a specific term, make karaoke verse & audio readings, or to jump to a specific location in an audio file.", "operationId": "v4_timestamps", "parameters": [ { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible_timestamps" } } } } } } }, "/timestamps/{fileset_id}/{book}/{chapter}": { "get": { "tags": [ "Bibles", "Audio Timing" ], "summary": "Returns audio timestamps for a chapter", "description": "This route will return timestamps for a chapter. Note that the fileset id must be available via the path `/timestamps`. At first, only a few filesets may have timestamps metadata applied.", "operationId": "v4_timestamps.verse", "parameters": [ { "name": "fileset_id", "in": "path", "description": "The specific fileset to return references for", "required": true, "schema": { "$ref": "#/components/schemas/BibleFileset/properties/id" } }, { "name": "book", "in": "path", "description": "The Book ID for which to return timestamps. For a complete list see the `book_id` field in the `/bibles/books` route.", "required": true, "schema": { "$ref": "#/components/schemas/Book/properties/id" } }, { "name": "chapter", "in": "path", "description": "The chapter for which to return timestamps", "required": true, "schema": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_audio_timestamps" } } } } } } }, "/bibles/filesets/{fileset_id}/{book}/{chapter}": { "get": { "tags": [ "Bibles" ], "summary": "Returns content for a single fileset, book and chapter", "description": "For a given fileset, book and chapter, return content (text, audio or video)", "operationId": "v4_bible_filesets.showChapter", "parameters": [ { "name": "fileset_id", "in": "path", "description": "The fileset ID", "required": true, "schema": { "$ref": "#/components/schemas/BibleFileset/properties/id" } }, { "name": "book", "in": "path", "description": "Will filter the results by the given book. For a complete list see the `book_id` field in the `/bibles/books` route.", "required": true, "schema": { "$ref": "#/components/schemas/Book/properties/id" } }, { "name": "chapter", "in": "path", "description": "Will filter the results by the given chapter", "required": true, "schema": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" } }, { "name": "verse_start", "in": "query", "description": "Will filter the results by the given starting verse", "schema": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" } }, { "name": "verse_end", "in": "query", "description": "Will filter the results by the given ending verse", "schema": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible_filesets.showChapter" } } } } } } }, "/bibles/filesets/media/types": { "get": { "tags": [ "Bibles" ], "summary": "Available fileset types", "description": "A list of all the file types that exist within the filesets", "operationId": "v4_bible_filesets.types", "parameters": [ { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object", "example": { "audio_drama": "Dramatized Audio", "audio": "Audio", "text_plain": "Plain Text", "text_format": "Formatted Text", "video_stream": "Video", "audio_stream": "Audio HLS Stream", "audio_drama_stream": "Dramatized Audio HLS Stream" } } } } } } } }, "/download/{fileset_id}/{book_id}/{chapter}": { "get": { "tags": [ "Bibles" ], "summary": "Download specific fileset", "description": "For a given fileset return content (text, audio or video)", "operationId": "v4_download", "parameters": [ { "name": "fileset_id", "in": "path", "description": "The fileset ID", "required": true, "schema": { "$ref": "#/components/schemas/BibleFileset/properties/id" } }, { "name": "book_id", "in": "path", "description": "Will filter the results by the given book. For a complete list see the `book_id` field in the `/bibles/books` route.", "required": false, "schema": { "$ref": "#/components/schemas/Book/properties/id" } }, { "name": "chapter", "in": "path", "description": "Will filter the results by the given chapter", "required": false, "schema": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible_filesets_download.index" } } } } } } }, "/download/list": { "get": { "tags": [ "Bibles" ], "summary": "List of filesets which can be downloaded for this API key", "description": "List of filesets which can be downloaded for this API key", "operationId": "v4_download_list", "parameters": [ { "name": "limit", "in": "query", "description": "The number of search results to return", "schema": { "$ref": "#/components/schemas/BibleFileset/properties/id" } }, { "name": "page", "in": "query", "description": "The current page of the results", "schema": { "type": "integer", "default": 1 } }, { "name": "type", "in": "query", "description": "Filter by type of content (audio, video, text)", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible_filesets_download.list" } } } } } } }, "/bibles/verses/{language_code}/{book_id}/{chapter_id}/{verse_number?}": { "get": { "tags": [ "BibleVerses" ], "summary": "Returns Bibles Verses based on filter criteria", "description": "The base bible route returning by default bibles and filesets that your key has access to", "operationId": "v4_bible_verses.verse_by_language", "parameters": [ { "name": "language_code", "in": "path", "description": "", "required": true, "schema": { "$ref": "#/components/schemas/Language/properties/id" } }, { "name": "book_id", "in": "path", "description": "The book to filter bible_verses by", "required": true, "schema": { "$ref": "#/components/schemas/Book/properties/id" }, "example": "MAT" }, { "name": "chapter", "in": "query", "description": "The chapter to filter bible_verses by", "required": true, "schema": { "$ref": "#/components/schemas/BibleVerse/properties/chapter" } }, { "name": "verse_number", "in": "path", "description": "The verse start to filter bible_verses by", "schema": { "$ref": "#/components/schemas/BibleVerse/properties/verse_number" }, "example": "10" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible_verses.all" } } } } } } }, "/bible/{bible_id}/verses/{book_id}/{chapter_id}/{verse_number?}": { "get": { "tags": [ "BibleVerses" ], "summary": "Returns Bibles Verses based on filter criteria", "description": "The base bible route returning by default bibles and filesets that your key has access to", "operationId": "v4_bible_verses.verse_by_bible", "parameters": [ { "name": "bible_id", "in": "path", "description": "The Bible ID to filter bible_verses by", "required": true, "schema": { "$ref": "#/components/schemas/Bible/properties/id" } }, { "name": "book_id", "in": "path", "description": "The book to filter bible_verses by", "required": true, "schema": { "$ref": "#/components/schemas/Book/properties/id" }, "example": "MAT" }, { "name": "chapter", "in": "query", "description": "The chapter to filter bible_verses by", "required": true, "schema": { "$ref": "#/components/schemas/BibleVerse/properties/chapter" } }, { "name": "verse_number", "in": "path", "description": "The verse start to filter bible_verses by", "schema": { "$ref": "#/components/schemas/BibleVerse/properties/verse_number" }, "example": "10" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible_verses.all" } } } } } } }, "/bibles": { "get": { "tags": [ "Bibles" ], "summary": "Returns Bibles based on filter criteria", "description": "The base bible route returning by default bibles and filesets that your key has access to", "operationId": "v4_bible.all", "parameters": [ { "name": "language_code", "in": "query", "description": "The iso code to filter results by. This will return results only in the language specified. For a complete list see the `iso` field in the `/languages` route", "schema": { "$ref": "#/components/schemas/Language/properties/iso" } }, { "name": "media", "in": "query", "description": "Will filter bibles based upon the media type of their filesets", "schema": { "$ref": "#/components/schemas/BibleFilesetType/properties/set_type_code" }, "example": "audio_drama" }, { "name": "media_exclude", "in": "query", "description": "Will exclude bibles based upon the media type of their filesets", "schema": { "$ref": "#/components/schemas/BibleFilesetType/properties/set_type_code" }, "example": "audio" }, { "name": "country", "in": "query", "description": "The iso code to filter results by. This will return results only in the language specified. For a complete list see the `iso` field in the `/country` route", "schema": { "$ref": "#/components/schemas/Country/properties/id" }, "example": "21" }, { "name": "audio_timing", "in": "query", "description": "This will return results only which have audio timing information available for that bible. The timing information is stored in table bible_file_timestamps.", "schema": { "type": "boolean", "default": false }, "example": "true" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible.all" } } } } } } }, "/bibles/search/{search_text}": { "get": { "tags": [ "Bibles" ], "summary": "Returns metadata for all bibles meeting the search_text in it's name", "description": "metadata for all bibles meeting the search_text in it's name", "operationId": "v4_bible.search", "parameters": [ { "name": "search_text", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Bible/properties/id" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible.search" } } } } } } }, "/bibles/search": { "get": { "tags": [ "Bibles" ], "summary": "Returns metadata for all bibles meeting the given version in it's Bible ID", "description": "metadata for all bibles meeting the version in it's Bible ID", "operationId": "v4_bible_by_id.search", "parameters": [ { "name": "version", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Bible/properties/id" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible.search" } } } } } } }, "/bibles/{id}": { "get": { "tags": [ "Bibles" ], "summary": "Returns detailed metadata for a single Bible", "description": "Detailed information for a single Bible", "operationId": "v4_bible.one", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Bible/properties/id" } }, { "name": "include_font", "in": "query" }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible.one" } } } } } } }, "/bibles/{id}/book": { "get": { "tags": [ "Bibles" ], "summary": "Book information for a Bible", "description": "Returns a list of translated book names and general information for the given Bible. The actual list of books may vary from fileset to fileset. For example, a King James Fileset may contain deuterocanonical books that are missing from one of it's sibling filesets nested within the bible parent.", "operationId": "v4_bible.books", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Bible/properties/id" } }, { "name": "book_id", "in": "query", "description": "The book id. For a complete list see the `book_id` field in the `/bibles/books` route.", "schema": { "$ref": "#/components/schemas/Book/properties/id" } }, { "name": "verify_content", "in": "query", "description": "Filter all the books that have content", "schema": { "type": "boolean" } }, { "name": "verse_count", "in": "query", "description": "Retrieve how many verses the chapters of the books have", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible.books" } } } } } } }, "/bibles/defaults/types": { "get": { "tags": [ "Bibles" ], "summary": "Default Bible for a language", "description": "Returns default Bible for a language", "operationId": "v4_bible.defaults", "parameters": [ { "name": "language_code", "in": "query", "description": "The language code to filter results by", "schema": { "type": "string", "maxLength": 6, "example": "en" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bibles_defaults" } } } } } } }, "/bibles/{bible_id}/copyright": { "get": { "tags": [ "Bibles" ], "summary": "Bible Copyright information", "description": "All bible fileset's copyright information and organizational connections", "operationId": "v4_bible.copyright", "parameters": [ { "name": "bible_id", "in": "path", "description": "The Bible ID to retrieve the copyright information for", "required": true, "schema": { "$ref": "#/components/schemas/Bible/properties/id" } }, { "name": "iso", "in": "query", "description": "The iso code to filter organization translations by. For a complete list see the `iso` field in the `/languages` route.", "schema": { "$ref": "#/components/schemas/Language/properties/iso" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "The requested bible copyrights", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_bible.copyright" } } } } } } }, "/bibles/{fileset_id}/{book}/{chapter}": { "get": { "tags": [ "Library Text" ], "summary": "Returns Signed URLs or Text", "description": "V4's base fileset route", "operationId": "v4_bible.verseinfo", "parameters": [ { "name": "fileset_id", "in": "query", "description": "The Bible fileset ID", "required": true, "schema": { "$ref": "#/components/schemas/BibleFileset/properties/id" } }, { "name": "book", "in": "query", "description": "The Book ID. For a complete list see the `book_id` field in the `/bibles/books` route.", "required": true, "schema": { "$ref": "#/components/schemas/Book/properties/id" } }, { "name": "chapter", "in": "query", "description": "The chapter number", "required": true, "schema": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v2_text_verse" } }, "application/xml": { "schema": { "$ref": "#/components/schemas/v2_text_verse" } }, "text/x-yaml": { "schema": { "$ref": "#/components/schemas/v2_text_verse" } } } } } } }, "/search": { "get": { "tags": [ "Search" ], "summary": "Search a bible for a word", "description": "", "operationId": "v4_text_search", "parameters": [ { "name": "query", "in": "query", "description": "The word or phrase being searched", "required": true, "schema": { "type": "string" }, "example": "Jesus" }, { "name": "fileset_id", "in": "query", "description": "The Bible fileset ID", "required": true, "schema": { "$ref": "#/components/schemas/BibleFileset/properties/id" } }, { "name": "limit", "in": "query", "description": "The number of search results to return", "schema": { "type": "integer", "default": 15 } }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/sort_by" }, { "name": "books", "in": "query", "description": "The usfm book ids to search through separated by a comma", "schema": { "type": "string", "example": "GEN,EXO,MAT" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_text_search" } } } } } } }, "/arclight/jesus-film/languages": { "get": { "tags": [ "Arclight" ], "summary": "Returns detailed metadata for a single Bible arclight", "description": "Returns detailed metadata for a single Bible arclight", "operationId": "v4_video_jesus_film_languages", "parameters": [ { "name": "show_detail", "in": "query" }, { "name": "metadata_tag", "in": "query" }, { "name": "iso", "in": "query" }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } } } } }, "/users/{user_id}/annotations/{bible_id}/{book_id}/{chapter}": { "get": { "tags": [ "Annotations" ], "summary": "Download annotations for specific user and bible fileset", "description": "For a given fileset return content (text, audio or video)", "operationId": "v4_users_download", "parameters": [ { "name": "user_id", "in": "path", "description": "The User ID", "required": true, "schema": { "$ref": "#/components/schemas/User/properties/id" } }, { "name": "bible_id", "in": "path", "description": "Will filter the results by the given bible", "required": true, "schema": { "$ref": "#/components/schemas/Bible/properties/id" } }, { "name": "book_id", "in": "path", "description": "Will filter the results by the given book. For a complete list see the `book_id` field in the `/bibles/books` route.", "schema": { "$ref": "#/components/schemas/Book/properties/id" } }, { "name": "chapter", "in": "path", "description": "Will filter the results by the given chapter", "schema": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" } }, { "name": "notes_sort_by", "in": "query", "description": "The field to sort by for the notes", "schema": { "type": "string" } }, { "name": "bookmarks_sort_by", "in": "query", "description": "The field to sort by for the bookmarks", "schema": { "type": "string" } }, { "name": "highlights_sort_by", "in": "query", "description": "The field to sort by for the highlights", "schema": { "type": "string" } }, { "name": "sort_dir", "in": "query", "description": "The direction to sort by", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_users_download_annotations.index" } } } } } } }, "/alphabets": { "get": { "tags": [ "Languages" ], "summary": "Returns Alphabets", "description": "Returns a list of the world's known scripts. This route might be useful to you if you'd like to query information about fonts, alphabets, and the world's writing systems. Some fileset returns may not display correctly without a font delivered by these via the `alphabets/{script_id}` routes.", "operationId": "v4_alphabets.all", "parameters": [ { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_alphabets_all_response" } } } } } } }, "/alphabets/{script_id}": { "get": { "tags": [ "Languages" ], "summary": "Return details on a single Alphabet", "description": "Returns a single alphabet along with whatever bibles and languages using it.", "operationId": "v4_alphabets.one", "parameters": [ { "name": "script_id", "in": "path", "description": "The alphabet Script, which is used as the identifier", "required": true, "schema": { "$ref": "#/components/schemas/Alphabet/properties/script" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_alphabets_one_response" } } } } } } }, "/countries": { "get": { "tags": [ "Countries" ], "summary": "Returns Countries", "description": "Returns the List of Countries", "operationId": "v4_countries.all", "parameters": [ { "name": "l10n", "in": "query", "description": "When set to a valid three letter language iso, the returning results will be localized in the language matching that iso. (If an applicable translation exists). For a complete list see the `iso` field in the `/languages` route", "schema": { "$ref": "#/components/schemas/Language/properties/iso" } }, { "name": "include_languages", "in": "query", "description": "When set to true, the return will include the major languages used in each country. ", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_countries.all" } } } } } } }, "/countries/search/{search_text}": { "get": { "tags": [ "Countries" ], "summary": "Returns Countries", "description": "Returns the List of Countries filtered by names", "operationId": "v4_countries.search", "parameters": [ { "name": "search_text", "in": "path", "description": "Search countries by name", "required": true, "schema": { "$ref": "#/components/schemas/Country/properties/iso_a3" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": {} } } } } }, "/countries/{id}": { "get": { "tags": [ "Countries" ], "summary": "Returns details for a single Country", "description": "Returns details for a single Country", "externalDocs": { "description": "For more information on Country Codes, please refer to the ISO Registration Authority", "url": "https://www.iso.org/iso-3166-country-codes.html" }, "operationId": "v4_countries.one", "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Country/properties/id" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_countries.one" } } } } } } }, "/languages": { "get": { "tags": [ "Languages" ], "summary": "Returns Languages", "description": "Returns the List of Languages", "operationId": "v4_languages.all", "parameters": [ { "name": "country", "in": "query", "description": "The ISO Country Code. For a complete list of Country codes, please refer to the ISO Registration Authority. https://www.iso.org/iso-3166-country-codes.html", "schema": { "$ref": "#/components/schemas/Country/properties/id" } }, { "name": "language_code", "in": "query", "description": "The iso code to filter languages by. For a complete list see the `iso` field in the `/languages` route", "schema": { "$ref": "#/components/schemas/Language/properties/iso" } }, { "name": "language_name", "in": "query", "description": "The language_name field will filter results by a specific language name", "schema": { "$ref": "#/components/schemas/Language/properties/iso" } }, { "name": "include_translations", "in": "query", "description": "Include the ISO language ids for available translations", "schema": { "type": "boolean" } }, { "$ref": "#/components/parameters/l10n" }, { "$ref": "#/components/parameters/page" }, { "$ref": "#/components/parameters/limit" }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_languages.all" } } } } } } }, "/languages/search/{search_text}": { "get": { "tags": [ "Languages" ], "summary": "Returns languages related to this search", "description": "Returns paginated languages that have search text in its name or country", "operationId": "v4_languages.search", "parameters": [ { "name": "search_text", "in": "path", "description": "The language text to search by", "required": true, "schema": { "$ref": "#/components/schemas/LanguageTranslation/properties/name" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_languages.one" } } } } } } }, "/languages/{id}": { "get": { "tags": [ "Languages" ], "summary": "Returns details on a single Language", "description": "Returns details on a single Language", "operationId": "v4_languages.one", "parameters": [ { "name": "id", "in": "path", "description": "The language ID", "required": true, "schema": { "$ref": "#/components/schemas/Language/properties/id" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_languages.one" } } } } } } }, "/numbers/range": { "get": { "tags": [ "Languages" ], "summary": "Return a range of vernacular numbers", "description": "This route returns the vernacular numbers for a set range.", "operationId": "v4_numbers.range", "parameters": [ { "name": "script_id", "in": "query", "description": "The script_id to return numbers for", "required": true, "schema": { "$ref": "#/components/schemas/NumeralSystem/properties/id" } }, { "name": "start", "in": "query", "description": "The start of the range to select for", "required": true, "schema": { "type": "integer" }, "example": 1 }, { "name": "end", "in": "query", "description": "The end of the range to select for", "required": true, "schema": { "type": "integer" }, "example": 2 }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_numbers_range" } } } } } } }, "/numbers": { "get": { "tags": [ "Languages" ], "summary": "Return all Alphabets that have a custom number sets", "description": "Returns a range of numbers", "operationId": "v4_numbers.index", "parameters": [ { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_numbers.index" } } } } } } }, "/numbers/{id}": { "get": { "tags": [ "Languages" ], "summary": "Return a single custom number set", "description": "Returns a range of numbers", "operationId": "v4_numbers.show", "parameters": [ { "name": "id", "in": "path", "description": "The NumeralSystem id", "required": true, "schema": { "$ref": "#/components/schemas/NumeralSystem/properties/id" } }, { "$ref": "#/components/parameters/version_number" } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_numbers.show" } } } } } } } }, "components": { "schemas": { "pagination": { "title": "Pagination", "description": "The new pagination meta response.", "properties": { "pagination": { "properties": { "total": { "type": "integer", "example": 1801 }, "count": { "type": "integer", "example": 25 }, "per_page": { "type": "integer", "example": 25 }, "current_page": { "type": "integer", "example": 1 }, "total_pages": { "type": "integer", "example": 73 } }, "type": "object" } }, "type": "object", "xml": { "name": "pagination" } }, "v4_bible_timestamps": { "title": "Bible Timestamps", "description": "The bibles hash returned for timestamps", "type": "array", "items": { "properties": { "fileset_id": { "$ref": "#/components/schemas/BibleFileset/properties/id" } }, "type": "object" }, "xml": { "name": "v4_bible.timestamps" } }, "v4_bible_filesets.showChapter": { "title": "v4_bible_filesets.showChapter", "description": "v4_bible_filesets.showChapter", "type": "object", "xml": { "name": "v4_bible_filesets.showChapter" } }, "v4_bible_filesets.copyright": { "title": "v4_bible_filesets.copyright", "description": "v4_bible_filesets.copyright", "properties": { "id": { "$ref": "#/components/schemas/BibleFileset/properties/id" }, "type": { "$ref": "#/components/schemas/BibleFileset/properties/set_type_code" }, "size": { "$ref": "#/components/schemas/BibleFileset/properties/set_size_code" }, "copyright": { "$ref": "#/components/schemas/BibleFilesetCopyright" } }, "type": "object", "xml": { "name": "v4_bible_filesets.copyright" } }, "v4_bible_filesets_download.index": { "title": "v4_bible_filesets_download.index", "description": "v4_bible_filesets_download.index", "type": "object", "xml": { "name": "v4_bible_filesets_download.index" } }, "v4_bible_filesets_download.list": { "title": "v4_bible_filesets_download.list", "description": "v4_bible_filesets_download.list", "type": "object", "xml": { "name": "v4_bible_filesets_download.list" } }, "v4_bibles_defaults": { "title": "v4_bibles_defaults", "description": "The bible defaults", "properties": { "en": { "properties": { "video": { "$ref": "#/components/schemas/Bible/properties/id" }, "audio": { "$ref": "#/components/schemas/Bible/properties/id" } }, "type": "object" } }, "type": "object", "xml": { "name": "v4_bibles_defaults" } }, "v4_bible.copyright": { "title": "Bible copyrights response", "description": "The v4 bible copyrights response.", "type": "array", "items": { "$ref": "#/components/schemas/v4_bible_filesets.copyright" } }, "v4_bible.fileset_chapter": { "properties": { "book_id": { "$ref": "#/components/schemas/BibleFile/properties/book_id" }, "book_name": { "$ref": "#/components/schemas/BookTranslation/properties/name" }, "chapter_start": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "chapter_end": { "$ref": "#/components/schemas/BibleFile/properties/chapter_end" }, "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_end": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" }, "thumbnail": { "description": "The image url", "type": "string", "maxLength": 191 }, "timestamp": { "$ref": "#/components/schemas/BibleFileTimestamp/properties/timestamp" }, "path": { "$ref": "#/components/schemas/BibleFile/properties/file_name" }, "duration": { "$ref": "#/components/schemas/BibleFile/properties/duration" }, "fileset": { "properties": { "id": { "$ref": "#/components/schemas/BibleFileset/properties/id" }, "type": { "$ref": "#/components/schemas/BibleFileset/properties/set_type_code" }, "size": { "$ref": "#/components/schemas/BibleFileset/properties/set_size_code" } }, "type": "object" } }, "type": "object" }, "v4_bible.fileset_chapter_timestamp": { "type": "array", "items": { "properties": { "timestamp": { "$ref": "#/components/schemas/BibleFileTimestamp/properties/timestamp" }, "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" } }, "type": "object" } }, "v4_bible_chapter_jesus_films": { "type": "array", "items": { "properties": { "component_id": { "type": "string" }, "verses": { "type": "array", "items": { "type": "integer" } }, "meta": { "properties": { "thumbnail": { "type": "string" }, "thumbnail_high": { "type": "string" }, "title": { "type": "string" }, "shortDescription": { "type": "string" }, "longDescription": { "type": "string" }, "file_name": { "type": "string" } }, "type": "object" } }, "type": "object" } }, "v4_text_search": { "properties": { "verses": { "$ref": "#/components/schemas/v4_bible_filesets_chapter" }, "meta": { "$ref": "#/components/schemas/pagination" } }, "type": "object" }, "v4_plan_index_detail": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/v4_plan" }, { "properties": { "total_days": { "type": "integer" } }, "type": "object" } ] }, "v4_plan": { "properties": { "id": { "$ref": "#/components/schemas/Plan/properties/id" }, "name": { "$ref": "#/components/schemas/Plan/properties/name" }, "featured": { "$ref": "#/components/schemas/Plan/properties/featured" }, "thumbnail": { "$ref": "#/components/schemas/Plan/properties/thumbnail" }, "suggested_start_date": { "$ref": "#/components/schemas/Plan/properties/suggested_start_date" }, "created_at": { "$ref": "#/components/schemas/Plan/properties/created_at" }, "updated_at": { "$ref": "#/components/schemas/Plan/properties/updated_at" }, "start_date": { "$ref": "#/components/schemas/UserPlan/properties/start_date" }, "percentage_completed": { "$ref": "#/components/schemas/UserPlan/properties/percentage_completed" }, "user": { "$ref": "#/components/schemas/v4_plan_index_user" } }, "type": "object" }, "v4_plan_index_user": { "description": "The user who created the plan", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "v4_plan_detail": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/v4_plan" }, { "properties": { "days": { "type": "array", "items": { "$ref": "#/components/schemas/PlanDay" } } }, "type": "object" } ] }, "PlaylistItemDetail": { "properties": { "id": { "$ref": "#/components/schemas/PlaylistItems/properties/id" }, "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "fileset_id": { "$ref": "#/components/schemas/PlaylistItems/properties/fileset_id" }, "book_id": { "$ref": "#/components/schemas/PlaylistItems/properties/book_id" }, "chapter_start": { "$ref": "#/components/schemas/PlaylistItems/properties/chapter_start" }, "chapter_end": { "$ref": "#/components/schemas/PlaylistItems/properties/chapter_end" }, "verse_start": { "$ref": "#/components/schemas/PlaylistItems/properties/verse_start" }, "verse_end": { "$ref": "#/components/schemas/PlaylistItems/properties/verse_end" }, "duration": { "$ref": "#/components/schemas/PlaylistItems/properties/duration" }, "completed": { "$ref": "#/components/schemas/PlaylistItems/properties/completed" } }, "type": "object" }, "v4_playlist": { "properties": { "id": { "$ref": "#/components/schemas/Playlist/properties/id" }, "name": { "$ref": "#/components/schemas/Playlist/properties/name" }, "featured": { "$ref": "#/components/schemas/Playlist/properties/featured" }, "created_at": { "$ref": "#/components/schemas/Playlist/properties/created_at" }, "updated_at": { "$ref": "#/components/schemas/Playlist/properties/updated_at" }, "external_content": { "$ref": "#/components/schemas/Playlist/properties/external_content" }, "following": { "$ref": "#/components/schemas/Playlist/properties/following" }, "user": { "$ref": "#/components/schemas/v4_playlist_index_user" } }, "type": "object" }, "v4_playlist_index_user": { "description": "The user who created the playlist", "properties": { "id": { "type": "integer" }, "name": { "type": "string" } }, "type": "object" }, "v4_playlist_detail": { "type": "object", "allOf": [ { "$ref": "#/components/schemas/v4_playlist" }, { "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/PlaylistItemDetail" } } }, "type": "object" } ] }, "v4_users_download_annotations.index": { "title": "v4_users_download_annotations.index", "description": "v4_users_download_annotations.index", "type": "object", "xml": { "name": "v4_users_download_annotations.index" } }, "v4_languages.all": { "description": "Display a listing of the resource.\n * Fetches the records from the database > passes them through fractal for transforming.", "properties": { "data": { "type": "array", "items": { "properties": { "id": { "$ref": "#/components/schemas/Language/properties/id" }, "glotto_id": { "$ref": "#/components/schemas/Language/properties/glotto_id" }, "iso": { "$ref": "#/components/schemas/Language/properties/iso" }, "name": { "$ref": "#/components/schemas/Language/properties/name" }, "autonym": { "$ref": "#/components/schemas/LanguageTranslation/properties/name" }, "bibles": { "type": "integer", "example": 12 }, "filesets": { "type": "integer", "example": 4 }, "country_population": { "$ref": "#/components/schemas/Language/properties/population" } }, "type": "object" } } }, "type": "object" }, "v4_languages.one": { "properties": { "data": { "$ref": "#/components/schemas/Language" } }, "type": "object" }, "v4_numbers_range": { "title": "The numbers range return", "description": "The numbers range return", "properties": { "data": { "type": "array", "items": { "properties": { "numeral": { "type": "string", "example": "1" }, "numeral_vernacular": { "type": "string", "example": "১" } }, "type": "object" } } }, "type": "object", "xml": { "name": "v4_numbers_range" } }, "v4_numbers.index": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string", "example": "bengali" }, "description": { "type": "string", "example": "description for bengali" }, "notes": { "type": "string", "example": "notes for bengali" } }, "type": "object" } } }, "type": "object" }, "v4_numbers.show": { "properties": { "data": { "$ref": "#/components/schemas/NumeralSystem" } }, "type": "object" }, "Bible": { "title": "Bible", "description": "Bible", "properties": { "custom_font_required": { "title": "custom_font_required", "description": "Flag to mark if the bible has a custom font", "type": "boolean" }, "id": { "title": "id", "description": "The Archivist created Bible ID string. This will be between six and twelve letters usually starting with the iso639-3 code and ending with the acronym for the Bible", "type": "string", "maxLength": 12, "minLength": 6, "example": "ENGESV" }, "language_id": { "$ref": "#/components/schemas/Language/properties/id" }, "date": { "title": "date", "description": "The year the Bible was originally published", "type": "integer", "maximum": 4, "minimum": 1, "example": 1963 }, "scope": { "$ref": "#/components/schemas/BibleFilesetSize/properties/set_size_code" }, "derived": { "title": "derived", "description": "This field indicates the Bible from which the current Scriptures being described are derived.", "type": "string", "example": "English New Revised Standard Version", "nullable": true }, "copyright": { "title": "copyright", "description": "A short copyright description for the bible text.", "type": "string", "maxLength": 191, "example": "© 1999 Bible Society of Ghana" }, "versification": { "title": "versification", "description": "The versification system for ordering books and chapters", "type": "string", "enum": [ "protestant", "luther", "synodal", "german", "kjva", "vulgate", "lxx", "orthodox", "nrsva", "catholic", "finnish" ] }, "created_at": { "title": "created_at", "description": "The timestamp at which the bible was originally created", "type": "string", "example": "2018-02-12 13:32:23" }, "updated_at": { "title": "updated_at", "description": "The timestamp at which the bible was last updated", "type": "string", "example": "2018-02-12 13:32:23" } }, "type": "object", "xml": { "name": "Bible" } }, "BibleBook": { "title": "Bible Book", "description": "The Bible Book Model stores the vernacular book titles and chapters", "properties": { "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "book_id": { "$ref": "#/components/schemas/Book/properties/id" }, "name": { "title": "name", "description": "The name of the book in the language of the bible", "type": "string", "maxLength": 191, "example": "1 Corinthians" }, "name_short": { "title": "name_short", "description": "If the vernacular name has an abbreviated form, it will be stored hre", "type": "string", "maxLength": 191, "example": "1 Corinthians" }, "chapters": { "title": "chapters", "description": "A string of the chapters in the book separated by a comma", "type": "string", "maxLength": 491, "example": "1,2,3,4,5,6,7,8,9,10,11,12,13,14,15,16" }, "book_seq": { "title": "book_seq", "description": "The ordering provided by the licensor in the USX file, this column\n * would likely populated for audio and video where there is no text", "type": "string", "maxLength": 4, "example": "B07" } }, "type": "object", "xml": { "name": "BibleBook" } }, "BibleFile": { "title": "BibleFile", "description": "The Bible File Model communicates information about biblical files stored in S3", "required": [ "filename" ], "properties": { "id": { "title": "id", "description": "The id", "type": "integer", "minimum": 0, "example": 4 }, "book_id": { "title": "book_id", "description": "The book_id", "type": "string", "example": "MAT" }, "chapter_start": { "title": "chapter_start", "description": "The chapter_start", "type": "string", "example": "4" }, "verse_sequence": { "title": "verse_sequence", "description": "The starting verse for the bible file but with format = integer", "type": "integer", "minimum": 1, "example": 10 }, "chapter_end": { "title": "chapter_end", "description": "If the Bible File spans multiple chapters this field indicates the last chapter of the selection", "type": "string", "example": "5", "nullable": true }, "verse_start": { "title": "verse_start", "description": "The starting verse at which the BibleFile reference begins", "type": "string", "example": "5" }, "verse_end": { "title": "verse_end", "description": "If the Bible File spans multiple verses this value will indicate the last verse in that reference. This value is inclusive, so for the reference John 1:1-4. The value would be 4 and the reference would contain verse 4.", "type": "string", "example": "5", "nullable": true }, "verse_text": { "title": "verse_text", "description": "If the BibleFile model returns text instead of a file_name this field will contain it.", "type": "string", "example": "And God said unto Abraham, And as for thee, thou shalt keep my covenant, thou, and thy seed after thee throughout their generations." }, "file_name": { "title": "file_name", "description": "The file_name", "type": "string", "maxLength": 191, "example": "ACHBSU_70_MAT_1.html" }, "file_size": { "title": "file_size", "description": "The file size", "type": "integer", "example": 5486618 }, "duration": { "title": "duration", "description": "If the file has a set length of time, this field indicates that time in milliseconds", "type": "integer", "minimum": 0, "example": 683, "nullable": true } }, "type": "object", "xml": { "name": "BibleFile" } }, "BibleFileTimestamp": { "title": "Bible File Timestamp", "description": "The Bible File Timestamp tag model partitions the file into verse by verse sections", "properties": { "id": { "title": "file_id", "description": "The incrementing id of the file timestamp", "type": "integer", "minimum": 1 }, "verse_start": { "title": "verse_start", "description": "The starting verse for the file timestamp", "type": "string", "minimum": 1, "example": "1a" }, "verse_end": { "title": "verse_end", "description": "The ending verse for the file timestamp", "type": "integer", "minimum": 1, "example": 10 }, "verse_sequence": { "title": "verse_sequence", "description": "The starting verse for the bible file but with format = integer", "type": "integer", "minimum": 1, "example": 10 }, "timestamp": { "title": "timestamp", "description": "The time (in seconds) represented by the timestamp", "type": "number", "minimum": 1, "example": 10.19 } }, "type": "object", "xml": { "name": "BibleFileTimestamp" } }, "BibleFileset": { "title": "Bible Fileset", "description": "BibleFileset", "properties": { "id": { "title": "id", "description": "The fileset id", "type": "string", "maxLength": 16, "minLength": 6, "example": "ENGESV" }, "set_type_code": { "$ref": "#/components/schemas/BibleFilesetType/properties/set_type_code" }, "set_size_code": { "$ref": "#/components/schemas/BibleFilesetSize/properties/set_size_code" } }, "type": "object", "xml": { "name": "BibleFileset" } }, "BibleFilesetCopyright": { "title": "Bible Fileset Copyright", "description": "BibleFilesetCopyright", "properties": { "copyright_date": { "title": "copyright_date", "description": "The copyright date created copyright", "type": "string", "example": "2014" }, "copyright": { "title": "copyright", "description": "The copyright", "type": "string", "example": "© Ethnos360" }, "copyright_description": { "title": "copyright_description", "description": "The copyright description", "type": "string", "example": "© Ethnos360" }, "open_access": { "title": "open_access", "description": "The open_access description", "type": "integer", "example": 1 } }, "type": "object", "xml": { "name": "BibleFilesetCopyright" } }, "BibleFilesetSize": { "title": "BibleFilesetSize", "description": "The Bible fileset size model communicates information about generalized fileset sizes", "required": [ "filename" ], "properties": { "id": { "title": "id", "description": "The id", "type": "integer", "minimum": 0, "example": 4 }, "set_size_code": { "title": "set_size_code", "description": "The id", "type": "string", "maxLength": 9, "example": "NTPOTP" }, "name": { "title": "name", "description": "The name", "type": "string", "maxLength": 191, "example": "New Testament & Old Testament Portions" } }, "type": "object", "xml": { "name": "BibleFilesetSize" } }, "BibleFilesetType": { "title": "Bible Fileset Type", "description": "The Bible Fileset Type model communicates general metadata about the bible_filesets.set_size_code", "required": [ "filename" ], "properties": { "id": { "title": "id", "description": "", "type": "string" }, "set_type_code": { "title": "set_type_code", "description": "The set_type_code indicating the type of the fileset", "type": "string", "maxLength": 18, "example": "audio_drama" }, "name": { "title": "name", "description": "The name of the fileset type", "type": "string", "example": "Dramatized Audio" }, "created_at": { "title": "created_at", "description": "", "type": "string" }, "updated_at": { "title": "updated_at", "description": "", "type": "string" } }, "type": "object", "xml": { "name": "BibleFilesetType" } }, "BibleLink": { "title": "BibleLink", "description": "BibleLink", "properties": { "id": { "title": "id", "description": "", "type": "string" }, "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "type": { "title": "type", "description": "The type of link, for example, web, pdf, print", "type": "string", "example": "web" }, "url": { "title": "url", "description": "URL of linked content", "type": "string", "example": "http://bibles.org/versions/aai-AAINT" }, "title": { "title": "title", "description": "", "type": "string", "example": "BibleSearch" }, "organization_id": { "$ref": "#/components/schemas/Organization/properties/id" }, "created_at": { "title": "created_at", "description": "", "type": "string" }, "updated_at": { "title": "updated_at", "description": "", "type": "string" }, "provider": { "title": "provider", "description": "Organization providing the content referenced in the link", "type": "string", "example": "American Bible Society" } }, "type": "object", "xml": { "name": "BibleLink" } }, "BibleOrganization": { "title": "BibleOrganization", "description": "BibleOrganization", "properties": { "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "organization_id": { "$ref": "#/components/schemas/Organization/properties/id" }, "relationship_type": { "title": "relationship_type", "description": "Relationship between Bible and Organization", "type": "string", "example": "publisher" }, "created_at": { "title": "created_at", "description": "", "type": "string" }, "updated_at": { "title": "updated_at", "description": "", "type": "string" } }, "type": "object", "xml": { "name": "BibleOrganization" } }, "BibleTranslation": { "title": "BibleTranslation", "description": "BibleTranslation", "properties": { "id": { "title": "id", "description": "", "type": "string" }, "iso": { "$ref": "#/components/schemas/Language/properties/id" }, "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "vernacular": { "title": "vernacular", "type": "string", "example": "La Palabra De Dios Para Todos" }, "vernacular_trade": { "title": "vernacular_trade", "description": "", "type": "string" }, "name": { "title": "name", "type": "string", "example": "The Word of God for All 2014" }, "type": { "title": "type", "description": "", "type": "string" }, "features": { "title": "features", "description": "", "type": "string" }, "description": { "title": "description", "description": "Details on the translation", "type": "string", "example": "Aguaruna is an indigenous American language of the Jivaroan family..." }, "notes": { "title": "notes", "description": "", "type": "string" } }, "type": "object", "xml": { "name": "BibleTranslation" } }, "BibleVerse": { "title": "BibleVerse", "description": "The BibleVerse model stores the unformatted Bible Text for searching & JSON returned verses", "properties": { "id": { "title": "id", "description": "The incrementing id for the Bible Verse", "type": "integer" }, "book_id": { "$ref": "#/components/schemas/Book/properties/id" }, "chapter": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "verse_number": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_sequence": { "$ref": "#/components/schemas/BibleFile/properties/verse_sequence" }, "verse_text": { "title": "verse_text", "description": "The text of the Bible Verse", "type": "string" } }, "type": "object", "xml": { "name": "BibleVerse" } }, "Book": { "title": "Book", "description": "The Book model communicates information about the canonical books of the Bible", "properties": { "id": { "title": "id", "description": "The USFM 2.4 id for the books of the Bible", "type": "string", "maxLength": 3, "minLength": 3, "example": "MAT" }, "id_usfx": { "title": "id_usfx", "description": "The usfx id for the books of the Bible", "type": "string", "maxLength": 2, "minLength": 2 }, "id_osis": { "title": "id_osis", "description": "The OSIS id for the books of the Bible", "type": "string", "maxLength": 12, "minLength": 2 }, "protestant_order": { "title": "protestant_order", "description": "The standard book order for the `protestant_order` in ascending order from Genesis onwards", "type": "integer", "minimum": 0 }, "testament_order": { "title": "testament_order", "description": "The standard book order within a testament in ascending order from Genesis to Malachi, and Matthew to Revelations", "type": "integer", "minimum": 0 }, "book_testament": { "title": "book_testament", "description": "A short code identifying the testament containing the book", "type": "string", "maxLength": 2, "minLength": 2, "enum": [ "OT", "NT", "AP" ] }, "book_group": { "title": "book_group", "description": "An english name for the section of books that current book can be categorized in", "type": "string", "enum": [ "Historical Books", "Pauline Epistles", "General Epistles", "Apostolic History", "Minor Prophets", "Major Prophets", "The Law", "Wisdom Books", "Gospels", "Apocalypse" ] }, "chapters": { "title": "chapters", "description": "The book's number of chapters", "type": "array", "items": { "type": "integer" }, "nullable": true }, "verses": { "title": "verses", "description": "The book's number of verses", "type": "integer", "nullable": true }, "name": { "title": "name", "description": "The English name of the book", "type": "string" }, "notes": { "title": "notes", "description": "Any archivist notes about the book", "type": "string" }, "description": { "title": "description", "description": "The book's description", "type": "string" }, "created_at": { "title": "created_at", "description": "The timestamp for the books creation", "type": "string" }, "updated_at": { "title": "updated_at", "description": "The timestamp for the last update of the book", "type": "string" } }, "type": "object", "xml": { "name": "Book" } }, "BookTranslation": { "title": "BookTranslation", "description": "The Book Translation's model", "properties": { "iso": { "$ref": "#/components/schemas/Language/properties/iso" }, "book_id": { "$ref": "#/components/schemas/Book/properties/id" }, "name": { "title": "name", "description": "The translated name of the biblical book", "type": "string" }, "name_long": { "title": "name_long", "description": "The long form of the translated name", "type": "string" }, "name_short": { "title": "name_short", "description": "The short form of the translated name", "type": "string" }, "name_abbreviation": { "title": "name_abbreviation", "description": "The abbreviated form of the translated name", "type": "string" }, "created_at": { "title": "created_at", "description": "The timestamp that the translated name was originally created", "type": "string" }, "updated_at": { "title": "updated_at", "description": "The timestamp that the translated name was last updated", "type": "string" } }, "type": "object", "xml": { "name": "BookTranslation" } }, "Commentary": { "title": "Commentary", "description": "Commentary", "properties": { "id": { "title": "id", "description": "The unique ID for the commentary, for example the English Treasure of Scripture Knowledge id is ENGTSK", "type": "string", "maxLength": 12, "minLength": 6, "example": "ENGTSK" }, "type": { "title": "type", "description": "The genre of commentary being described", "type": "string", "maxLength": 11, "minLength": 9, "enum": [ "critical", "devotional", "pastoral", "exegetical" ] }, "author": { "title": "type", "description": "The author of the commentary", "type": "string", "maxLength": 191 }, "date": { "title": "date", "description": "The year the commentary was published", "type": "integer", "example": 1991 }, "features": { "title": "date", "description": "The year the commentary was published", "type": "integer", "example": 1991 }, "publisher": { "title": "publisher", "description": "The original publisher of the commentary", "type": "string", "example": 1991 } }, "type": "object", "xml": { "name": "Commentary" } }, "CommentaryTranslation": { "title": "CommentaryTranslation", "description": "CommentaryTranslation", "properties": { "language_id": { "$ref": "#/components/schemas/CommentaryTranslation/properties/language_id" }, "commentary_id": { "$ref": "#/components/schemas/Commentary/properties/id" }, "vernacular": { "description": "$vernacular", "type": "string" }, "name": { "description": "$name", "type": "string" }, "description": { "description": "$description", "type": "string" } }, "type": "object", "xml": { "name": "CommentaryTranslation" } }, "Lexicon": { "title": "Lexicon", "description": "Lexicon", "properties": { "id": { "title": "id", "description": "Strongs id for the lexical entry", "type": "string", "maxLength": 5, "minLength": 2, "pattern": "/^[G||H]\\d\\d?\\d?\\d?$/", "example": "G1055" }, "base_word": { "title": "base_word", "description": "The Greek or Hebrew word being defined", "type": "string", "maxLength": 64, "example": "γαλήνη" }, "usage": { "title": "usage", "description": "", "type": "string", "example": "calm" }, "definition": { "title": "definition", "description": "", "type": "string" }, "derived": { "title": "derived", "description": "", "type": "string" }, "part_of_speech": { "title": "part_of_speech", "description": "", "type": "string" }, "aramaic": { "title": "aramaic", "description": "", "type": "string" }, "comment": { "title": "comment", "description": "", "type": "string" } }, "type": "object", "xml": { "name": "Lexicon" } }, "Video": { "title": "VideoTranslations", "description": "The Video model holds information about biblical films. It serves as a wrapper for all Video{Value} Models including VideoTags and VideoTranslations.", "properties": { "id": { "title": "id", "description": "", "type": "string" }, "language_id": { "title": "language_id", "description": "", "type": "string" }, "bible_id": { "title": "bible_id", "description": "", "type": "string" }, "series": { "title": "series", "description": "", "type": "string" }, "episode": { "title": "episode", "description": "", "type": "string" }, "section": { "title": "section", "description": "", "type": "string" }, "url": { "title": "url", "description": "", "type": "string" }, "url_download": { "title": "url_download", "description": "", "type": "string" }, "picture": { "title": "picture", "description": "", "type": "string" }, "duration": { "title": "duration", "description": "", "type": "string" }, "created_at": { "title": "created_at", "description": "", "type": "string" }, "updated_at": { "title": "updated_at", "description": "", "type": "string" } }, "type": "object", "xml": { "name": "VideoTranslations" } }, "VideoTag": { "title": "VideoTags", "description": "The VideoTags model holds miscellaneous information about the video model.", "properties": { "id": { "title": "id", "description": "The incrementing id of the video tag", "type": "integer" }, "video_id": { "title": "video_id", "description": "The video id", "type": "integer" }, "category": { "title": "category", "description": "The category", "type": "integer" }, "tag_type": { "title": "category", "description": "The category", "type": "integer" }, "tag": { "title": "tag", "description": "The tag", "type": "string" }, "language_id": { "title": "tag", "description": "The language_id", "type": "integer", "nullable": true }, "organization_id": { "title": "organization_id", "description": "The language_id", "type": "integer", "nullable": true }, "book_id": { "title": "book_id", "description": "The book id", "type": "string", "nullable": true }, "chapter_start": { "title": "chapter_start", "description": "The starting chapter", "type": "integer", "nullable": true }, "chapter_end": { "title": "chapter_end", "description": "The ending chapter", "type": "integer", "nullable": true }, "verse_start": { "title": "verse_start", "description": "The verse_start", "type": "integer", "nullable": true }, "verse_end": { "title": "verse_end", "description": "The verse_end", "type": "integer", "nullable": true }, "time_begin": { "title": "time_begin", "description": "The time_begin", "type": "integer", "nullable": true }, "time_end": { "title": "time_end", "description": "The time_end", "type": "integer", "nullable": true }, "created_at": { "title": "created_at", "description": "The created_at", "type": "string", "nullable": true }, "updated_at": { "title": "updated_at", "description": "The updated_at", "type": "string", "nullable": true } }, "type": "object", "xml": { "name": "VideoTags" } }, "Country": { "title": "Country", "description": "Country", "properties": { "id": { "title": "Country Iso 3166-1", "description": "The Country ID for the country aligning with the ISO 3166-1 standard", "type": "string", "maxLength": 2, "minLength": 2, "externalDocs": { "description": "For more info please refer to the Iso Registration Authority", "url": "https://www.iso.org/iso-3166-country-codes.html" }, "example": "AD" }, "iso_a3": { "title": "Country Iso 3166-3", "description": "The Country iso for the country aligning with the ISO 3166-3 standard", "type": "string", "maxLength": 3, "minLength": 3, "externalDocs": { "description": "For more info please refer to the Iso Wiki", "url": "https://en.wikipedia.org/wiki/ISO_3166-3" }, "example": "AND" }, "fips": { "title": "FIPS ID", "description": "The Country id for the country aligning with the FIPS standard of the United Nations", "type": "string", "maxLength": 2, "minLength": 2, "externalDocs": { "description": "For more info please refer to the FIPS Wiki", "url": "https://en.wikipedia.org/wiki/List_of_FIPS_country_codes" }, "example": "AN" }, "continent": { "title": "continent ID", "description": "The continent code for the country", "type": "string", "maxLength": 2, "minLength": 2, "example": "EU" }, "name": { "title": "Country Name", "description": "The name for the country in English", "type": "string", "maxLength": 191, "example": "Andorra" }, "introduction": { "title": "Country introduction", "description": "A brief description of the country in English", "type": "string", "example": "The landlocked Principality of Andorra is one of the smallest states in Europe, nestled high in the Pyrenees..." } }, "type": "object", "xml": { "name": "Country" } }, "Alphabet": { "title": "Alphabet", "description": "Alphabet", "properties": { "script": { "title": "Alphabet Script", "description": "The Script ID for the alphabet aligning with the iso 15924 standard", "type": "string", "maxLength": 4, "minLength": 4, "externalDocs": { "description": "For more info please refer to the Unicode Consortium", "url": "https://http://www.unicode.org/iso15924/" }, "example": "Cans" }, "name": { "title": "Alphabet Name", "description": "The name of the alphabet in English", "type": "string", "maxLength": 191, "example": "Unified Canadian Aboriginal" }, "unicode_pdf": { "title": "Unicode PDF", "description": "A url to a reference PDF for the alphabet", "type": "string", "maxLength": 191, "example": "https://unicode.org/charts/PDF/U1400.pdf", "nullable": true }, "family": { "title": "Family", "description": "The linguistic family the alphabet can be categorized within", "type": "string", "example": "American", "nullable": true }, "type": { "title": "Type", "description": "The type of alphabet be described", "type": "string", "example": "abugida", "nullable": true }, "white_space": { "title": "White Space", "description": "The usage white space within the alphabet", "type": "string", "example": "between words" }, "open_type_tag": { "title": "Open Type Tag", "description": "The open type tag of the alphabet", "type": "string", "example": "cans" }, "complex_positioning": { "title": "Open Type Tag", "description": "The open type tag of the alphabet", "type": "string", "example": "no" }, "requires_font": { "title": "Requires Font", "description": "If the Alphabet generally requires the use of a font to display correctly online", "type": "boolean", "example": false }, "unicode": { "title": "Unicode", "description": "If the Alphabet is fully supported by the unicode spec", "type": "boolean", "example": true }, "diacritics": { "title": "Diacritics", "description": "If the Alphabet contains diacritics", "type": "boolean", "example": true }, "contextual_forms": { "title": "Contextual Forms", "description": "If the Alphabet contains contextual forms", "type": "boolean", "example": false }, "reordering": { "title": "Reordering", "description": "If the Alphabet contains reordering", "type": "boolean", "example": false, "nullable": true }, "case": { "title": "Case", "description": "If the Alphabet utilizes different cases", "type": "boolean", "example": false, "nullable": true }, "split_graphs": { "title": "Split Graphs", "description": "If the Alphabet contains letters that are written using two separate distinct elements.", "type": "boolean", "externalDocs": { "description": "For more info please refer to the Script Source Feature Definitions", "url": "http://scriptsource.org/cms/scripts/page.php?item_id=entry_detail&uid=cq3q4pwuah#50d6cb6e" }, "example": false }, "status": { "title": "Status", "description": "The status of the alphabet", "type": "string", "enum": [ "Current", "Historical", "Fictional", "Unclear" ], "externalDocs": { "description": "For more info please refer to the Script Source Feature Definitions", "url": "http://scriptsource.org/cms/scripts/page.php?item_id=entry_detail&uid=cq3q4pwuah#71259eae" }, "example": "Current" }, "baseline": { "title": "Baseline", "description": "The alignment of the text within the alphabet", "type": "string", "enum": [ "Hanging", "Centered", "Bottom", "Vertical" ], "externalDocs": { "description": "For more info please refer to the Script Source Feature Definitions", "url": "http://scriptsource.org/cms/scripts/page.php?item_id=entry_detail&uid=cq3q4pwuah#a4a32c47" }, "example": "Bottom" }, "ligatures": { "title": "Ligatures", "description": "Indicates on if letters may be or are required to be joined as a single glyph", "type": "string", "enum": [ "required", "optional", "none" ], "externalDocs": { "description": "For more information please refer to the Script Source Feature Definitions", "url": "http://scriptsource.org/cms/scripts/page.php?item_id=entry_detail&uid=cq3q4pwuah#3e655409" }, "example": "none" }, "direction": { "title": "Direction", "description": "The direction that the alphabet is read", "type": "string", "enum": [ "rtl", "ltr", "" ], "externalDocs": { "description": "For more information please refer to the Script Source Feature Definitions", "url": "http://scriptsource.org/cms/scripts/page.php?item_id=entry_detail&uid=cq3q4pwuah#02674a4e" }, "example": "ltr", "nullable": true }, "sample": { "title": "Sample Image", "description": "A sample section of text for the alphabet", "type": "string" }, "sample_img": { "title": "Sample Image", "description": "A url to an image of the sample section of text for the alphabet", "type": "string" } }, "type": "object", "xml": { "name": "Alphabet" } }, "AlphabetFont": { "title": "Alphabet Font", "description": "Alphabet Font", "properties": { "id": { "title": "Alphabet Font ID", "description": "The incrementing numeric id for the alphabet fonts", "type": "integer", "example": 7 }, "font_name": { "title": "Alphabet Font Name", "description": "The Font Name", "type": "string", "maxLength": 191, "example": "Noto Naskh Arabic" }, "font_filename": { "title": "Alphabet Font File Name", "description": "The File name for the font", "type": "string", "maxLength": 191, "example": "NotoNaskhArabic-Regular" }, "font_weight": { "title": "Alphabet Font Weight", "description": "The boldness of the font", "type": "integer", "minimum": 100, "example": 400, "nullable": true }, "copyright": { "title": "Alphabet copyright", "description": "The copyright of the font if any", "type": "string", "maxLength": 191, "example": "Creative Commons", "nullable": true }, "url": { "title": "Alphabet URL", "description": "The url to the font file", "type": "string", "example": "https://cdn.example.com/resources/fonts/NotoNaskhArabic-Regular.ttf" }, "notes": { "title": "Notes", "description": "Any notes for the font file name", "type": "string", "example": "notes specific to this font", "nullable": true }, "italic": { "title": "Italic", "description": "Determines if the font file contains or supports italics", "type": "boolean", "example": false, "nullable": true } }, "type": "object", "xml": { "name": "AlphabetFont" } }, "Language": { "title": "Language", "description": "Language", "properties": { "id": { "title": "id", "description": "The incrementing ID for the language", "type": "integer", "example": 6411 }, "glotto_id": { "title": "glotto_id", "description": "The glottolog ID for the language", "type": "string", "externalDocs": { "description": "For more info please refer to the Glottolog", "url": "http://glottolog.org/" }, "example": "stan1288" }, "iso": { "title": "iso", "description": "The iso 639-3 for the language", "type": "string", "maxLength": 3, "externalDocs": { "description": "For more info", "url": "https://en.wikipedia.org/wiki/ISO_639-3" }, "example": "spa" }, "name": { "title": "Name", "description": "The name of the language", "type": "string", "maxLength": 191, "example": "Spanish" }, "maps": { "title": "Maps", "description": "The general area where the language can be found", "type": "string", "example": "Andorra and France" }, "development": { "title": "Development", "description": "The development of the growth of the language", "type": "string", "example": "Fully developed. Bible: 1553-2000." }, "use": { "title": "use", "description": "The use of the language", "type": "string", "example": "60,000,000 L2 speakers." }, "location": { "title": "Location", "description": "The location of the language", "type": "string" }, "area": { "title": "Area", "description": "The area of the language", "type": "string", "example": "Central, south; Canary Islands. Also in Andorra, ..." }, "population": { "title": "Population", "description": "The estimated number of people that speak the language", "type": "number", "example": 24900 }, "population_notes": { "title": "Population Notes", "description": "Any notes regarding the estimated number of people", "type": "string", "example": "58,200,000 in United Kingdom (Crystal 2003). Population total all countries: 334,800,758." }, "notes": { "title": "Notes", "description": "Any notes regarding the language", "type": "string", "example": "The Aragonese dialect of Spanish is different from Aragonese language [arg]. Christian." }, "typology": { "title": "Typology", "description": "The language's Typology", "type": "string", "example": "SVO,prepositions,genitives, relatives after noun heads,articles, numerals before noun heads..." }, "description": { "title": "Description", "description": "The description of the language", "type": "string", "example": "language description" }, "status": { "title": "Status", "description": "A status of the language", "type": "string", "example": "6a" }, "country_id": { "title": "country_id", "description": "The primary country where the language is spoken", "type": "string", "example": "ES" }, "rolv_code": { "title": "rolv_code", "description": "", "type": "string", "example": "" }, "deleted_at": { "title": "deleted_at", "description": "", "type": "string", "example": "" } }, "type": "object", "xml": { "name": "Language" } }, "LanguageCode": { "title": "Language Codes", "description": "Information regarding alternative language coding systems", "properties": { "id": { "title": "id", "description": "The incrementing id of the language Code", "type": "integer", "minimum": 0 }, "language_id": { "title": "language_id", "description": "The foreign key pointing to the incrementing id of the language", "type": "integer", "minimum": 0 }, "source": { "title": "source", "description": "The source pointing to the incrementing id of the language", "type": "string", "example": "Iso 639-2" }, "code": { "title": "code", "description": "The foreign code for the language", "type": "string", "example": "ab" } }, "type": "object", "xml": { "name": "LanguageCode" } }, "LanguageTranslation": { "title": "Language Translation", "description": "Information regarding language translations", "properties": { "id": { "title": "id", "description": "The incrementing id of the language", "type": "integer", "minimum": 0 }, "language_source_id": { "title": "language_source_id", "description": "The incrementing id of the language_source", "type": "integer", "minimum": 0, "example": 17 }, "language_translation_id": { "title": "language_translation_id", "description": "The incrementing id of the language_translation", "type": "integer", "minimum": 0, "example": 68 }, "name": { "title": "name", "description": "The language translation name", "type": "string", "minimum": 0, "example": "Abkasies" }, "priority": { "title": "Priority", "description": "The priority of the language translation", "type": "integer", "maximum": 255, "minimum": 0, "example": 0 }, "created_at": { "title": "created_at", "description": "The timestamp at which the translation was created at", "type": "string" }, "updated_at": { "title": "updated_at", "description": "The timestamp at which the translation was last updated at", "type": "string" } }, "type": "object", "xml": { "name": "LanguageTranslation" } }, "NumeralSystem": { "title": "Numeral System", "description": "NumeralSystem", "properties": { "id": { "title": "Numeral System Id", "description": "The id of the numberal system", "type": "string", "maxLength": 20, "example": "western-arabic" }, "value": { "title": "The integer value of the glyph", "description": "The integer value of the glyph", "type": "integer", "maximum": 200, "minimum": 0, "example": 9 }, "glyph": { "title": "The Vernacular Numeral", "description": "The numeral in the vernacular of the writing system", "type": "string", "maxLength": 8, "example": "੧" }, "numeral_written": { "title": "Alphabet Numeral Written", "description": "The word for the numeral in the vernacular of the writing system", "type": "string", "maxLength": 8 } }, "type": "object", "xml": { "name": "NumeralSystem" } }, "Asset": { "title": "Asset", "description": "Asset", "properties": { "id": { "title": "id", "description": "The id of the Bucket", "type": "string", "maxLength": 64, "example": "dbp-prod" }, "organization_id": { "$ref": "#/components/schemas/Organization/properties/id" }, "asset_type": { "title": "asset_type", "description": "The type of asset being provided", "type": "string", "maxLength": 12, "example": "cloudfront" }, "created_at": { "title": "created_at", "description": "The timestamp at which the bucket was created", "type": "string" }, "updated_at": { "title": "updated_at", "description": "The timestamp at which the bucket was last updated", "type": "string" } }, "type": "object", "xml": { "name": "Asset" } }, "Organization": { "title": "Organization", "description": "Organization", "properties": { "id": { "title": "id", "description": "The Organization's incrementing id", "type": "integer", "minimum": 0, "example": 1 }, "slug": { "title": "slug", "description": "The Organization's name", "type": "string", "maxLength": 191, "example": "american-bible-society" }, "abbreviation": { "title": "abbreviation", "description": "The Organization's abbreviation", "type": "string", "maxLength": 6, "nullable": true }, "notes": { "title": "notes", "description": "Archivist notes about the organization being described", "type": "string", "example": "freetext archivist note", "nullable": true }, "primaryColor": { "title": "primaryColor", "description": "The Organization's primary color derived from their logo", "type": "string", "maxLength": 7, "minLength": 7, "example": "#004b85", "nullable": true }, "secondaryColor": { "title": "secondaryColor", "description": "The Organization's secondary color derived from their logo", "type": "string", "maxLength": 7, "minLength": 7, "example": "#e2383f", "nullable": true }, "inactive": { "title": "inactive", "description": "If the organization has not responded to several attempts to contact this value will be set to true", "type": "boolean", "nullable": true }, "url_facebook": { "title": "url_facebook", "description": "The URL to the organization's facebook page", "type": "string", "maxLength": 191, "example": "https://facebook.com" }, "url_website": { "title": "url_website", "description": "The url to the Organization's website", "type": "string", "maxLength": 191, "example": "https://someorg.com" }, "url_donate": { "title": "url_donate", "description": "The url to the organization's donation page", "type": "string", "maxLength": 191, "example": "https://donate.someorg.com" }, "url_twitter": { "title": "url_twitter", "description": "The url to the organization's twitter page", "type": "string", "maxLength": 191, "example": "https://twitter.com" }, "address": { "title": "address", "description": "The Organization's address", "type": "string", "maxLength": 191, "example": "123 Main Street" }, "address2": { "title": "address2", "description": "The Organization's second line of the address", "type": "string", "maxLength": 191, "example": "" }, "city": { "title": "city", "description": "The organization's city", "type": "string", "maxLength": 191, "example": "Any City" }, "state": { "title": "state", "description": "The Organization's state", "type": "string", "maxLength": 191, "example": "Some State" }, "country": { "title": "country", "description": "ThThe Organization's country", "type": "string", "maxLength": 191, "example": "00000-000" }, "zip": { "title": "zip", "description": "The Organization's zip", "type": "string", "maxLength": 191, "example": "Some Country" }, "phone": { "title": "phone", "description": "The Organization's phone number", "type": "string", "maxLength": 191, "example": "999-999-9999" }, "email": { "title": "email", "description": "The Organization's email address", "type": "string", "maxLength": 191, "example": "contact@organization.com" } }, "type": "object", "xml": { "name": "Organization" } }, "OrganizationTranslation": { "title": "Organization Translation", "description": "The alternative names in different languages for an organization", "properties": { "language_iso": { "title": "language_iso", "description": "The iso code for the translation language", "type": "string", "minLength": 3 }, "organization_id": { "title": "id", "description": "The Organization's incrementing id", "type": "integer", "minimum": 0 }, "vernacular": { "title": "id", "description": "If the current translation is the primary/vernacular translation", "type": "boolean" }, "alt": { "title": "alt", "description": "If the current name is a secondary title for the organization", "type": "boolean" }, "name": { "title": "name", "description": "The current translated name for the organization", "type": "string", "maxLength": 191 }, "description": { "title": "description", "description": "The current translated description for the organization", "type": "string" }, "description_short": { "title": "description_short", "description": "The current translated shortened description for the organization", "type": "string" } }, "type": "object", "xml": { "name": "OrganizationTranslation" } }, "Plan": { "title": "Plan", "description": "The User created Plan", "properties": { "id": { "title": "id", "description": "The plan id", "type": "integer", "minimum": 0 }, "name": { "title": "name", "description": "The name of the plan", "type": "string" }, "user_id": { "title": "user_id", "description": "The user that created the plan", "type": "string" }, "featured": { "title": "featured", "description": "If the plan is featured", "type": "boolean" }, "thumbnail": { "title": "thumbnail", "description": "The image url", "type": "string", "maxLength": 191 }, "suggested_start_date": { "title": "suggested_start_date", "description": "The suggested start date of the plan", "type": "string", "format": "date" }, "draft": { "title": "draft", "description": "If the plan is draft", "type": "boolean" }, "updated_at": { "title": "updated_at", "description": "The timestamp the plan was last updated at", "type": "string", "nullable": true }, "created_at": { "title": "created_at", "description": "The timestamp the plan was created at", "type": "string" } }, "type": "object" }, "PlanDay": { "title": "Plan day", "description": "The day of a Plan", "properties": { "completed": { "title": "completed", "description": "If the plan day is completed", "type": "boolean" }, "id": { "title": "id", "description": "The plan day id", "type": "integer" }, "playlist_id": { "$ref": "#/components/schemas/Playlist/properties/id" } }, "type": "object" }, "UserPlan": { "title": "UserPlan", "description": "The User Plan data", "properties": { "start_date": { "title": "start_date", "description": "The start date of the plan", "type": "string", "format": "date" }, "percentage_completed": { "title": "percentage_completed", "description": "The percentage completed of the plan", "type": "integer" } }, "type": "object" }, "Playlist": { "title": "Playlist", "description": "The User created Playlist", "properties": { "verses": { "title": "verses", "description": "The playlist verses count", "type": "integer" }, "following": { "title": "following", "description": "If the current user follows the playlist", "type": "boolean" }, "id": { "title": "id", "description": "The playlist id", "type": "integer", "minimum": 0 }, "external_content": { "title": "name", "description": "The name of the playlist", "type": "string" }, "name": { "title": "external_content", "description": "The url to external content", "type": "string" }, "user_id": { "title": "user_id", "description": "The user that created the playlist", "type": "string" }, "featured": { "title": "featured", "description": "If the playlist is featured", "type": "boolean" }, "updated_at": { "title": "updated_at", "description": "The timestamp the playlist was last updated at", "type": "string", "nullable": true }, "draft": { "title": "draft", "description": "If the playlist is draft", "type": "boolean" }, "created_at": { "title": "created_at", "description": "The timestamp the playlist was created at", "type": "string" } }, "type": "object" }, "PlaylistItems": { "title": "Playlist Item", "description": "The Playlist Item", "properties": { "completed": { "title": "completed", "description": "If the playlist item is completed", "type": "boolean" }, "full_chapter": { "title": "full_chapter", "description": "If the playlist item is a full chapter item", "type": "boolean" }, "path": { "title": "path", "description": "Hls path of the playlist item", "type": "string" }, "metadata": { "title": "metadata", "description": "Bible metadata info", "properties": { "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "bible_name": { "$ref": "#/components/schemas/BibleTranslation/properties/name" }, "bible_vname": { "$ref": "#/components/schemas/BibleTranslation/properties/name" }, "book_name": { "$ref": "#/components/schemas/BookTranslation/properties/name" } }, "type": "object" }, "id": { "title": "id", "description": "The playlist item id", "type": "integer" }, "playlist_id": { "title": "playlist_id", "description": "The playlist id", "type": "integer" }, "fileset_id": { "title": "fileset_id", "description": "The fileset id", "type": "string" }, "book_id": { "title": "book_id", "description": "The book_id", "type": "string" }, "chapter_start": { "title": "chapter_start", "description": "The chapter_start", "type": "integer", "maximum": 150, "minimum": 0, "example": 4 }, "chapter_end": { "title": "chapter_end", "description": "If the Bible File spans multiple chapters this field indicates the last chapter of the selection", "type": "integer", "maximum": 150, "minimum": 0, "example": 5, "nullable": true }, "verse_start": { "title": "verse_start", "description": "The starting verse at which the BibleFile reference begins", "type": "string", "maximum": 176, "minimum": 1, "example": 5 }, "verse_sequence": { "title": "verse_sequence", "description": "The starting verse at which the BibleFile reference begins", "type": "integer", "maximum": 176, "minimum": 1, "example": 5 }, "verse_end": { "title": "verse_end", "description": "If the Bible File spans multiple verses this value will indicate the last verse in that reference. This value is inclusive, so for the reference John 1:1-4. The value would be 4 and the reference would contain verse 4.", "type": "integer", "maximum": 176, "minimum": 1, "example": 5, "nullable": true }, "duration": { "title": "duration", "description": "The playlist item calculated duration", "type": "integer" }, "verses": { "title": "verses", "description": "The playlist item verses count", "type": "integer" }, "updated_at": { "title": "updated_at", "description": "The timestamp the playlist item was last updated at", "type": "string", "nullable": true }, "created_at": { "title": "created_at", "description": "The timestamp the playlist item was created at", "type": "string" } }, "type": "object" }, "Resource": { "title": "Resource", "description": "Resource", "properties": { "id": { "title": "id", "description": "The Resource's incrementing id", "type": "integer", "minimum": 0 }, "iso": { "title": "iso", "description": "The Resource's iso", "type": "string", "minLength": 3 }, "organization_id": { "$ref": "#/components/schemas/Organization/properties/id" }, "source_id": { "title": "source_id", "description": "The owning organization's tracking id for the resource", "type": "string", "nullable": true }, "cover": { "title": "cover", "description": "The url to the main cover art for the resource", "type": "string", "nullable": true }, "cover_thumbnail": { "title": "cover_thumbnail", "description": "The url to the thumbnail cover art for the resource", "type": "string", "nullable": true }, "date": { "title": "date", "description": "The date the resource was originally published", "type": "string", "nullable": true }, "type": { "title": "type", "description": "The type of media the resource can be categorized as", "type": "string", "nullable": true } }, "type": "object", "xml": { "name": "Resource" } }, "AccessGroup": { "title": "AccessGroup", "description": "The Access Group", "properties": { "id": { "title": "id", "description": "The incrementing id for each access group", "type": "integer" }, "name": { "title": "name", "description": "The name for each access group", "type": "string" }, "description": { "title": "description", "description": "The description for each access group", "type": "string" } }, "type": "object", "xml": { "name": "AccessGroup" } }, "AccessType": { "title": "AccessType", "description": "The Access Type", "properties": { "id": { "title": "id", "description": "The incrementing id for each Access Type", "type": "integer" }, "name": { "title": "name", "description": "The name for each access type", "type": "string" }, "country_id": { "$ref": "#/components/schemas/Country/properties/id" }, "continent": { "$ref": "#/components/schemas/Country/properties/continent" }, "allowed": { "title": "allowed", "description": "If set to false, allowed will change the permission function from a whitelist to a blacklist.", "type": "boolean", "minimum": 0 } }, "type": "object", "xml": { "name": "AccessType" } }, "Account": { "title": "Account", "description": "The Account Model describes the connections between Users and their social accounts", "properties": { "id": { "title": "id", "description": "The incrementing ID for the account", "type": "integer", "minimum": 0, "example": "4" }, "user_id": { "title": "user_id", "description": "The user id for the user who has the account being described", "type": "string" }, "provider_id": { "title": "provider_id", "description": "The social account provider that the user has logged in with", "type": "string", "example": "facebook" }, "provider_user_id": { "title": "provider_user_id", "description": "The key of the provider for the account being described", "type": "string", "example": "" }, "created_at": { "title": "created_at", "description": "The time the social account was originally connected to the user", "type": "string" }, "updated_at": { "title": "updated_at", "description": "The time the social account was last updated", "type": "string" } }, "type": "object", "xml": { "name": "Account" } }, "Profile": { "title": "Profile", "description": "The Profile model communicates information about a user", "properties": { "thoroughfare": { "title": "Street Address", "type": "string" }, "premise": { "title": "Premise", "type": "string" }, "sub_premise": { "title": "Sub Premise", "type": "string" }, "sex": { "title": "The Gender of the User", "description": "This field aligns with the ISO/IEC 5218 Standard. Codes for the representation of human sexes is an international standard that defines a representation of human sexes through a language-neutral single-digit code.", "type": "integer", "format": "int64", "minimum": 0, "enum": [ 0, 1, 2, 9 ], "externalDocs": { "description": "Read More about the standard", "url": "http://standards.iso.org/ittf/PubliclyAvailableStandards/c036266_ISO_IEC_5218_2004(E_F).zip" } }, "sub_administrative_area": { "title": "Sub Administrative Area", "description": "County or District", "type": "string" }, "administrative_area": { "title": "Administrative Area", "description": "State / Province / Region (ISO code when available)", "type": "string" }, "zip": { "title": "Zip", "description": "Postal code / ZIP Code", "type": "string" }, "country_id": { "$ref": "#/components/schemas/Country/properties/id" } }, "type": "object", "xml": { "name": "Profile" } }, "Project": { "title": "Project", "description": "The Project's model", "properties": { "id": { "title": "id", "description": "The unique id for the project", "type": "string", "maxLength": 24 }, "name": { "title": "name", "description": "The name of the project", "type": "string", "maxLength": 191 }, "url_avatar": { "title": "url_avatar", "description": "The url to the logo / main identifying image for the project", "type": "string", "maxLength": 191 }, "url_avatar_icon": { "title": "url_avatar_icon", "description": "The url to the logo / main identifying image for the project in a form that is suitable for small images (less than 100 pixels)", "type": "string", "maxLength": 191 }, "url_site": { "title": "url_site", "description": "The url to the site that is currently making use of the API", "type": "string", "maxLength": 191 }, "reset_path": { "title": "reset_path", "description": "The url to the location that contains the password reset form. Note this should end with a / and expect the final url path item to be a token. Example: https://example.com/password/reset/ with the expectation of receiving https://example.com/password/reset/{TOKEN_ID}", "type": "string", "maxLength": 191, "example": "https://example.com/password/reset/" }, "description": { "title": "description", "description": "The description of the project and it's goals", "type": "string" }, "deleted_at": { "title": "description", "description": "The day the project was soft deleted", "type": "string" }, "created_at": { "title": "description", "description": "The day the project was added to the api", "type": "string" }, "updated_at": { "title": "updated_at", "description": "The day the project was last updated", "type": "string" } }, "type": "object", "xml": { "name": "Project" } }, "PushToken": { "title": "Push Token", "description": "The User Push Token", "properties": { "push_token": { "title": "push_token", "description": "The device push notification token", "type": "string" }, "platform": { "title": "platform", "description": "The device platform (eg: android)", "type": "string" } }, "type": "object" }, "AnnotationTag": { "title": "NoteTag", "description": "The NoteTag's model", "properties": { "id": { "title": "id", "description": "The unique incrementing id for each NoteTag", "type": "integer", "minimum": 0 }, "note_id": { "$ref": "#/components/schemas/Note/properties/id" }, "bookmark_id": { "$ref": "#/components/schemas/Bookmark/properties/id" }, "highlight_id": { "$ref": "#/components/schemas/Highlight/properties/id" }, "type": { "title": "type", "description": "The type of tag that this NoteTag is categorized within.", "type": "string" }, "value": { "title": "value", "description": "The value to the type of NoteTag for this note.", "type": "string" }, "created_at": { "title": "created_at", "description": "The timestamp the NoteTag was first created at", "type": "string" }, "updated_at": { "title": "updated_at", "description": "The timestamp the NoteTag was last updated", "type": "string" } }, "type": "object", "xml": { "name": "NoteTag" } }, "Bookmark": { "title": "Bookmark", "description": "The User created Bookmark", "properties": { "id": { "title": "id", "description": "The unique incrementing id for each Bookmark", "type": "integer", "minimum": 0 }, "book_id": { "$ref": "#/components/schemas/Book/properties/id" }, "chapter": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_sequence": { "$ref": "#/components/schemas/BibleFile/properties/verse_sequence" }, "user_id": { "$ref": "#/components/schemas/User/properties/id" }, "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "updated_at": { "title": "updated_at", "description": "The timestamp the Note was last updated at", "type": "string", "nullable": true }, "created_at": { "title": "created_at", "description": "The timestamp the note was created at", "type": "string" } }, "type": "object", "xml": { "name": "Bookmark" } }, "Highlight": { "title": "Highlight", "description": "The Highlight model", "properties": { "id": { "title": "id", "description": "The highlight id", "type": "integer", "minimum": 0 }, "user_id": { "title": "user_id", "description": "The user that created the highlight", "type": "string" }, "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "book_id": { "$ref": "#/components/schemas/Book/properties/id" }, "chapter": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "highlighted_color": { "title": "highlighted_color", "description": "The highlight's highlighted color in either hex, rgb, or rgba notation.", "type": "string", "example": "#4488bb" }, "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_sequence": { "$ref": "#/components/schemas/BibleFile/properties/verse_sequence" }, "verse_end": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" }, "reference": { "type": "string" }, "project_id": { "$ref": "#/components/schemas/Project/properties/id" }, "highlight_start": { "title": "highlight_start", "description": "The number of words from the beginning of the verse to start the highlight at. For example, if the verse Genesis 1:1 had a `highlight_start` of 4 and a highlighted_words equal to 2. The result would be: In the beginning `[God created]` the heavens and the earth.", "type": "integer", "minimum": 0 }, "highlighted_words": { "title": "highlighted_words", "description": "The number of words being highlighted. For example, if the verse Genesis 1:1 had a `highlight_start` of 4 and a highlighted_words equal to 2. The result would be: In the beginning `[God created]` the heavens and the earth.", "type": "integer" } }, "type": "object", "xml": { "name": "Highlight" } }, "Note": { "title": "Note", "description": "The Note's model", "properties": { "verse_text": { "title": "verse_text", "description": "The text of the Bible Verse", "type": "string" }, "bible_name": { "title": "bible_name", "description": "Bible name", "type": "string" }, "id": { "title": "id", "description": "The unique incrementing id for each NoteTag", "type": "integer", "minimum": 0 }, "book_id": { "$ref": "#/components/schemas/Book/properties/id" }, "chapter": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "verse_sequence": { "$ref": "#/components/schemas/BibleFile/properties/verse_sequence" }, "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_end": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" }, "user_id": { "$ref": "#/components/schemas/User/properties/id" }, "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "reference_id": { "title": "reference_id", "description": "The unique incrementing id for each NoteTag", "type": "string" }, "notes": { "title": "notes", "description": "The body of the notes", "type": "string", "nullable": true }, "created_at": { "title": "created_at", "description": "The timestamp the note was created at", "type": "string" }, "updated_at": { "title": "updated_at", "description": "The timestamp the Note was last updated at", "type": "string", "nullable": true } }, "type": "object", "xml": { "name": "Note" } }, "User": { "title": "User", "description": "The User model communicates information about everyone involved with the project", "properties": { "id": { "title": "id", "description": "The unique id for the user", "type": "integer", "minimum": 1 }, "name": { "title": "name", "description": "The name of the user", "type": "string", "maxLength": 191, "example": "Elu Thingol" }, "password": { "title": "password", "description": "The password for the user's account", "type": "string", "format": "password", "maxLength": 191 }, "nickname": { "title": "nickname", "description": "The preferred name for the user or an informal means of addressing them", "type": "string", "example": "Elwë", "nullable": true }, "avatar": { "title": "avatar", "description": "The url to the user's profile picture", "type": "string", "example": "https://upload.wikimedia.org/wikipedia/commons/7/7c/Profile_avatar_placeholder_large.png", "nullable": true }, "email": { "title": "email", "description": "The user's email address", "type": "string", "format": "email", "example": "thingol@valinor.org" }, "verified": { "title": "verified", "description": "If the user has verified the email address they've provided or if they're connected via a social account", "type": "boolean", "example": true }, "email_token": { "title": "email_token", "description": "The token sent to the user to verify that user's email", "type": "string", "example": "B95p56KqHrz8D3w" } }, "type": "object", "xml": { "name": "User" } }, "v4_alphabets_all_response": { "title": "The all alphabets response", "description": "The minimized alphabet return for the all alphabets route", "properties": { "data": { "type": "array", "items": { "properties": { "name": { "$ref": "#/components/schemas/Alphabet/properties/name" }, "script": { "$ref": "#/components/schemas/Alphabet/properties/script" }, "family": { "$ref": "#/components/schemas/Alphabet/properties/family" }, "type": { "$ref": "#/components/schemas/Alphabet/properties/type" }, "direction": { "$ref": "#/components/schemas/Alphabet/properties/direction" } }, "type": "object" } } }, "type": "object", "xml": { "name": "v4_alphabets_all_response" } }, "v4_alphabets_one_response": { "title": "The single alphabet response", "description": "The full alphabet return for the single alphabet route", "properties": { "data": { "properties": { "name": { "$ref": "#/components/schemas/Alphabet/properties/name" }, "script": { "$ref": "#/components/schemas/Alphabet/properties/script" }, "family": { "$ref": "#/components/schemas/Alphabet/properties/family" }, "type": { "$ref": "#/components/schemas/Alphabet/properties/type" }, "direction": { "$ref": "#/components/schemas/Alphabet/properties/direction" }, "fonts": { "type": "array", "items": { "$ref": "#/components/schemas/AlphabetFont" } }, "languages": { "type": "array", "items": { "$ref": "#/components/schemas/Language" } }, "bibles": { "type": "array", "items": { "$ref": "#/components/schemas/Bible" } } }, "type": "object" } }, "type": "object", "xml": { "name": "v4_alphabets_one_response" } }, "v4_audio_timestamps": { "title": "v4_audio_timestamps", "description": "The v4_audio_timestamps response", "properties": { "data": { "type": "array", "items": { "properties": { "book": { "$ref": "#/components/schemas/BibleFile/properties/book_id" }, "chapter": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "timestamp": { "$ref": "#/components/schemas/BibleFileTimestamp/properties/timestamp" } }, "type": "object" } } }, "type": "object", "xml": { "name": "v4_audio_timestamps" } }, "v4_bible.all": { "title": "v4_bible.all", "description": "The bibles being returned", "properties": { "data": { "type": "array", "items": { "properties": { "abbr": { "$ref": "#/components/schemas/Bible/properties/id" }, "name": { "$ref": "#/components/schemas/BibleTranslation/properties/name" }, "vname": { "$ref": "#/components/schemas/BibleTranslation/properties/name" }, "language": { "$ref": "#/components/schemas/Language/properties/name" }, "language_autonym": { "$ref": "#/components/schemas/LanguageTranslation/properties/name" }, "language_altNames": { "$ref": "#/components/schemas/LanguageTranslation/properties/name" }, "iso": { "$ref": "#/components/schemas/Language/properties/iso" }, "date": { "$ref": "#/components/schemas/Bible/properties/date" }, "filesets": { "properties": { "dbp-prod": { "type": "array", "items": { "$ref": "#/components/schemas/BibleFileset" } } }, "type": "object" } }, "type": "object" } }, "meta": { "$ref": "#/components/schemas/pagination" } }, "type": "object", "xml": { "name": "v4_bible.all" } }, "v4_bible.search": { "title": "v4_bible.search", "description": "The bible being returned", "type": "array", "items": { "properties": { "abbr": { "$ref": "#/components/schemas/Bible/properties/id" }, "name": { "$ref": "#/components/schemas/BibleTranslation/properties/name" }, "language_id": { "$ref": "#/components/schemas/Language/properties/id" } }, "type": "object" }, "xml": { "name": "v4_bible.search" } }, "v4_bible.one": { "title": "v4_bible.one", "description": "The bible being returned", "type": "array", "items": { "properties": { "abbr": { "$ref": "#/components/schemas/Bible/properties/id" }, "alphabet": { "$ref": "#/components/schemas/Alphabet/properties/script" }, "mark": { "$ref": "#/components/schemas/Bible/properties/copyright" }, "name": { "$ref": "#/components/schemas/BibleTranslation/properties/name" }, "description": { "$ref": "#/components/schemas/BibleTranslation/properties/description" }, "vname": { "$ref": "#/components/schemas/BibleTranslation/properties/name" }, "vdescription": { "$ref": "#/components/schemas/BibleTranslation/properties/description" }, "publishers": { "$ref": "#/components/schemas/Organization" }, "providers": { "$ref": "#/components/schemas/Organization" }, "language": { "$ref": "#/components/schemas/Language/properties/name" }, "iso": { "$ref": "#/components/schemas/Language/properties/iso" }, "date": { "$ref": "#/components/schemas/Bible/properties/date" }, "country": { "$ref": "#/components/schemas/Country/properties/name" }, "books": { "$ref": "#/components/schemas/Book/properties/id" }, "links": { "$ref": "#/components/schemas/BibleLink" }, "filesets": { "$ref": "#/components/schemas/BibleFileset" }, "custom_font_required": { "$ref": "#/components/schemas/Bible/properties/custom_font_required" } }, "type": "object" }, "xml": { "name": "v4_bible.one" } }, "v4_bible_verses.all": { "title": "v4_bible_verses.all", "description": "The bibles being returned", "properties": { "data": { "properties": { "meta": { "$ref": "#/components/schemas/pagination" } }, "type": "array", "items": { "properties": { "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_sequence" }, "verse_end": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" }, "verse_sequence": { "$ref": "#/components/schemas/BibleFile/properties/verse_sequence" }, "verse_start_alt": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "chapter": { "$ref": "#/components/schemas/BibleVerse/properties/chapter" }, "book_id": { "$ref": "#/components/schemas/BibleVerse/properties/book_id" }, "language_id": { "$ref": "#/components/schemas/Language/properties/id" }, "bible_id": { "$ref": "#/components/schemas/Bible/properties/id" }, "verse_text": { "$ref": "#/components/schemas/BibleVerse/properties/verse_text" }, "fileset_id": { "$ref": "#/components/schemas/Language/properties/iso" }, "fileset_set_type_code": { "$ref": "#/components/schemas/Bible/properties/date" }, "bible_filesets": { "$ref": "#/components/schemas/BibleFileset" } }, "type": "object" } } }, "type": "object", "xml": { "name": "v4_bible_verses.all" } }, "v4_bible.books": { "title": "v4_bible.books", "description": "The books of the bible with codes", "properties": { "data": { "type": "array", "items": { "properties": { "book_id": { "$ref": "#/components/schemas/Book/properties/id" }, "book_id_usfx": { "$ref": "#/components/schemas/Book/properties/id_usfx" }, "book_id_osis": { "$ref": "#/components/schemas/Book/properties/id_osis" }, "name": { "$ref": "#/components/schemas/Book/properties/name" }, "testament": { "$ref": "#/components/schemas/Book/properties/book_testament" }, "testament_order": { "$ref": "#/components/schemas/Book/properties/testament_order" }, "book_order": { "$ref": "#/components/schemas/Book/properties/protestant_order" }, "book_group": { "$ref": "#/components/schemas/Book/properties/book_group" }, "chapters": { "$ref": "#/components/schemas/Book/properties/chapters" } }, "type": "object" } } }, "type": "object", "xml": { "name": "v4_bible.books" } }, "v4_countries.one": { "title": "v4_countries.one", "description": "The minimized country return for the all countries route", "properties": { "data": { "properties": { "name": { "$ref": "#/components/schemas/Country/properties/name" }, "continent_code": { "$ref": "#/components/schemas/Country/properties/continent" }, "languages": {} }, "type": "object" } }, "type": "object", "xml": { "name": "v4_countries.one" } }, "v4_countries.all": { "title": "v4_countries.all", "description": "The minimized country return for the all countries route", "properties": { "data": { "type": "array", "items": { "properties": { "name": { "$ref": "#/components/schemas/Country/properties/name" }, "continent_code": { "$ref": "#/components/schemas/Country/properties/continent" }, "languages": {} }, "type": "object" } } }, "type": "object", "xml": { "name": "v4_countries.all" } }, "v4_bible_filesets.show": { "title": "v4_bible_filesets.show", "description": "The minimized alphabet return for the all alphabets route", "properties": { "data": { "type": "array", "items": { "properties": { "book_id": { "$ref": "#/components/schemas/BibleFile/properties/book_id" }, "book_name": { "$ref": "#/components/schemas/BookTranslation/properties/name" }, "chapter_start": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "chapter_end": { "$ref": "#/components/schemas/BibleFile/properties/chapter_end" }, "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_start_alt": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_end": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" }, "verse_end_alt": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" }, "thumbnail": { "description": "The image url", "type": "string", "maxLength": 191 }, "timestamp": { "$ref": "#/components/schemas/BibleFileTimestamp/properties/timestamp" }, "path": { "$ref": "#/components/schemas/BibleFile/properties/file_name" }, "duration": { "$ref": "#/components/schemas/BibleFile/properties/duration" } }, "type": "object" } } }, "type": "object", "xml": { "name": "v4_bible_filesets.show" } }, "v2_text_verse": { "title": "v2_text_verse", "description": "The bible Search Group Response", "type": "array", "items": { "properties": { "book_name": { "$ref": "#/components/schemas/Book/properties/name" }, "book_id": { "$ref": "#/components/schemas/Book/properties/name" }, "book_order": { "$ref": "#/components/schemas/Book/properties/protestant_order" }, "chapter_id": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "chapter_title": { "type": "string", "example": "Chapter 1" }, "verse_id": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_text": { "$ref": "#/components/schemas/BibleFile/properties/verse_text" }, "paragraph_number": { "type": "string", "example": "2" } }, "type": "object" }, "xml": { "name": "v2_text_verse" } }, "v4_bible_filesets_chapter": { "title": "v4_bible_filesets_chapter", "description": "The bible chapter response", "properties": { "data": { "type": "array", "items": { "properties": { "book_id": { "$ref": "#/components/schemas/Book/properties/id" }, "book_name": { "$ref": "#/components/schemas/Book/properties/name" }, "book_name_alt": { "$ref": "#/components/schemas/BookTranslation/properties/name" }, "chapter": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "chapter_alt": { "$ref": "#/components/schemas/BibleFile/properties/chapter_start" }, "verse_start": { "$ref": "#/components/schemas/BibleFile/properties/verse_sequence" }, "verse_start_alt": { "$ref": "#/components/schemas/BibleFile/properties/verse_start" }, "verse_end": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" }, "verse_end_alt": { "$ref": "#/components/schemas/BibleFile/properties/verse_end" }, "verse_text": { "type": "string" } }, "type": "object" } } }, "type": "object", "xml": { "name": "v4_bible_filesets_chapter" } }, "v4_note": { "properties": { "id": { "$ref": "#/components/schemas/Note/properties/id" }, "bible_id": { "$ref": "#/components/schemas/Note/properties/bible_id" }, "book_id": { "$ref": "#/components/schemas/Note/properties/book_id" }, "book_name": { "$ref": "#/components/schemas/BibleBook/properties/name" }, "chapter": { "$ref": "#/components/schemas/Note/properties/chapter" }, "verse_start": { "$ref": "#/components/schemas/Note/properties/verse_start" }, "verse_start_alt": { "$ref": "#/components/schemas/Note/properties/verse_start" }, "verse_end": { "$ref": "#/components/schemas/Note/properties/verse_end" }, "verse_end_alt": { "$ref": "#/components/schemas/Note/properties/verse_end" }, "verse_text": { "$ref": "#/components/schemas/BibleFile/properties/verse_text" }, "notes": { "$ref": "#/components/schemas/Note/properties/notes" }, "created_at": { "$ref": "#/components/schemas/Note/properties/created_at" }, "updated_at": { "$ref": "#/components/schemas/Note/properties/updated_at" }, "bible_name": { "$ref": "#/components/schemas/Note/properties/bible_name" }, "tags": { "$ref": "#/components/schemas/AnnotationTag" } }, "type": "object" } }, "responses": { "plan": { "description": "Plan Object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_plan_detail" } } } }, "playlist": { "description": "Playlist Object", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/v4_playlist_detail" } } } }, "v4_languages.one": { "description": "The Full alphabet return for the single alphabet route", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Language" } } } }, "v4_languages.all": { "description": "The minimized language return for the single language route", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Language" } } } } }, "parameters": { "version_number": { "name": "v", "in": "query", "description": "The Version Number", "required": true, "schema": { "type": "integer", "enum": [ 4, 2 ], "example": 4 } }, "key": { "name": "key", "in": "query", "description": "The key granted to the API developer upon sign up", "required": true, "schema": { "type": "string", "example": "f4cdf23a-22c3-66c9-cc4f-05dc711b41c6" } }, "limit": { "name": "limit", "in": "query", "description": "The number of search results to return", "schema": { "type": "integer", "default": 25 } }, "page": { "name": "page", "in": "query", "description": "The current page of the results", "schema": { "type": "integer", "default": 1 } }, "sort_by": { "name": "sort_by", "in": "query", "description": "The field to sort by", "schema": { "type": "string" } }, "sort_dir": { "name": "sort_dir", "in": "query", "description": "The direction to sort by", "schema": { "type": "string", "enum": [ "asc", "desc" ] } }, "l10n": { "name": "l10n", "in": "query", "description": "When set to a valid three letter language iso, the returning results will be localized in the language matching that iso. (If an applicable translation exists). For a complete list see the `iso` field in the `/languages` route", "schema": { "$ref": "#/components/schemas/Language/properties/iso" } } }, "requestBodies": { "ProjectStore": { "description": "Information supplied for project creation/update", "required": true, "content": { "application/json": { "schema": { "properties": { "name": { "$ref": "#/components/schemas/Project/properties/name" }, "url_avatar": { "$ref": "#/components/schemas/Project/properties/url_avatar" }, "url_avatar_icon": { "$ref": "#/components/schemas/Project/properties/url_avatar_icon" }, "url_site": { "$ref": "#/components/schemas/Project/properties/url_site" }, "description": { "$ref": "#/components/schemas/Project/properties/description" } }, "type": "object" } } } }, "PlaylistItems": { "description": "Fields for Playlist item creation", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "fileset_id": { "$ref": "#/components/schemas/PlaylistItems/properties/fileset_id" }, "book_id": { "$ref": "#/components/schemas/PlaylistItems/properties/book_id" }, "chapter_start": { "$ref": "#/components/schemas/PlaylistItems/properties/chapter_start" }, "chapter_end": { "$ref": "#/components/schemas/PlaylistItems/properties/chapter_end" }, "verse_start": { "$ref": "#/components/schemas/PlaylistItems/properties/verse_start" }, "verse_end": { "$ref": "#/components/schemas/PlaylistItems/properties/verse_end" } }, "type": "object" } } } } } }, "securitySchemes": { "dbp_key": { "type": "apiKey", "description": "The key granted to the API developer upon sign up", "name": "key", "in": "query" }, "dbp_user_token": { "type": "apiKey", "description": "The token granted to an authenticated end user upon login", "name": "api_token", "in": "query" } } }, "security": [ { "dbp_key": [] } ], "tags": [ { "name": "Languages", "description": "v4 Routes for obtaining Languages Data", "externalDocs": { "description": "For more info please refer to the Ethnologue Registration Authority", "url": "https://www.iso.org/iso-639-language-codes.html" } }, { "name": "Countries", "description": "v4 Routes for obtaining Countries Data", "externalDocs": { "description": "For more info please refer to the Iso Registration Authority", "url": "https://www.iso.org/iso-3166-country-codes.html" } }, { "name": "Bibles", "description": "v4 Routes for obtaining Bibles Data" }, { "name": "Audio Timing", "description": "v4 Routes for obtaining Audio timing information. This data could be used to search audio bibles for a specific term, make karaoke verse & audio readings, or to jump to a specific location in an audio file." } ], "externalDocs": { "description": "find more info here", "url": "https://www.biblebrain.com" } }