• In progress

    • Learning to Breathe Plus API

    Owned by Derek Stegelman
    Last updated: May 08, 2023
    2 min read

    Overview

    Learning to Breathe Plus has a content API that provides an endpoint for fetching content stored within the Learning to Breathe Plus application.

    Usage

    Swagger and Open API

    The L2BPlus API has an interactive Swagger API page, as well as an Open API schema. This is where you’d find the most up to date information about the API.

    The API supports pagination and meta details about that are included in the top level object.

    Content Objects

    When you call the content API you’ll get a top level object with meta data regarding pagination and object count. Within that, there will be an items property with a collection of content objects. The current content object looks something like:

    { "items": [ { "name": "string", "description": "string", "articleContent": "string", "link": "string", "theme": "string", "mediaType": "string", "durationMinutes": "string", "surveyPromptDelay": 0, "publishDate": "2023-05-08T15:39:37.201Z" } ], "pageNumber": 0, "pageSize": 0, "firstPage": "string", "lastPage": "string", "totalPages": 0, "totalRecords": 0, "nextPage": "string", "previousPage": "string" }

    Object Property Explanations

    • Name → The title of the piece of content.

    • Link → The Media Link for the content. It is not required that a content object have this property.

    • Theme → The human readable name of the theme this content is associated with.

    • MediaType → The type of media this content object is. Options are Article, Audio, Video

    • DurationMinutes → This is a string representation which represents how much time a person has/should dedicate to the content. This is not stored and does not exist as a numerical value. Options for this value are:

      • 0 - 5 Minutes

      • 6 - 10 Minutes

      • 11+ Minutes

    • Description → Description of content

    • ArticleContent → Article content (not required)

    • SurveyPromptDelay → Time, in seconds, before the application prompts the user to fill out a survey on the content.

    • PublishDate → Date content was published