Introduction

• Every sub ratio belongs to at least one Ratio Set

• In practice, due to the design of the front-end, a Sub Ratio normally only belongs to a single Ratio Set

Get Started

Sub Ratio

Desc: Get all sub ratios

url: /sub_ratios

params: default params:
header: {'X-User-Token': 'Ppteex1dWbEcnNC311NFOrJqNHP98zN2ccMpWEei--ixL50J7uZsnprbOu--WbOcz50zaS48JzyXXZHS9A==',
'X-User-Email': ‘soft.dave99@gmail.com’}
Optional Params {ratio_set_ids => [11]}

response example: default response example (multiple records)

Image Added

The Priority determines the order in which each sub ratio should be displayed when listed on a form.

The default criteria is the optional description text that can be displayed for that sub ratio when the ratio set is part of a scale indicator and used in a survey.

The default points applies to when a ratio set is used as part of a scale indicator within a survey. Those points can be used to calculate verdicts.

Desc: Get a single sub ratio

...

• Endpoint: GET /api/v2/sub_ratios/:id

• Authentication: Requires valid authentication token

• Response Format: JSON

• Query Parameter

  • id (integer): The unique identifier for the sub_ratio

Response Attributes

• id (integer): The unique identifier for the sub-ratio.

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

• ratio_set_id

...

• (integer): The ID of the ratio set to which this sub-ratio belongs.

• default_criteria (string): The default criteria for the sub-ratio.

• default_points (numeric): The default points for the sub-ratio (nullable).

• priority (integer): The priority of the sub-ratio.

• updated_at (string): Timestamp of last update.

• created_at (string): Timestamp of creation.