LDSTechForumProjects

LDS Music Content API - Item Object

The Item object has the following properties in version 9 of the LDS Music Content API.

See also the LDS Music Content API - Collection Object.

adapterIndexes

array of indexes into the "people" array in this item's collection indicating which people are adapters of this item

arrangerIndexes

array of indexes into the "people" array in this item's collection indicating which people are arrangers of this item

authorIndexes

array of indexes into the "people" array in this item's collection indicating which people are authors of this item

composerIndexes

array of indexes into the "people" array in this item's collection indicating which people are composers of this item

counterparts

dictionary of counterpart objects related to this item

instrumentalMP3

URL information (url, modified date, and size of file) for the Instrumental MP3 for this item.

instrumentalMP3LowBandwidth

Same content from the "instrumentalMP3" link, compressed to 64Kbps

mobilePDF

URL information (url, modified date, and size of file) for the mobilePDF for this item. Also includes first_page and last_page indices to indicate what pages of the linked PDF are relevant to this item. The "mobile" pdf is unique in that all the songs for a collection are listed in the same PDF file to save space (since the fonts don't have to be listed multiple times) and its margins are cropped so that it can easily display nicely on the entire mobile device screen. Whenever an item spans multiple pages, any partial pages are cropped so that they only contain the sections relevant to this item. This guarantees that no two items will share any single page in this PDF. In other words, only content related to this item will be found in the referenced pages of this PDF.

singlePDF

URL information (url, modified date, and size of file) for the singlePDF for this item. The singlePDF file is a single file that only contains this particular item. It is formatted for printing as it should be a replica of what a literal digital copy of the book would be.

vocalMP3

URL information (url, modified date, and size of file) for the Vocal MP3 for this item.

vocalMP3LowBandwidth

Same content from the "vocalMP3" link, compressed to 64Kbps

credit

(string) the credits text from the bottom of the sheet music, with HTML formatting

firstLine

(string) if the first line of the item's text differs from its title then this "firstLine" parameter will exist and its value will be what the first line of the item text is.

id

(string) IMPORTANT FIELD this is what we sometimes refer to as the "external-id" basically this string uniquely identifies this item. It has a three part structure "Hymns-EN-1" indicating the collection, language, and item identifier within the collection. The item identifier within the collection will be page numbers for published books, but will be longer strings for collections that are continuously published (songs from the liahona for example). You can certainly use a locally unique identifier within your app to identify the item (like the SQL auto incrementing index number), but you will need to use this external-id when trying to communicate this particular item to other apps or systems.

hiltonc: Just FYI, the "external" in "external ID" refers to the fact that it is the ID used on the CDN, or externally from the app. The database within the app also has an "ID", which is an internal value that can be different between two user's installation of the app, due to when it was installed and which content updates were applied. "External ID" has no other intended meaning.

mood

(string) mood text as indicated on the sheet music "Cheerfully", etc.

name

title of the given item (string)

number

(STRING!) number representing the page number of the given item. Needs to be a string to handle cases where multiple items fit on a page (i.e. 27a, 27b, etc)

relatedID

the external ID of the item that this item is a translation of, or if this is an original, this will contain this item's own external ID. details, this used to be referred to as the "translationID" but has changed to "relatedID" as it can encompass more relations that just strict translations.

sectionIndex

(integer) index into the section array indicating which section this item belongs to

topicIndexes

array of indexes into the "topics" array in this item's collection indicating which topics apply to this item

translatorIndexes

array of indexes into the "people" array in this item's collection indicating which people are translators of this item

uri

The "Uniform Resource Identifier" for this item. This will be used when linking to Gospel Library. And is usually the same value for items in different languages that are just strict translations of one another. When linking to Gospel Library the url called will need to include a language parameter to indicate the language you wish Gospel Library to open

verses

array of verse objects. each block object has a type (verse, chorus, other) and corresponding text. chorus blocks are repeated in between verses when present. Essentially display these blocks of text in order and you can apply formatting based on their type.

If a verse is listed below the printed sheet music, it will have an indication by having the "extra" field set to True on the Verse object

hiltonc: I'd like to see this changed into a single HTML string at some point... structuring this content as I did was kinda ridiculous but I didn't realize it.

This page was last modified on 14 April 2014, at 21:30.

Note: Content found in this wiki may not always reflect official Church information. See Terms of Use.