Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Level

Create Level

Add a Level to a Progression.

post/progressions/{progression_id}/levels/

Path parameters

progression_idinteger required

progression id

Headers

x-api-keystring required

A valid API key. If you don't have one, please request one through the Web Integrations screen.

Request body

orderinteger

The sequence of the Levels within the Progression

levelstring required

Name of the Level

descriptionstring

Description or details for Level

level_view_type_idinteger

ID for LevelVisualType static entity - defines the visual represenation of the Level

level_color_primarystring

Hex color code for Color/Stripe Level Visual Type

level_color_secondarystring

Secondary hex color code for Color/Stripe Level Visual Type

stripe_option_idinteger

ID for StripeOption static entity. Used with Color/Stripe LevelVisualTypes

stripe_colorstring

Hex color code for stripe in Color/Stripe LevelVisualType

is_auto_promotionboolean

Boolean to denote if Level has Auto-Promotion turned on. If true, any eligible client will be automatically promoted to the next level. If false, admin has to manually update client to the next level

certificate_eligibleboolean

Is the level eligible for a certificate

Example request

{
  "level_accessible_programs": [
    {
      "program_id": 1234567891234567
    }
  ],
  "criteria": [
    {
      "criteria_attendance_programs": [
        1234567891234567
      ]
    }
  ]
}

Response

Data of the created Level

progression_idinteger

Progression Id

progressionstring

progression name

wodify_validation_resultstring

The purpose of this attribute is to save any UserException message, that is, and user friendly message that should be shown to the end user.

Example response

{
  "progression_id": 1234567891234567,
  "level": {
    "id": 1234567891234567,
    "created": {
      "created_by_id": 1234567891234567,
      "created_on_datetime": "2014-12-31T23:59:59.938Z"
    },
    "updated": {
      "updated_by_id": 1234567891234567,
      "updated_on_datetime": "2014-12-31T23:59:59.938Z"
    },
    "criteria": [
      {
        "id": 1234567891234567,
        "created": {
          "created_by_id": 1234567891234567,
          "created_on_datetime": "2014-12-31T23:59:59.938Z"
        },
        "updated": {
          "updated_by_id": 1234567891234567,
          "updated_on_datetime": "2014-12-31T23:59:59.938Z"
        }
      }
    ],
    "level_accessible_programs": [
      {
        "program_id": 1234567891234567
      }
    ]
  }
}