Skip to content

Response Types

Paceaux edited this page Jul 2, 2021 · 1 revision

Responses the bibleService can return

BibleResponse
BookResponse
ChapterSummaryResponse
ChapterResponse
VerseSummaryResponse
PassageResponse
VerseResponse

BibleResponse

Kind: global typedef Properties

Name Type Description
id string unique identifier of the bible
dblId string not sure. Similar to id, but without trailing -01
abbreviation string 3-letter common abbreviation (e.g. ASV, KJV, NIV)
abbreviationLocal string localized abbreviation
copyright string copyright notice
language object ISO language
countries Array.<object> countries bible was published for
name string name of bible
nameLocal string localized (translated) name
description string Summary of the bible
descriptionLocal string localized (Translated) summary
info string metadata
type string kind of bible
updatedAt Date last time content was updated
relatedDbl string not sure
audioBibles Array.<object> audio versions of this bible

BookResponse

Kind: global typedef Properties

Name Type Description
id string 3-letter identifier of the book
bibleId string id of the bible
abbreviation string user readable abbreviation
name string name of the book
nameLong string extended name
chapters Array.<ChapterSummaryResponse> Small details of the chapters within the book

ChapterSummaryResponse

Kind: global typedef Properties

Name Type Description
id string 3-letter identifier for book and integer (e.g. GEN.1)
bibleId string id of the containing bible
number string integer; chapter number
bookId string 3-letter identifier for book
content string text
reference string reader friendly version (e.g. Genesis 1)

ChapterResponse

Kind: global typedef Properties

Name Type Description
id string 3-letter identifier for book and integer (e.g. GEN.1)
bibleId string id of the containing bible
number string integer; chapter number
bookId string 3-letter identifier for book
content string text
reference string reader friendly version (e.g. Genesis 1)
verseCount number quantity of verses
copyright string copyright information
next object chapter number and ID of the next chapter in the book
previous object chapter number and ID of the previous chapter in the book

VerseSummaryResponse

Kind: global typedef Properties

Name Type Description
id string 3-letter identifier for book and integer (e.g. GEN.1.1)
bibleId string id of the containing bible
bookId string 3-letter identifier for book
chapterId string 3-letter book name with chapter number (e.g. GEN.1)
orgId string no idea
reference string reader friendly version (e.g. Genesis 1.1)

PassageResponse

Kind: global typedef Properties

Name Type Description
id string 3-letter identifier for book and integer (e.g. GEN.1.1-GEN.2.1)
bibleId string id of the containing bible
orgId string no idea
reference string reader friendly version (e.g. Genesis 1:1-21)
content string text content
verseCount number quantity of verses
copyright string copyright information

VerseResponse

Kind: global typedef Properties

Name Type Description
id string 3-letter identifier for book and integer (e.g. GEN.1)
bibleId string id of the containing bible
bookId string 3-letter identifier for book
chapterId string 3-letter book name with chapter number (e.g. GEN.1)
orgId string no idea
content string text content
reference string reader friendly version (e.g. Genesis 1:1)
verseCount number quantity of verses
copyright string copyright information
next object verse number and ID of the next verse in the book
previous object verse number and ID of the previous verse in the book
previous object verse number and ID of the previous verse in the book