Story Categories
Desc: Get all story categories
Latest changes: now includes scale indicator choices and current fields (not merged)
url: /story_categories
params: default params
response example: default response example (multiple records)
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.
Example
GET https://makerble.com/api/v2/story_categories?page=2&per_page=2
Response
Code Block |
---|
{
"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"
}
]
} |