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

Version 1 Next »

You can use the API to post a story that tags progress for only one contact at a time.

API Documentation

See the Example of how to post a single-contact story for details of the API call and response.

Overview

There are two APIs for posting a story. Choose the API that suits your scenario.

API

Story about zero contacts

Story about only one contact

Story about one or more cases of one contact

Story about multiple contacts

Story with anonymous progress (i.e. progress is not tagged to a contact)

Post a Zero-or-Multiple-Contacts Story API

Yes

Yes

No

Yes

Yes

Post a Single-Contact Story

No

Yes

Yes

No

No

If your story is about one or more cases, you should use the Single-Contact Story API

Introduction

  • Stories are the main content format on Makerble

  • Every story has a single story category. (The story category contains the current fields (i.e. Survey Questions) that appear on the Create Story page)

  • Stories can contain

    • text

    • media (e.g. image, video, audio, document attachments)

    • progress towards Changes and Indicators; and that progress can optionally be tagged to individual beneficiaries (called contacts in the front-end)

  • Every story must belong to a single project

  • Every story must have a single author who is a user

Front-end Documentation

Logic

Component

Description

Beneficiary

  • Use this API to create a single story that contains progress relating to only one beneficiary

Story Category

  • Every story is created using a single Story Category.

  • The story category contains the fields that are used to create the story. A story Category can contain one or more of the following:

    • quantitative fields:

      • Activity Change (These are numerical fields but are not linked to an outcome)

      • Participation Change (These are also numerical fields but are not linked to an outcome)

      • Binary Indicator (used for tickbox fields that are linked to an outcome).

      • Scale Indicator (used for multiple choice fields)

      • Value Indicator (used for numerical fields linked to an outcome)

    • qualitative fields and other fields

      • Text fields

      • Date fields

      • Time fields

      • File Attachment

      • User who wrote the story

      • Time & Date story was created

      • Privacy setting of the story

      • Location (The longitude and latitude coordinates of the story)

      • Event ID: this should only be used when the story is related to a specific event record. (How events work in the front end)

      • The ‘date happened’ field that allows you to backdate a story

Story Changes attributes

  • The number for a Participation Change must always be '1'

Story Indicator Beneficiary

  • When you use the API to post a story that contains progress in the indicator format tagged to individual beneficiaries you must submit two types of information

    • Story Indicator Beneficiary data: these records contain the progress towards a single indicator for a single beneficiary in this single story

    • Story Indicator data: this is the total number of individual beneficiaries and anonymous participants that have progress towards this indicator

    • The number of Anonymous Participants is calculated by the server and is simply the Story Indicator value minus the number of Story Indicator Beneficiary records

 

Story Indicator

  • When you use the API to post a story that contains progress in the indicator format tagged to individual beneficiaries you must submit two types of information

    • Story Indicator Beneficiary data: these records contain the progress towards a single indicator for a single beneficiary in this single story

    • Story Indicator data: this is the total number of individual beneficiaries and anonymous participants that have progress towards this indicator

    • The number of Anonymous Participants is calculated by the server and is simply the Story Indicator value minus the number of Story Indicator Beneficiary records

  • No labels