Sign in

v1

latestOpenAPI 3.0.02026-07-24226294602.4 KB
Client Progression

Create Client Progression

Enroll a client in a Progression.

post/progressions/client-progressions

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

client_idinteger

Client's Id

progression_idinteger

Progression to enroll client to

level_idinteger

level of client

achieved_on_datetimestring date-time

The date and time that the Client attained this Level

Example request

{
  "client_id": 1234567891234567,
  "progression_id": 1234567891234567,
  "level_id": 1234567891234567,
  "achieved_on_datetime": "2014-12-31T23:59:59.938Z"
}

Response

full Client Progression created

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

{
  "client_progression": {
    "id": 1234567891234567,
    "progression_id": 1234567891234567,
    "client_id": 1234567891234567,
    "level_id": 1234567891234567,
    "achieved_on_datetime": "2014-12-31T23:59:59.938Z",
    "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"
    },
    "client_criteria": [
      {
        "id": 1234567891234567,
        "criteria_id": 1234567891234567,
        "completed_on_date": "2014-12-31",
        "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"
        }
      }
    ]
  }
}