Get all Story Categories API

Get all Story Categories API

You can use the API to get all the story categories which are viewable by the requesting user.

API Documentation

  • Endpoint: GET /api/v2/story_categories?page=2&per_page=2

  • Authentication: Requires valid authentication token

  • Response format: JSON

  • Query Parameters:

    • page (integer, optional): The page number for pagination (default is 1).

    • per_page (integer, optional): The number of choices per page (default is 10).

Response Attributes

  • page (integer): The current page number.

  • page_size (integer): The number of choices per page.

  • page_count (integer): The total number of pages.

  • total_count (integer): The total number of scale indicator choices.

  • data (array of objects): List of scale indicator choices.

    • id (integer): The unique identifier for the choice.

    • resource_choice_id (integer): The ID of the associated resource choice.

    • resource_choice_type (string): The type of resource choice (e.g., "StoryCategory").

    • indicator_id (integer): The ID of the associated scale indicator.

    • choice (string): The type of choice (e.g., "single_choice").

    • choice_value (string): The value associated with the choice.

    • updated_at (string, ISO 8601 datetime): The timestamp when the choice was last updated.

    • created_at (string, ISO 8601 datetime): The timestamp when the choice was created.

    • verdict_data

      • verdict (array of objects): Each verdict represents an interpretation for a score range.

        • from (integer): The starting number in the score range

        • to (integer): The ending number in the score range.

        • text (string): The explanatory text associated with the score range.

      • indicators (array of objects): List of indicators (only of type scale) associated with this story category.

        • name (string): The name of the indicator.

        • levels (array of objects): A breakdown of the indicator into sub-levels (sub-ratios), each with an associated score.

          • name (string): The name of the sub-ratio (indicator level).

          • points (integer): The score associated with this level

 

Example

GET https://makerble.com/api/v2/story_categories?page=2&per_page=2

Response

{ "page": 2, "page_size": 2, "page_count": 2897, "total_count": 5794, "data": [ { "id": 3, "resource_choice_id": 1382, "resource_choice_type": "StoryCategory", "indicator_id": 2676, "choice": "single_choice", "choice_value": "", "updated_at": "2020-06-26T18:47:14.068+01:00", "created_at": "2020-04-21T14:14:17.817+01:00" }, { "id": 4, "resource_choice_id": 1382, "resource_choice_type": "StoryCategory", "indicator_id": 2677, "choice": "single_choice", "choice_value": "", "updated_at": "2020-06-26T18:47:14.074+01:00", "created_at": "2020-04-21T14:14:17.817+01:00", "verdict_data": { "verdict": [ { "from": 0, "to": 4, "text": "None-minimal Depression" }, { "from": 5, "to": 9, "text": "Mild Depression" }, { "from": 10, "to": 14, "text": "Moderate Depression" } ], "indicators": [ { "name": "Having little interest or pleasure in doing things", "levels": [ { "name": "Not at all", "points": 0 }, { "name": "Several days", "points": 1 }, { "name": "More than half the days", "points": 2 }, { "name": "Nearly every day", "points": 3 } ] }, { "name": "Feeling down, depressed, or hopeless", "levels": [ { "name": "Not at all", "points": 0 }, { "name": "Several days", "points": 1 }, { "name": "More than half the days", "points": 2 }, { "name": "Nearly every day", "points": 3 } ] } ] } } ] }