Request Parameters

Bible Request Parameter definitions for each type of method in the Bible Service.

used for getBibles()

Kind: global typedef Properties

Name	Type	Description
language	`string`	ISO 639-3 three digit language code used to filter results
abbreviation	`string`	Bible abbreviation to search for
name	`string`	Bible name to search for
ids	`Array.<string>`	Comma separated list of Bible Ids to return

used for .getBooks()

Kind: global typedef Properties

Name	Type	Default	Description
id	`string`		id of the Bible whose book to fetch
[includeChapters]	`boolean`	`false`	An array of chapter summaries should be in the results.
[includeChaptersAndSections]	`boolean`	`false`	Arrays of chapter summaries and sections should be in the results

use for getBook()

Kind: global typedef Properties

Name	Type	Default	Description
id	`string`		id of the Bible whose book to fetch
bookId	`string`		id of the book to fetch (e.g. GEN)
[includeChapters]	`boolean`	`false`	Array of chapter summaries should be in the results.

use for getChaptersFromBook()

Kind: global typedef Properties

Name	Type	Default	Description
id	`string`		id of the Bible whose book to fetch
chapterId	`string`		id of the chapter to fetch (e.g. GEN.1)
[includeChapters]	`boolean`	`false`	An array of chapter summaries should be in the results.

use for getChapter()

Kind: global typedef Properties

Name	Type	Default	Description
id	`string`		id of the Bible whose book to fetch
chapterId	`string`		id of the chapter to fetch (e.g. GEN.1)
[contentType]	`string`		html, json, text
[includeNotes]	`boolean`		include footnotes in content
[includeTitles]	`boolean`		include footnotes in content
[includeChapterNumbers]	`boolean`		include chapter numbers in content
[includeVerseNumbers]	`boolean`		include verse numbers in content
[includeVerseSpans]	`boolean`		include spans that wrap verse numbers and verse text for bible content
[parallels]	`Array.<string>`		comma separated list of bibleIds
[includeChapters]	`boolean`	`false`	Boolean indicating if an array of chapter summaries should be in the results.

use for getPassage()

Kind: global typedef Properties

Name	Type	Default	Description
id	`string`		id of the Bible whose book to fetch
passageId	`string`		id of the passage to fetch (e.g. GEN.1.1-GEN.2.20)
[contentType]	`string`	`"html"`	html, json, text
[includeNotes]	`boolean`		include footnotes in content
[includeTitles]	`boolean`	`true`	include footnotes in content
[includeChapterNumbers]	`boolean`	`false`	include chapter numbers in content
[includeVerseNumbers]	`boolean`	`false`	include verse numbers in content
[includeVerseSpans]	`boolean`	`false`	include spans that wrap verse numbers and verse text for bible content
[parallels]	`Array.<string>`		comma separated list of bibleIds
[useOrgId]	`boolean`	`false`	Use the supplied id(s) to match the verseOrgId instead of verseId.

use for getVerse()

Kind: global typedef Properties

Name	Type	Default	Description
id	`string`		id of the Bible whose book to fetch
verseId	`string`		id of the verse to fetch (e.g. GEN.1.1)
[contentType]	`string`	`"html"`	html, json, text
[includeNotes]	`boolean`		include footnotes in content
[includeTitles]	`boolean`	`true`	include footnotes in content
[includeChapterNumbers]	`boolean`	`false`	include chapter numbers in content
[includeVerseNumbers]	`boolean`	`false`	include verse numbers in content
[includeVerseSpans]	`boolean`	`false`	include spans that wrap verse numbers and verse text for bible content
[parallels]	`Array.<string>`		comma separated list of bibleIds
[useOrgId]	`boolean`	`false`	Use the supplied id(s) to match the verseOrgId instead of verseId.
previous	`object`	verse number and ID of the previous verse in the book