Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Current »

API Documentation

Story Indicator Beneficiary

Desc: Get all story indicator beneficiaries

url: /story_indicator_beneficiaries

params: default params

additional params:

story_id: 123 (default null)

response example: default response example (multiple records)


What is a Story Indicator Beneficiary record?

  • There are three ways to associate a beneficiary with a story

    • Tagging the beneficiary directly in the story; this creates a Story Beneficiary record

    • Tagging the beneficiary to progress towards an Indicator (metric), this creates a Story_Indicator_Beneficiary record.

      • For example when logging that a beneficiary’s answer to a multiple choice question (Scale Indicator) was “Strongly Disagree” on a five point scale where the other Sub Ratios in the Ratio Set were

        • Strongly Disagree

        • Disagree

        • No Opinion

        • Agree [described below]

        • Strongly Agree

Rules

  • Story Change Beneficiary data can only apply to a Participation Change, not an Activity Change

  • One of the restrictions with Activity Change is that beneficiaries cannot be tagged in Story Change Beneficiary data for an Activity Change

Explanation

Example from the front-end

  • The Orange Box describes the Story Indicator data and within that there are FIVE story indicator beneficiary records that are created

  • Watch the explanation video: https://www.loom.com/share/642b80b9abd84d2e8d04e1a22269c76d

  • Screenshot of 1 of the 5 story indicator beneficiary records in the Admin Panel that were created when this story was made

Related articles

  • No labels