Skip to content

Glossary API

Blair Learn edited this page Nov 26, 2019 · 4 revisions

Glossary API

Controller methods

TermController

getById(dictionary , audience, language, id, requestedFields=['TermName', 'Pronunciation', 'Definition']) : GlossaryTerm

Retrieves a single GlossaryTerm object, based on the unique combination of dictionary, audience, language and term ID.

  • dictionary: String - Which dictionary to get the term from. Valid values are "Cancer.Gov" for the Dictionary of Cancer Terms or "genetics" for the Dictionary of Genetics Terms. Required

  • audience: String - Which audience version of the term to use. Valid values are "patient" and "healthProfessional". Required

    Note: The online Dictionary of Cancer Terms only displays patient definitions. The online Dictionary of Genetics Terms only displays health professional definitions.

  • language: String - The language of the desired definition. Valid values are "en" (English) and "es" (Spanish). Required

  • id: int - The numeric ID of the specific term to load. Required

  • requestedFields: String[] - List of names of the specific fields to return. If not specified, the TermName, Pronunciation, and Definition fields will be returned. Optional

TermsController

Clone this wiki locally