Qualified API Documentation

Base Path

All endpoints have a base path of https://www.qualified.io/api.

Authorization

Authorization is done by passing in an API key to the Authorization header. If your account is on a plan that allows API access then you will be able to find your key by going to Team Settings > Integrations within the Qualified app.

Note: The examples below may use a longer token string than the key you will find within your team account settings.

Note: Make sure to keep your API key safe. Do not expose it through client-side applications.

Parameters

There are a few special conventions used within our API in regards to our parameters:

Casing

Both camel and underscore casing is supported when sending data to the sever. The examples given will use underscore casing for consistency.

Includes

There is a special parameter called "includes", available on most model requests. This parameter will fetch additional relations related to each model and include them within the model's JSON response. For example if you are returning an assessment result and want to include the related solutions, you can include them within a single API call.


Assessment Briefs

Briefs are living report information. They are synced in the background after information related to a assessment is changed. You can consume this data to implement your own reporting tools.

List

Endpoint

GET /v1/assessment_briefs

Request

Route

GET /v1/assessment_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzdjYTU0ZDc1ZTJkYzFkMGU1ZCIsImlkIjoiNWVjNmQ3N2NhNTRkNzVlMmRjMWQwZTVlIiwic2VjcmV0IjoiWEdoUmd3PT0ifQ.HXHLIiRxX3LBzqGmgsBtpjah9mVv8YGGmBxWSYg9mbY

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentBrief",
  "data": [
    {
      "id": "5ec6d77ca54d75e2dc1d0e68",
      "createdAt": "2020-05-21T19:33:17.195Z",
      "updatedAt": "2020-05-21T19:33:17.336Z",
      "teamId": "5ec6d77ca54d75e2dc1d0e61",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-05-21T19:33:18.335Z",
      "syncs": 1,
      "title": "Mid-Level Back-End Developer #24",
      "labels": null,
      "state": "published",
      "enforcedTimeLimit": null,
      "suggestedEstimatedTime": 6,
      "manualEstimatedTime": null,
      "passingScore": 100,
      "demoData": false,
      "assessmentUpdatedAt": "2020-05-21T19:33:16.504Z",
      "challengesCount": 3,
      "solutionsCount": 12,
      "counts": {
        "total": 4,
        "abandoned": 0,
        "passed": 0,
        "states": {
          "started": 2,
          "submitted": 2
        },
        "closed_reasons": {
          "candidate_submitted": 2
        }
      },
      "assessmentInvitationCounts": {},
      "solutionRisks": {},
      "submissionRate": 50.0,
      "passRate": 0.0,
      "baselineStats": {
        "score": null,
        "accumulated_seconds": null,
        "accumulated_bg_seconds": null
      },
      "subjectStats": {
        "score": {
          "iqr": 0.0,
          "counts": {
            "total": 4,
            "min": 4,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 4,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 4
          },
          "outliers": [],
          "mean": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "std_dev": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "points": {
            "min": 0.0,
            "l_fence": 0.0,
            "q1": 0.0,
            "q2": 0.0,
            "q3": 0.0,
            "u_fence": 0.0,
            "max": 0.0
          }
        },
        "accumulated_seconds": {
          "iqr": 0.0,
          "counts": {
            "total": 4,
            "min": 4,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 4,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 4
          },
          "outliers": [],
          "mean": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "std_dev": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "points": {
            "min": 0,
            "l_fence": 0,
            "q1": 0.0,
            "q2": 0.0,
            "q3": 0.0,
            "u_fence": 0,
            "max": 0
          }
        },
        "accumulated_bg_seconds": {
          "iqr": 0.0,
          "counts": {
            "total": 4,
            "min": 4,
            "l_outliers": 0,
            "l_fence": 0,
            "min_q1": 0,
            "q1_q2": 0,
            "q2_q3": 0,
            "q3_max": 4,
            "u_fence": 0,
            "u_outliers": 0,
            "max": 4
          },
          "outliers": [],
          "mean": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "std_dev": {
            "value": 0.0,
            "trimmed": 0.0
          },
          "points": {
            "min": 0,
            "l_fence": 0,
            "q1": 0.0,
            "q2": 0.0,
            "q3": 0.0,
            "u_fence": 0,
            "max": 0
          }
        }
      },
      "publishedAt": "2020-05-21T19:33:16.426Z",
      "challengeStats": [
        {
          "id": "5ec6d77ca54d75e2dc1d0e69",
          "title": "Fibonacci Regex #38",
          "type": "CodeChallenge",
          "difficulty": 1,
          "totalCount": 4,
          "passedCount": 0,
          "viableCount": 0,
          "subjectStats": {
            "score": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0.0,
                "lFence": 0.0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0.0,
                "max": 0.0
              }
            },
            "accumulatedSeconds": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0,
                "lFence": 0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0,
                "max": 0
              }
            }
          }
        },
        {
          "id": "5ec6d77ca54d75e2dc1d0e6d",
          "title": "Sane Calculator #39",
          "type": "CodeChallenge",
          "difficulty": 1,
          "totalCount": 4,
          "passedCount": 0,
          "viableCount": 0,
          "subjectStats": {
            "score": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0.0,
                "lFence": 0.0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0.0,
                "max": 0.0
              }
            },
            "accumulatedSeconds": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0,
                "lFence": 0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0,
                "max": 0
              }
            }
          }
        },
        {
          "id": "5ec6d77ca54d75e2dc1d0e71",
          "title": "Functional Numbers #40",
          "type": "CodeChallenge",
          "difficulty": 1,
          "totalCount": 4,
          "passedCount": 0,
          "viableCount": 0,
          "subjectStats": {
            "score": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0.0,
                "lFence": 0.0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0.0,
                "max": 0.0
              }
            },
            "accumulatedSeconds": {
              "iqr": 0.0,
              "counts": {
                "total": 4,
                "min": 4,
                "lOutliers": 0,
                "lFence": 0,
                "minQ1": 0,
                "q1Q2": 0,
                "q2Q3": 0,
                "q3Max": 4,
                "uFence": 0,
                "uOutliers": 0,
                "max": 4
              },
              "outliers": [],
              "mean": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "stdDev": {
                "value": 0.0,
                "trimmed": 0.0
              },
              "points": {
                "min": 0,
                "lFence": 0,
                "q1": 0.0,
                "q2": 0.0,
                "q3": 0.0,
                "uFence": 0,
                "max": 0
              }
            }
          }
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:33:17.374-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_briefs/:id

Request

Route

GET /v1/assessment_briefs/5ec6d77da54d75e2dc1d0ea6

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzdkYTU0ZDc1ZTJkYzFkMGU5YiIsImlkIjoiNWVjNmQ3N2RhNTRkNzVlMmRjMWQwZTljIiwic2VjcmV0IjoieWhERVFBPT0ifQ.y5dlOTJS4pxpk7wZcDcfHIWErvHmNro1F-EMwTxGvSM

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d77da54d75e2dc1d0ea6",
  "type": "AssessmentBrief",
  "data": {
    "id": "5ec6d77da54d75e2dc1d0ea6",
    "createdAt": "2020-05-21T19:33:18.847Z",
    "updatedAt": "2020-05-21T19:33:18.995Z",
    "teamId": "5ec6d77da54d75e2dc1d0e9f",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-05-21T19:33:19.995Z",
    "syncs": 1,
    "title": "Mid-Level Database Developer #25",
    "labels": null,
    "state": "published",
    "enforcedTimeLimit": null,
    "suggestedEstimatedTime": 6,
    "manualEstimatedTime": null,
    "passingScore": 100,
    "demoData": false,
    "assessmentUpdatedAt": "2020-05-21T19:33:17.599Z",
    "challengesCount": 3,
    "solutionsCount": 18,
    "counts": {
      "total": 6,
      "abandoned": 0,
      "passed": 0,
      "states": {
        "submitted": 3,
        "started": 3
      },
      "closed_reasons": {
        "candidate_submitted": 3
      }
    },
    "assessmentInvitationCounts": {},
    "solutionRisks": {},
    "submissionRate": 50.0,
    "passRate": 0.0,
    "baselineStats": {
      "score": null,
      "accumulated_seconds": null,
      "accumulated_bg_seconds": null
    },
    "subjectStats": {
      "score": {
        "iqr": 0.0,
        "counts": {
          "total": 6,
          "min": 6,
          "l_outliers": 0,
          "l_fence": 0,
          "min_q1": 0,
          "q1_q2": 0,
          "q2_q3": 0,
          "q3_max": 6,
          "u_fence": 0,
          "u_outliers": 0,
          "max": 6
        },
        "outliers": [],
        "mean": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "std_dev": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "points": {
          "min": 0.0,
          "l_fence": 0.0,
          "q1": 0.0,
          "q2": 0.0,
          "q3": 0.0,
          "u_fence": 0.0,
          "max": 0.0
        }
      },
      "accumulated_seconds": {
        "iqr": 0.0,
        "counts": {
          "total": 6,
          "min": 6,
          "l_outliers": 0,
          "l_fence": 0,
          "min_q1": 0,
          "q1_q2": 0,
          "q2_q3": 0,
          "q3_max": 6,
          "u_fence": 0,
          "u_outliers": 0,
          "max": 6
        },
        "outliers": [],
        "mean": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "std_dev": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "points": {
          "min": 0,
          "l_fence": 0,
          "q1": 0.0,
          "q2": 0.0,
          "q3": 0.0,
          "u_fence": 0,
          "max": 0
        }
      },
      "accumulated_bg_seconds": {
        "iqr": 0.0,
        "counts": {
          "total": 6,
          "min": 6,
          "l_outliers": 0,
          "l_fence": 0,
          "min_q1": 0,
          "q1_q2": 0,
          "q2_q3": 0,
          "q3_max": 6,
          "u_fence": 0,
          "u_outliers": 0,
          "max": 6
        },
        "outliers": [],
        "mean": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "std_dev": {
          "value": 0.0,
          "trimmed": 0.0
        },
        "points": {
          "min": 0,
          "l_fence": 0,
          "q1": 0.0,
          "q2": 0.0,
          "q3": 0.0,
          "u_fence": 0,
          "max": 0
        }
      }
    },
    "publishedAt": "2020-05-21T19:33:17.561Z",
    "challengeStats": [
      {
        "id": "5ec6d77da54d75e2dc1d0ea7",
        "title": "Sequence System #41",
        "type": "CodeChallenge",
        "difficulty": 1,
        "totalCount": 6,
        "passedCount": 0,
        "viableCount": 0,
        "subjectStats": {
          "score": {
            "iqr": 0.0,
            "counts": {
              "total": 6,
              "min": 6,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 6,
              "uFence": 0,
              "uOutliers": 0,
              "max": 6
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0.0,
              "lFence": 0.0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0.0,
              "max": 0.0
            }
          },
          "accumulatedSeconds": {
            "iqr": 0.0,
            "counts": {
              "total": 6,
              "min": 6,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 6,
              "uFence": 0,
              "uOutliers": 0,
              "max": 6
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0,
              "lFence": 0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0,
              "max": 0
            }
          }
        }
      },
      {
        "id": "5ec6d77da54d75e2dc1d0eab",
        "title": "Large Algorithm #42",
        "type": "CodeChallenge",
        "difficulty": 1,
        "totalCount": 6,
        "passedCount": 0,
        "viableCount": 0,
        "subjectStats": {
          "score": {
            "iqr": 0.0,
            "counts": {
              "total": 6,
              "min": 6,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 6,
              "uFence": 0,
              "uOutliers": 0,
              "max": 6
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0.0,
              "lFence": 0.0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0.0,
              "max": 0.0
            }
          },
          "accumulatedSeconds": {
            "iqr": 0.0,
            "counts": {
              "total": 6,
              "min": 6,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 6,
              "uFence": 0,
              "uOutliers": 0,
              "max": 6
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0,
              "lFence": 0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0,
              "max": 0
            }
          }
        }
      },
      {
        "id": "5ec6d77da54d75e2dc1d0eaf",
        "title": "Sequential Sorting #43",
        "type": "CodeChallenge",
        "difficulty": 1,
        "totalCount": 6,
        "passedCount": 0,
        "viableCount": 0,
        "subjectStats": {
          "score": {
            "iqr": 0.0,
            "counts": {
              "total": 6,
              "min": 6,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 6,
              "uFence": 0,
              "uOutliers": 0,
              "max": 6
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0.0,
              "lFence": 0.0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0.0,
              "max": 0.0
            }
          },
          "accumulatedSeconds": {
            "iqr": 0.0,
            "counts": {
              "total": 6,
              "min": 6,
              "lOutliers": 0,
              "lFence": 0,
              "minQ1": 0,
              "q1Q2": 0,
              "q2Q3": 0,
              "q3Max": 6,
              "uFence": 0,
              "uOutliers": 0,
              "max": 6
            },
            "outliers": [],
            "mean": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "stdDev": {
              "value": 0.0,
              "trimmed": 0.0
            },
            "points": {
              "min": 0,
              "lFence": 0,
              "q1": 0.0,
              "q2": 0.0,
              "q3": 0.0,
              "uFence": 0,
              "max": 0
            }
          }
        }
      }
    ]
  },
  "meta": {
    "timestamp": "2020-05-21T12:33:19.023-07:00",
    "includes": []
  }
}

Assessment Challenge Items

Resources for viewing and configuring which challenges are associated to each assessment.

Create

This endpoint will pass a challenge id to a assessment and return a AssessmentChallengeItem record. If the challenge already exists for the assessment, a 409 will be returned. If a global challenge is passed, a copy of it will be created for the given team and that copy will be used instead.

Endpoint

POST /v1/assessments/:assessment_id/challenge_items/

Parameters

Name Description
assessment_id required base16 ObjectId
data.challenge_id required base16 ObjectId

Request

Route

POST /v1/assessments/5ec6d77fa54d75e2dc1d0ef3/challenge_items/

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzdmYTU0ZDc1ZTJkYzFkMGVmNCIsImlkIjoiNWVjNmQ3N2ZhNTRkNzVlMmRjMWQwZWY1Iiwic2VjcmV0IjoiMWxPY0ZnPT0ifQ.s9IFC_oKh0-LH4T0_EJmAV4a_ALyUk3JxY7GhcYfk9E

Body

{
  "data": {
    "challenge_id": "5ec6d77fa54d75e2dc1d0ef7"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d77fa54d75e2dc1d0efd",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5ec6d77fa54d75e2dc1d0efd",
    "challengeId": "5ec6d77fa54d75e2dc1d0ef7",
    "position": 1,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2020-05-21T12:33:19.347-07:00",
    "includes": []
  }
}

Update

This endpoint allows you to modify the position. When changing the position, all other items in the list will be adjusted to account for the item's new position.

Endpoint

PUT /v1/assessments/:assessment_id/challenge_items/:id

Parameters

Name Description
assessment_id required base16 ObjectId
id required base16 ObjectId
data.position Position of the item in the list.

Request

Route

PUT /v1/assessments/5ec6d77fa54d75e2dc1d0f06/challenge_items/5ec6d77fa54d75e2dc1d0f0d

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzdmYTU0ZDc1ZTJkYzFkMGYwNyIsImlkIjoiNWVjNmQ3N2ZhNTRkNzVlMmRjMWQwZjA4Iiwic2VjcmV0IjoiQWppZDlnPT0ifQ.wOPdcBjpvj3cbhMSY7HlOQhDyiJ59qtaUqM_-8RH4fI

Body

{
  "data": {
    "position": 2
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d77fa54d75e2dc1d0f0d",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5ec6d77fa54d75e2dc1d0f0d",
    "challengeId": "5ec6d77fa54d75e2dc1d0f0a",
    "position": 2,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2020-05-21T12:33:19.621-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/assessments/:assessment_id/challenge_items/:id

Parameters

Name Description
assessment_id required base16 ObjectId
id required base16 ObjectId

Request

Route

DELETE /v1/assessments/5ec6d77fa54d75e2dc1d0f1a/challenge_items/5ec6d77fa54d75e2dc1d0f21

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzdmYTU0ZDc1ZTJkYzFkMGYxYiIsImlkIjoiNWVjNmQ3N2ZhNTRkNzVlMmRjMWQwZjFjIiwic2VjcmV0IjoiU2RzYTFnPT0ifQ.rHJAxLYwaICoACA828wbP0mXiPKMp3OxQgDHt3JAs2Q
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Assessment Invitations

Resources for managing and creating invitations. Invitations are how candidates get explicitly introduced into the system. For private assessments, this is the only way to gain access to take the assessment.

List

Returns all invitations accessible to the current logged in user

Endpoint

GET /v1/assessment_invitations

Request

Route

GET /v1/assessment_invitations

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzdmYTU0ZDc1ZTJkYzFkMGYyYSIsImlkIjoiNWVjNmQ3N2ZhNTRkNzVlMmRjMWQwZjJiIiwic2VjcmV0IjoiSG05bCtnPT0ifQ.sPBuu6WG5B3wir1_rvt0MF9gYP1wy9g0EJyYKZWtJhg

Query Parameters

{}=

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5ec6d780a54d75e2dc1d0f3f",
      "state": "active",
      "teamCandidateId": "5ec6d780a54d75e2dc1d0f47",
      "assessmentId": "5ec6d780a54d75e2dc1d0f40",
      "assessmentResultId": "5ec6d780a54d75e2dc1d0f4b",
      "teamId": "5ec6d77fa54d75e2dc1d0f24",
      "teamMemberId": "5ec6d780a54d75e2dc1d0f49",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-05-21T19:33:20.305Z",
      "invitePath": "/assess/5ec6d780a54d75e2dc1d0f40?activate=hOO9iNotMJArKg.5ec6d780a54d75e2dc1d0f46&email=loginidentity100%40example.com&invite=zS2RkX6gH0xJdw",
      "invitePracticePath": "/assess/practice-cc?activate=hOO9iNotMJArKg.5ec6d780a54d75e2dc1d0f46&email=loginidentity100%40example.com&invite=zS2RkX6gH0xJdw&returnTo=%2Fassess%2F5ec6d780a54d75e2dc1d0f40%3Factivate%3DhOO9iNotMJArKg.5ec6d780a54d75e2dc1d0f46%26email%3Dloginidentity100%2540example.com%26invite%3DzS2RkX6gH0xJdw",
      "assessmentTitle": "Mid-Level Back-End Engineer #29",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith100",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner"
    },
    {
      "id": "5ec6d780a54d75e2dc1d0f4f",
      "state": "active",
      "teamCandidateId": "5ec6d780a54d75e2dc1d0f57",
      "assessmentId": "5ec6d780a54d75e2dc1d0f50",
      "assessmentResultId": "5ec6d780a54d75e2dc1d0f5b",
      "teamId": "5ec6d77fa54d75e2dc1d0f24",
      "teamMemberId": "5ec6d780a54d75e2dc1d0f59",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-05-21T19:33:20.473Z",
      "invitePath": "/assess/5ec6d780a54d75e2dc1d0f50?activate=tBmzcRHVuqRTsA.5ec6d780a54d75e2dc1d0f56&email=loginidentity102%40example.com&invite=PHxaCHzzd7PedQ",
      "invitePracticePath": "/assess/practice-cc?activate=tBmzcRHVuqRTsA.5ec6d780a54d75e2dc1d0f56&email=loginidentity102%40example.com&invite=PHxaCHzzd7PedQ&returnTo=%2Fassess%2F5ec6d780a54d75e2dc1d0f50%3Factivate%3DtBmzcRHVuqRTsA.5ec6d780a54d75e2dc1d0f56%26email%3Dloginidentity102%2540example.com%26invite%3DPHxaCHzzd7PedQ",
      "assessmentTitle": "Mid-Level Django Developer #30",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith102",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner"
    },
    {
      "id": "5ec6d780a54d75e2dc1d0f5f",
      "state": "active",
      "teamCandidateId": "5ec6d780a54d75e2dc1d0f67",
      "assessmentId": "5ec6d780a54d75e2dc1d0f60",
      "assessmentResultId": "5ec6d780a54d75e2dc1d0f6b",
      "teamId": "5ec6d77fa54d75e2dc1d0f24",
      "teamMemberId": "5ec6d780a54d75e2dc1d0f69",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-05-21T19:33:20.614Z",
      "invitePath": "/assess/5ec6d780a54d75e2dc1d0f60?activate=BQYXbr6BupR2rQ.5ec6d780a54d75e2dc1d0f66&email=loginidentity104%40example.com&invite=eKmE96WJ3gKs3Q",
      "invitePracticePath": "/assess/practice-cc?activate=BQYXbr6BupR2rQ.5ec6d780a54d75e2dc1d0f66&email=loginidentity104%40example.com&invite=eKmE96WJ3gKs3Q&returnTo=%2Fassess%2F5ec6d780a54d75e2dc1d0f60%3Factivate%3DBQYXbr6BupR2rQ.5ec6d780a54d75e2dc1d0f66%26email%3Dloginidentity104%2540example.com%26invite%3DeKmE96WJ3gKs3Q",
      "assessmentTitle": "Junior Angular Developer #31",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith104",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner"
    }
  ],
  "meta": {
    "timestamp": "2020-05-21T12:33:20.720-07:00",
    "includes": []
  }
}

Invite Candidates

The way to create a candidate within the system is to invite them to an assessment.

Endpoint

POST /v1/assessment_invitations/invite_candidates

Parameters

Name Description with_example
data[candidates] required Array true
data[assessment_id] required base16 ObjectId true
data[assigned_team_member_ids] base16 ObjectId[] true
data[labels] String[] true
data[expires_at] Date true
data[reminder_at] Date true
data[custom_message] String true
data[send_invite_to_candidate] Boolean true
data[send_email_to_inviter] Boolean true
data[send_email_to_inviter] Boolean true
data[reopen_submitted] Boolean true
data[apply_day_defaults] Boolean true
data[first_name] First name of candidate, can only be used when single email is passed to candidates array true
data[last_name] Last name of candidate, can only be used when single email is passed to candidates array true

Request

Route

POST /v1/assessment_invitations/invite_candidates

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzgwYTU0ZDc1ZTJkYzFkMGY3NyIsImlkIjoiNWVjNmQ3ODBhNTRkNzVlMmRjMWQwZjc4Iiwic2VjcmV0IjoiSnVzTjBBPT0ifQ.KSgFx6M6IW04lzLZPJPqGOQDjAjsHeKctbNOdvqsZ1Q

Body

{
  "data": {
    "candidates": [
      "[email protected]"
    ],
    "assessment_id": "5ec6d780a54d75e2dc1d0f7a",
    "first_name": "George",
    "last_name": "Smith",
    "send_invite_to_candidate": true
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5ec6d781a54d75e2dc1d0f82",
      "state": "active",
      "teamCandidateId": "5ec6d780a54d75e2dc1d0f7d",
      "assessmentId": "5ec6d780a54d75e2dc1d0f7a",
      "assessmentResultId": "5ec6d781a54d75e2dc1d0f7e",
      "teamId": "5ec6d780a54d75e2dc1d0f71",
      "teamMemberId": "5ec6d780a54d75e2dc1d0f78",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-05-21T19:33:21.099Z",
      "invitePath": "/assess/5ec6d780a54d75e2dc1d0f7a?activate=mpgsk48cP68Apg.5ec6d780a54d75e2dc1d0f7c&email=George%40place.com&invite=2ZFVnS4LyzzCeA",
      "invitePracticePath": "/assess/practice-?activate=mpgsk48cP68Apg.5ec6d780a54d75e2dc1d0f7c&email=George%40place.com&invite=2ZFVnS4LyzzCeA&returnTo=%2Fassess%2F5ec6d780a54d75e2dc1d0f7a%3Factivate%3Dmpgsk48cP68Apg.5ec6d780a54d75e2dc1d0f7c%26email%3DGeorge%2540place.com%26invite%3D2ZFVnS4LyzzCeA",
      "assessmentTitle": "Senior Front-End Developer #32",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "George Smith",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner"
    }
  ],
  "meta": {
    "timestamp": "2020-05-21T12:33:21.137-07:00",
    "includes": []
  }
}

Invite Team Members

Allows you to invite a team member to a specific assessment. They will receive an email.

Endpoint

POST /v1/assessment_invitations/invite_team_members

Parameters

Name Description
team_members required Array
assessment_id required base16 ObjectId

Request

Route

POST /v1/assessment_invitations/invite_team_members

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzgxYTU0ZDc1ZTJkYzFkMGZhMSIsImlkIjoiNWVjNmQ3ODFhNTRkNzVlMmRjMWQwZmEyIiwic2VjcmV0IjoiYTZFQW5nPT0ifQ.ej1DwuSEFVMYlAyJKWJMwED-2tcWxVImwejRUpHf2c8

Body

{
  "data": {
    "team_members": [
      {
        "email": "[email protected]"
      }
    ],
    "assessment_id": "5ec6d781a54d75e2dc1d0fa4"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5ec6d781a54d75e2dc1d0fae",
      "state": "active",
      "teamCandidateId": "5ec6d781a54d75e2dc1d0fa9",
      "assessmentId": "5ec6d781a54d75e2dc1d0fa4",
      "assessmentResultId": "5ec6d781a54d75e2dc1d0faa",
      "teamId": "5ec6d781a54d75e2dc1d0f9b",
      "teamMemberId": "5ec6d781a54d75e2dc1d0fa2",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "createdAt": "2020-05-21T19:33:21.832Z",
      "invitePath": "/assess/5ec6d781a54d75e2dc1d0fa4?activate=NAqZOrR4nO5BKQ.5ec6d781a54d75e2dc1d0fa8&email=George%40place.com&invite=oOUFyNzZ5bgX5w",
      "invitePracticePath": "/assess/practice-?activate=NAqZOrR4nO5BKQ.5ec6d781a54d75e2dc1d0fa8&email=George%40place.com&invite=oOUFyNzZ5bgX5w&returnTo=%2Fassess%2F5ec6d781a54d75e2dc1d0fa4%3Factivate%3DNAqZOrR4nO5BKQ.5ec6d781a54d75e2dc1d0fa8%26email%3DGeorge%2540place.com%26invite%3DoOUFyNzZ5bgX5w",
      "assessmentTitle": "Mid-Level Rails Developer #34",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "",
      "candidateEmail": "[email protected]",
      "testTeamMember": true,
      "inviterRole": "owner"
    }
  ],
  "meta": {
    "timestamp": "2020-05-21T12:33:21.854-07:00",
    "includes": []
  }
}

Assessment Result Reviews

Resources for managing the manual reviews left by team members. These reviews are used to provide feedback on the quality of submissions

List

Endpoint

GET /v1/assessment_result_reviews

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/assessment_result_reviews

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzgzYTU0ZDc1ZTJkYzFkMTAxZiIsImlkIjoiNWVjNmQ3ODNhNTRkNzVlMmRjMWQxMDIwIiwic2VjcmV0Ijoicll6N0d3PT0ifQ.jjTv4Ijl7Csp4GqBVe5gvMANt_vf4neR3l-A4gMiW5c

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentResultReview",
  "data": [
    {
      "id": "5ec6d783a54d75e2dc1d101b",
      "reviewedById": "5ec6d783a54d75e2dc1d101d",
      "reviewedByStaff": null,
      "assessmentId": "5ec6d783a54d75e2dc1d100c",
      "assessmentResultId": "5ec6d783a54d75e2dc1d1014",
      "teamCandidateId": "5ec6d783a54d75e2dc1d1017",
      "candidateId": "5ec6d783a54d75e2dc1d1016",
      "rating": 5,
      "feedback": "great!",
      "state": "started",
      "createdAt": "2020-05-21T19:33:23.316Z",
      "updatedAt": "2020-05-21T19:33:23.316Z",
      "ratingLabel": "Approve",
      "ratingScore": 1.0
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:33:23.394-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_result_reviews/:id

Request

Route

GET /v1/assessment_result_reviews/5ec6d783a54d75e2dc1d103c

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzgzYTU0ZDc1ZTJkYzFkMTAzOSIsImlkIjoiNWVjNmQ3ODNhNTRkNzVlMmRjMWQxMDNhIiwic2VjcmV0IjoiNWNaZmlnPT0ifQ.SD3SXtRuZJFVEXWG2HXZ4vW7zpowTsGUg-qQGbtZtXc

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d783a54d75e2dc1d103c",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5ec6d783a54d75e2dc1d103c",
    "reviewedById": "5ec6d783a54d75e2dc1d103e",
    "reviewedByStaff": null,
    "assessmentId": "5ec6d783a54d75e2dc1d102a",
    "assessmentResultId": "5ec6d783a54d75e2dc1d1032",
    "teamCandidateId": "5ec6d783a54d75e2dc1d1035",
    "candidateId": "5ec6d783a54d75e2dc1d1034",
    "rating": 5,
    "feedback": "great!",
    "state": "started",
    "createdAt": "2020-05-21T19:33:23.801Z",
    "updatedAt": "2020-05-21T19:33:23.801Z",
    "ratingLabel": "Approve",
    "ratingScore": 1.0
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-05-21T12:33:23.840-07:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/assessment_result_reviews

Parameters

Name Description
data.assessment_result_id required data.assessment result
data.reviewed_by_id the id of the user who will be doing the assessing. Only need to set if you are inviting someone else
data.rating 1 - 5, for a 3 point system use 1,3 and 5 as your values
data.feedback data.feedback

Request

Route

POST /v1/assessment_result_reviews

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzg0YTU0ZDc1ZTJkYzFkMTA1NyIsImlkIjoiNWVjNmQ3ODRhNTRkNzVlMmRjMWQxMDU4Iiwic2VjcmV0IjoiZWNWNW5RPT0ifQ.fw46qThufISlslgUcpRLoo4MHt4w6LNATfS0X0cqncs

Body

{
  "data": {
    "feedback": "super duper",
    "assessment_result_id": "5ec6d784a54d75e2dc1d1050"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d784a54d75e2dc1d105a",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5ec6d784a54d75e2dc1d105a",
    "reviewedById": "5ec6d784a54d75e2dc1d1058",
    "reviewedByStaff": false,
    "assessmentId": "5ec6d783a54d75e2dc1d1048",
    "assessmentResultId": "5ec6d784a54d75e2dc1d1050",
    "teamCandidateId": "5ec6d784a54d75e2dc1d1053",
    "candidateId": "5ec6d784a54d75e2dc1d1052",
    "rating": null,
    "feedback": "super duper",
    "state": "started",
    "createdAt": "2020-05-21T19:33:24.216Z",
    "updatedAt": "2020-05-21T19:33:24.216Z",
    "ratingLabel": null,
    "ratingScore": null
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-05-21T12:33:24.233-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/assessment_result_reviews/:id

Parameters

Name Description
data.foo required data.foo

Request

Route

PUT /v1/assessment_result_reviews/5ec6d784a54d75e2dc1d1075

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzg0YTU0ZDc1ZTJkYzFkMTA3MiIsImlkIjoiNWVjNmQ3ODRhNTRkNzVlMmRjMWQxMDczIiwic2VjcmV0IjoiRlNSTHhnPT0ifQ.-N73Vg2D_b-n9tp27jKIFuw9-3ggUrYdfXMCkfn9_GI

Body

{
  "data": {
    "rating": 3,
    "feedback": "feedback"
  },
  "includes": []
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d784a54d75e2dc1d1075",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5ec6d784a54d75e2dc1d1075",
    "reviewedById": "5ec6d784a54d75e2dc1d1077",
    "reviewedByStaff": false,
    "assessmentId": "5ec6d784a54d75e2dc1d1063",
    "assessmentResultId": "5ec6d784a54d75e2dc1d106b",
    "teamCandidateId": "5ec6d784a54d75e2dc1d106e",
    "candidateId": "5ec6d784a54d75e2dc1d106d",
    "rating": 3,
    "feedback": "feedback",
    "state": "started",
    "createdAt": "2020-05-21T19:33:24.571Z",
    "updatedAt": "2020-05-21T19:33:24.621Z",
    "ratingLabel": "Neutral",
    "ratingScore": 0.5
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2020-05-21T12:33:24.630-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/assessment_result_reviews/:id

Request

Route

DELETE /v1/assessment_result_reviews/5ec6d784a54d75e2dc1d1093

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzg0YTU0ZDc1ZTJkYzFkMTA5MCIsImlkIjoiNWVjNmQ3ODRhNTRkNzVlMmRjMWQxMDkxIiwic2VjcmV0IjoieGdldmxBPT0ifQ.ePbghBcDY4hJ2cB3ZQxCPqZLJlvmUTSQOc99PPcOrTM
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Assessment Results

List

Endpoint

GET /v1/assessment_results

Parameters

Name Description
includes Valid values are: team_candidate, team, assessment, solutions, challenge
order_by ie: "created_by DESC".
page Default = 1
assessment_id Also reachable via /assessments/:assessment_id/assessment_results
candidate_id Also reachable via /candidates/:candidate_id/assessment_results

Request

Route

GET /v1/assessment_results

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzg1YTU0ZDc1ZTJkYzFkMTBjMSIsImlkIjoiNWVjNmQ3ODVhNTRkNzVlMmRjMWQxMGMyIiwic2VjcmV0IjoiVmVSUHdnPT0ifQ.lkTgvR3BsI9RSEdK3rpBmCfsxMUG39vBuTHYqcrzYzY

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "AssessmentResult",
  "data": [
    {
      "id": "5ec6d785a54d75e2dc1d10bb",
      "assessmentId": "5ec6d785a54d75e2dc1d10b6",
      "candidateId": "5ec6d785a54d75e2dc1d1098",
      "teamCandidateId": "5ec6d785a54d75e2dc1d10bc",
      "teamId": "5ec6d785a54d75e2dc1d109b",
      "state": "started",
      "createdAt": "2020-05-21T19:33:25.443Z",
      "updatedAt": "2020-05-21T19:33:25.443Z",
      "startedAt": "2020-05-21T19:33:25.443Z",
      "invitedAt": null,
      "submittedAt": null,
      "submittingAt": null,
      "openedAt": null,
      "originalOpenedAt": null,
      "originalStartedAt": null,
      "originalSubmittedAt": null,
      "dryRun": false,
      "candidateRemarks": null,
      "score": null,
      "closedReason": null,
      "redirectUrl": null,
      "submissionMessage": null,
      "nextAssessmentId": null,
      "stateUpdatedAt": "2020-05-21T19:33:25.443Z",
      "totalSubmissionSeconds": null,
      "totalOriginalSubmissionSeconds": null,
      "accumulatedSeconds": 0,
      "enforcedTimeLimit": null,
      "timerExpiresIn": null,
      "wallTimeSinceStart": 0,
      "reopenedById": null,
      "activeTimedSolutionId": null,
      "isActiveInteractSession": false,
      "candidateName": "Joe Smith140",
      "candidateEmail": "[email protected]",
      "candidatePhone": null,
      "interviewerIds": [],
      "activeInterviewerIds": [],
      "abandoned": false,
      "workflowName": null,
      "isInteractSession": false,
      "challengeItems": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:33:25.551-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_results/:id

Parameters

Name Description
id base64 or base16 ObjectId
includes Valid values: team_candidate, team, assessment, solutions, challenge

Request

Route

GET /v1/assessment_results/5ec6d786a54d75e2dc1d1116

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzg2YTU0ZDc1ZTJkYzFkMTBmMiIsImlkIjoiNWVjNmQ3ODZhNTRkNzVlMmRjMWQxMGYzIiwic2VjcmV0IjoiS0Myczl3PT0ifQ.Z9hOO_znB1NQJHxbj_JoUoJXejFW7uiLJSC3VJwf7Bo

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d786a54d75e2dc1d1116",
  "type": "AssessmentResult",
  "data": {
    "id": "5ec6d786a54d75e2dc1d1116",
    "assessmentId": "5ec6d786a54d75e2dc1d1111",
    "candidateId": "5ec6d786a54d75e2dc1d10f3",
    "teamCandidateId": "5ec6d786a54d75e2dc1d1117",
    "teamId": "5ec6d786a54d75e2dc1d10f6",
    "state": "started",
    "createdAt": "2020-05-21T19:33:26.525Z",
    "updatedAt": "2020-05-21T19:33:26.525Z",
    "startedAt": "2020-05-21T19:33:26.524Z",
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": null,
    "openedAt": null,
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": null,
    "dryRun": false,
    "candidateRemarks": null,
    "score": null,
    "closedReason": null,
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "stateUpdatedAt": "2020-05-21T19:33:26.524Z",
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": null,
    "activeTimedSolutionId": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith158",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "challengeItems": []
  },
  "meta": {
    "enums": {
      "closedReason": [
        {
          "value": "candidate_submitted",
          "text": "Candidate submitted"
        },
        {
          "value": "timer_ran_out",
          "text": "Timer ran out"
        },
        {
          "value": "team_forced",
          "text": "Team forced"
        },
        {
          "value": "team_decided",
          "text": "Team decided"
        },
        {
          "value": "invitation_canceled",
          "text": "Invitation canceled"
        },
        {
          "value": "assessment_archived",
          "text": "Assessment archived"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "opened",
          "text": "Opened"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitting",
          "text": "Submitting"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        },
        {
          "value": "terminated",
          "text": "Terminated"
        }
      ]
    },
    "timestamp": "2020-05-21T12:33:26.627-07:00",
    "includes": []
  }
}

Share

Returns a set of sharable URLs which do not require login, only available if option is enabled on your subscription

Endpoint

GET /v1/assessment_results/:id/share

Parameters

Name Description
id base64 or base16 ObjectId

Request

Route

GET /v1/assessment_results/5ec6d788a54d75e2dc1d1196/share

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzg4YTU0ZDc1ZTJkYzFkMTE3MiIsImlkIjoiNWVjNmQ3ODhhNTRkNzVlMmRjMWQxMTczIiwic2VjcmV0Ijoiamk4alJ3PT0ifQ.2vYMX1l2e1w6YRSLkh7x7bWMoQRA_CH46PorIL9EfPc

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d788a54d75e2dc1d1196",
  "url": "https://localhost:3001/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZHMiOlsiNWVjNmQ3ODhhNTRkNzVlMmRjMWQxMTk2Il0sInRva2VuX3R5cGUiOiJzaGFyZSIsInRlYW1faWQiOiI1ZWM2ZDc4OGE1NGQ3NWUyZGMxZDExNzYifQ.L5qe3XmvkSL12zMJpS2znx0Vl4dFdFHyXghJhvQVzLM",
  "pdf": "https://localhost:3001/pdf/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZHMiOlsiNWVjNmQ3ODhhNTRkNzVlMmRjMWQxMTk2Il0sInRva2VuX3R5cGUiOiJzaGFyZSIsInRlYW1faWQiOiI1ZWM2ZDc4OGE1NGQ3NWUyZGMxZDExNzYifQ.L5qe3XmvkSL12zMJpS2znx0Vl4dFdFHyXghJhvQVzLM",
  "solutions": [
    {
      "id": "5ec6d788a54d75e2dc1d119b",
      "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZHMiOlsiNWVjNmQ3ODhhNTRkNzVlMmRjMWQxMTliIiwiNWVjNmQ3ODhhNTRkNzVlMmRjMWQxMTkyIl0sInRva2VuX3R5cGUiOiJzaGFyZSIsInRlYW1faWQiOiI1ZWM2ZDc4OGE1NGQ3NWUyZGMxZDExNzYifQ.c88wefBd4aBW_Me61uQMPDI2WRTNRleX_1Jnk__EKRw",
      "embedUrl": "https://localhost:3001/research/embed/solution_review/5ec6d788a54d75e2dc1d119b?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZHMiOlsiNWVjNmQ3ODhhNTRkNzVlMmRjMWQxMTliIiwiNWVjNmQ3ODhhNTRkNzVlMmRjMWQxMTkyIl0sInRva2VuX3R5cGUiOiJzaGFyZSIsInRlYW1faWQiOiI1ZWM2ZDc4OGE1NGQ3NWUyZGMxZDExNzYifQ.c88wefBd4aBW_Me61uQMPDI2WRTNRleX_1Jnk__EKRw"
    }
  ]
}

Submit

Submits an assessment to be reviewed/screened by the company/team.

Endpoint

PUT /v1/assessment_results/:id/submit

Request

Route

PUT /v1/assessment_results/5ec6d78aa54d75e2dc1d1204/submit

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzg5YTU0ZDc1ZTJkYzFkMTFlMCIsImlkIjoiNWVjNmQ3ODlhNTRkNzVlMmRjMWQxMWUxIiwic2VjcmV0IjoiNkRRNFVBPT0ifQ.xTM1XD6S5Fj5noSOZqIXBO063dXG6gNoTCCrTFY3Dy8

Body

{}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d78aa54d75e2dc1d1204",
  "type": "AssessmentResult",
  "data": {
    "id": "5ec6d78aa54d75e2dc1d1204",
    "assessmentId": "5ec6d78aa54d75e2dc1d11ff",
    "candidateId": "5ec6d789a54d75e2dc1d11e1",
    "teamCandidateId": "5ec6d78aa54d75e2dc1d1205",
    "teamId": "5ec6d789a54d75e2dc1d11e4",
    "state": "submitting",
    "createdAt": "2020-05-21T19:33:30.232Z",
    "updatedAt": "2020-05-21T19:33:30.336Z",
    "startedAt": "2020-05-21T19:33:30.232Z",
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "2020-05-21T19:33:30.332Z",
    "openedAt": null,
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": null,
    "dryRun": false,
    "candidateRemarks": null,
    "score": 0.0,
    "closedReason": "candidate_submitted",
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "stateUpdatedAt": "2020-05-21T19:33:30.332Z",
    "totalSubmissionSeconds": 0.100114,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": null,
    "activeTimedSolutionId": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith200",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "challengeItems": []
  },
  "meta": {
    "enums": {
      "closedReason": [
        {
          "value": "candidate_submitted",
          "text": "Candidate submitted"
        },
        {
          "value": "timer_ran_out",
          "text": "Timer ran out"
        },
        {
          "value": "team_forced",
          "text": "Team forced"
        },
        {
          "value": "team_decided",
          "text": "Team decided"
        },
        {
          "value": "invitation_canceled",
          "text": "Invitation canceled"
        },
        {
          "value": "assessment_archived",
          "text": "Assessment archived"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "opened",
          "text": "Opened"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitting",
          "text": "Submitting"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        },
        {
          "value": "terminated",
          "text": "Terminated"
        }
      ]
    },
    "timestamp": "2020-05-21T12:33:30.491-07:00",
    "includes": []
  }
}

Unsubmit

Undos the assessment result submission so that the candidate can make changes

Endpoint

PUT /v1/assessment_results/:id/unsubmit

Request

Route

PUT /v1/assessment_results/5ec6d78ba54d75e2dc1d1272/unsubmit

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzhiYTU0ZDc1ZTJkYzFkMTI2YiIsImlkIjoiNWVjNmQ3OGJhNTRkNzVlMmRjMWQxMjZjIiwic2VjcmV0IjoidE5hMWZRPT0ifQ.jzqD2hZ8X6SZ2DFBLOyuk8LUBOM63BU5BE4sqUIed_w
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d78ba54d75e2dc1d1272",
  "type": "AssessmentResult",
  "data": {
    "id": "5ec6d78ba54d75e2dc1d1272",
    "assessmentId": "5ec6d78ba54d75e2dc1d126a",
    "candidateId": "5ec6d78ba54d75e2dc1d1261",
    "teamCandidateId": "5ec6d78ba54d75e2dc1d1273",
    "teamId": "5ec6d78ba54d75e2dc1d1264",
    "state": "opened",
    "createdAt": "1970-01-01T03:42:00.944Z",
    "updatedAt": "2020-05-21T19:33:32.050Z",
    "startedAt": null,
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "1970-01-01T01:39:00.944Z",
    "openedAt": "2020-05-21T19:33:32.043Z",
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": "2020-05-21T19:33:31.950Z",
    "dryRun": false,
    "candidateRemarks": null,
    "score": 0.0,
    "closedReason": null,
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "stateUpdatedAt": "2020-05-21T19:33:32.044Z",
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": "5ec6d78ba54d75e2dc1d126c",
    "activeTimedSolutionId": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith224",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "interviewerIds": [],
    "activeInterviewerIds": [],
    "abandoned": false,
    "workflowName": null,
    "isInteractSession": false,
    "challengeItems": []
  },
  "meta": {
    "enums": {
      "closedReason": [
        {
          "value": "candidate_submitted",
          "text": "Candidate submitted"
        },
        {
          "value": "timer_ran_out",
          "text": "Timer ran out"
        },
        {
          "value": "team_forced",
          "text": "Team forced"
        },
        {
          "value": "team_decided",
          "text": "Team decided"
        },
        {
          "value": "invitation_canceled",
          "text": "Invitation canceled"
        },
        {
          "value": "assessment_archived",
          "text": "Assessment archived"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "opened",
          "text": "Opened"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitting",
          "text": "Submitting"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        },
        {
          "value": "terminated",
          "text": "Terminated"
        }
      ]
    },
    "timestamp": "2020-05-21T12:33:32.083-07:00",
    "includes": []
  }
}

Assessment Templates

Resources for viewing and importing pre-built assessment templates

List

Endpoint

GET /v1/assessment_templates

Request

Route

GET /v1/assessment_templates

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzhjYTU0ZDc1ZTJkYzFkMTJjYiIsImlkIjoiNWVjNmQ3OGNhNTRkNzVlMmRjMWQxMmNjIiwic2VjcmV0IjoicWNUV1dRPT0ifQ.tAtW2Y-DE1WxTe28HOtwM1BP4B_ShuIASUumVXCGg5M

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5ec6d78ca54d75e2dc1d127f",
      "title": "Mid-Level JavaScript Engineer #54",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5ec6d78ca54d75e2dc1d1279",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "A sunt omnis explicabo ducimus vero. Nam cumque accusantium ipsa quis voluptas. Tenetur architecto distinctio. Et et ut perferendis molestiae eos. Culpa ut odio vitae doloremque iste fugiat qui.",
      "challengeItems": [
        {
          "id": "5ec6d78ca54d75e2dc1d1286",
          "challengeId": "5ec6d78ca54d75e2dc1d1283",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d1283",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Inverted Solution #69",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.264Z",
            "createdAt": "2020-05-21T19:33:32.272Z",
            "updatedAt": "2020-05-21T19:33:32.272Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d1284",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d1285",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "Ho65IYWTzTTRDSCPROcgIabu/MlpVcdO4Kcq9PdGwV/7hgtxHdxpA9yV4YBZ\nU7KUoMlgclOrp3J1MFF4wk8MeYvlofZNtgK/xBneXYCOMDWOZwML1d51d0no\nocndpOf7RdlHSGmwhBCexhXXXefvcq2/KKJVgb955h2LO54qRzzcMcjmWDyo\n0yEDpvRFQrya\n--MVM5pUvk0F4O+0mEwc3cWg==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d128a",
          "challengeId": "5ec6d78ca54d75e2dc1d1287",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d1287",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Email Substring #70",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.325Z",
            "createdAt": "2020-05-21T19:33:32.330Z",
            "updatedAt": "2020-05-21T19:33:32.330Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d1288",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d1289",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "cakBFrApsU8CIo6/kyI9JvaWb75TXn3fQ7Okof8xt/dOe3MgJOw4A5WFm37C\n7imQ05/ViE6JcroKLaR1C+4ZFXUrLBAHUzyGoGGpok1c2dO2xbYBxOb0sE15\nuR2iMJsJPZ575wt9MKaEPWncdBfctIqfl0FrKke8R4m1hG/OqkCKytw0DLEf\nCH7MiHh2S8gY\n--fla162zeWmqWsC9mamJMjQ==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d128e",
          "challengeId": "5ec6d78ca54d75e2dc1d128b",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d128b",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Custom Generator #71",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.350Z",
            "createdAt": "2020-05-21T19:33:32.355Z",
            "updatedAt": "2020-05-21T19:33:32.355Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d128c",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d128d",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "1iQ9HT1hIVptP5N5h9dmtVMof3KnzPzuISFBc+9/2K7REN3UC5EJexmQuTPi\n6LUbBN85VahFRPYHLjzTs/2dp58x0xzO1l4yxu9IwqhKDxOQK0PVRzZwDuM5\nvkl0yE4GN0fdWewWhCW09Bn3hJUIlPVhAT/4TJFpE8tUlL7/SnE/QTjiA1wd\nYWjCwP2iw3Tt\n--vLyPQyTNVQQ2LNeJQt2pZA==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Omnis nihil voluptatum debitis illum. Consectetur numquam asperiores et reprehenderit est eaque inventore. Ea accusantium nam voluptatem et consequatur esse culpa. Ipsum et voluptas voluptate vitae veniam voluptatibus quia. Voluptates molestiae non quos totam.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5ec6d78ca54d75e2dc1d128f",
      "title": "Junior Ruby Engineer #55",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5ec6d78ca54d75e2dc1d1279",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Nobis quo aut nulla dolores. Qui eum consectetur ad doloribus qui enim voluptatem. Est consequatur quia repellendus nesciunt. Et qui mollitia molestiae. Dolore et quis harum pariatur iste.",
      "challengeItems": [
        {
          "id": "5ec6d78ca54d75e2dc1d1293",
          "challengeId": "5ec6d78ca54d75e2dc1d1290",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d1290",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Fibonacci Handler #72",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.389Z",
            "createdAt": "2020-05-21T19:33:32.394Z",
            "updatedAt": "2020-05-21T19:33:32.394Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d1291",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d1292",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "jG1oYDPiU8J96L/0NspiQSIto/P/2cAcMgIelwHv87aOXgagLAYSGfQve8Tg\n5L6XJXzvlCOLZz5O2jQijPVi0DFRVpqizi1d5edGplyWRh+R+X8KiXfTWI+4\neTnbgniYH2TtFOSCjXHeF17+KsvHlMd8D0HX6ofw8tWfMDFhTSHkgIcyBe6k\naM8NQ7untHLy\n--InngWyefXpqE9EtfDWi9pQ==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d1297",
          "challengeId": "5ec6d78ca54d75e2dc1d1294",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d1294",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Sane Calculator #73",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.422Z",
            "createdAt": "2020-05-21T19:33:32.427Z",
            "updatedAt": "2020-05-21T19:33:32.427Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d1295",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d1296",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "pzIHzEnUIRpTD14IXlcq4PK+pj/GgGOzGm+uTgzYXailNxadUah12U1xgYxs\n0F02zvFC6yZDV+HKmAdXS8+gebByCQ2v2P281ckrW5VV8RGzNoj+Meyp55cL\nkF5QCwCPbMgLU3Qjb4VONBJIrzqJBaKHD7BD6B+fJ9GtmePNC3VHcfuylnje\nmrAnSDlvboU5\n--/NXihhkARmAiyGRv2afTIA==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d129b",
          "challengeId": "5ec6d78ca54d75e2dc1d1298",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d1298",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Heavy Encoding #74",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.448Z",
            "createdAt": "2020-05-21T19:33:32.453Z",
            "updatedAt": "2020-05-21T19:33:32.453Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d1299",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d129a",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "DjkfDNzvNQ20IJtfSNYls0VGlzMUku7mga1OrcGIV7YNP1OyvkWJq8YTUSH+\nb7A6vSBlH0l3w15krnC0bVDBN1sufc/ecNZ79yLs5voY/EOadFyj8sJ5IoPT\nS4Gju0hKclro5nOF1e9iSNWcvC5sjWxvEzB0r+KW5eD9L2/2OpzsFMWzMC5P\nfieBRug5LFIV\n--puoEuFUGutA2XXp61WQ9IQ==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Porro et similique sit. Vero voluptatum doloribus eum. Dolorem qui sit.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5ec6d78ca54d75e2dc1d129c",
      "title": "Junior Full-Stack Engineer #56",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5ec6d78ca54d75e2dc1d1279",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Atque dolorem nobis. Id qui doloribus eos rem. Velit perferendis expedita culpa et. Voluptate in aut ipsum qui. Id minus est dolor placeat hic fugit.",
      "challengeItems": [
        {
          "id": "5ec6d78ca54d75e2dc1d12a0",
          "challengeId": "5ec6d78ca54d75e2dc1d129d",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d129d",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Light Parser #75",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.484Z",
            "createdAt": "2020-05-21T19:33:32.490Z",
            "updatedAt": "2020-05-21T19:33:32.490Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d129e",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d129f",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "oU113ZwNllfjG9IWBkE0edmXwuz++l69Aqo/MHcyXgMQPfAZZUnml/bYwNQg\ni2OewLgP+9FKWDeOr5MkJ7hob/Bm+kE/TEka3iVkwjzxoCjpUTfae0gioTao\nIvizFqY7N4VwR5utOSWpwqR/YhKtq1/fyehQ9BnQ8uun0psk3FUN8+sKLmV7\nZsRthrnYMYp0\n--KJMGt1XaYTEi5ZEetG/gaw==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d12a4",
          "challengeId": "5ec6d78ca54d75e2dc1d12a1",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d12a1",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Crazy Sorting #76",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.516Z",
            "createdAt": "2020-05-21T19:33:32.521Z",
            "updatedAt": "2020-05-21T19:33:32.521Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d12a2",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d12a3",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "kmuN8EecNWAjRd9KA3Rgj8DCPnfAyBKHWCytkMP6QEC1l4vvDaxZ0xiNc8k+\nRFtfM4zSzSdRm7bTpQ297xfarsOHOaD6qPUbrkK3bHqsTIcrfPkdFuKr21GR\nkdULU+velG+6Rr+d9/nhwTV3NX4ZCm9ECwUxOMAvh8TipCVebYmSbZ20uc/+\nWRlwDmkjjhix\n--+/IA8ywFe0mKdd9MQjEgxg==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d12a8",
          "challengeId": "5ec6d78ca54d75e2dc1d12a5",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d12a5",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Async Problem #77",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.542Z",
            "createdAt": "2020-05-21T19:33:32.547Z",
            "updatedAt": "2020-05-21T19:33:32.547Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d12a6",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d12a7",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "xiCgvVccyUrEEuT6TB59ndsXL0gAuuHFZXj4+hU365BWRCoI370ByurtCFWg\naCuyg84B//FmknWZgrgU/uIhLnLm57a7VVFhnoXOrPSOdFJHInfZWF+rjV4J\nJLHep9tJ0J/k6V6WntqvsDUKouM9+uL9LuZPLBYOnLvrRSv9yGQp9rAr0ST6\n3gsmAiQO6AhH\n--nKhebootlKnrF832BewSYw==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Inventore ducimus in quae aut ratione. Voluptas consequatur et doloremque maiores culpa sapiente. Error sunt et et dolorem eum laboriosam architecto. Et vel ut corporis aut accusamus rerum. Quasi nam alias architecto omnis enim pariatur.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5ec6d78ca54d75e2dc1d12a9",
      "title": "Junior Front-End Developer #57",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5ec6d78ca54d75e2dc1d1279",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Est excepturi necessitatibus voluptate dolorem qui voluptatem. Ducimus sit ut eos laborum. Dicta excepturi ut et qui dolor cum.",
      "challengeItems": [
        {
          "id": "5ec6d78ca54d75e2dc1d12ad",
          "challengeId": "5ec6d78ca54d75e2dc1d12aa",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d12aa",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Polymorphic Algorithm #78",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.576Z",
            "createdAt": "2020-05-21T19:33:32.581Z",
            "updatedAt": "2020-05-21T19:33:32.581Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d12ab",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d12ac",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "HZWgAlR6rrwklBH7ZoOTTVjgZd7TaUdpy1cHT3ADcBAc0Z3jhVSNkKvJWoPK\nzCDXAt8QqsgrcwOlbsl7dHvhgNNLPWt+9//cXedg1vzN8lv2kg6+i0AaQjug\nSKoReqqXtMmd8GL1aob8PRzkYIsE8xO97UOVA9dgEB1g2qejhb0i1t57XJHl\nlQWKrhCO3TFB\n--4a91ZzQ0IB8/JIoESxj7Ew==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d12b1",
          "challengeId": "5ec6d78ca54d75e2dc1d12ae",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d12ae",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Sequential Strings #79",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.607Z",
            "createdAt": "2020-05-21T19:33:32.612Z",
            "updatedAt": "2020-05-21T19:33:32.612Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d12af",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d12b0",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "STlpz9UkmW6inWHa8FDYJnlKyjHIq+5lSsh2XqesNe0zR2C9YOzkO4lTci2K\nlEwWhsbdj/ITbuC4xoYkns4E97Aa5KQJCpkC5zO1nKWenUrynY6+WDQf+Kf6\ntxTzPeq2SPg0e7ZundL6SNJ3kGE/nieJqFrfm3KjT6fqn1vmaJOGEM0XmVad\n4EXfhTQEV/dQ\n--QKNs4ODr2SauaWZxc3Enig==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d12b5",
          "challengeId": "5ec6d78ca54d75e2dc1d12b2",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d12b2",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Node Handler #80",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.630Z",
            "createdAt": "2020-05-21T19:33:32.634Z",
            "updatedAt": "2020-05-21T19:33:32.634Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d12b3",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d12b4",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "ziE11rHpBPyjIJ0sCu4GcYlZpRXO8s01ZoVtwo+S0E7dGcoc4zeOerM+hegw\ndgdfLtxndee2kSUNpAQ6wwBhOb1FZweMayoi2yHp6D9rQDrmVgb3J4PhAu+x\nvBIz5RK+H/Wdmoi/GVrVpAIOzSQu7yq0nxVg0S15ACAwHRRusNkwCBqtQzDL\nBozJm02ofyeX\n--tHfwwAb5r+mOnoZBH2egGA==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Consequatur eius commodi nihil. Debitis dolore explicabo dolores velit optio. Quia odit veritatis et aut autem. Soluta omnis itaque facere assumenda numquam.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5ec6d78ca54d75e2dc1d12b6",
      "title": "Senior Front-End Developer #58",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5ec6d78ca54d75e2dc1d1279",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 6,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Et fugiat enim optio expedita vero earum. Eaque tenetur iure ut maxime itaque provident. Omnis a assumenda tempora.",
      "challengeItems": [
        {
          "id": "5ec6d78ca54d75e2dc1d12ba",
          "challengeId": "5ec6d78ca54d75e2dc1d12b7",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d12b7",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Crazy Generator #81",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.658Z",
            "createdAt": "2020-05-21T19:33:32.662Z",
            "updatedAt": "2020-05-21T19:33:32.662Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d12b8",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d12b9",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "jmg64Ot7uyShSeOSml8mSZBJ8Gf+CAXY3Kwsq+lhUZjObveGdA5v6EAk2lXM\n2u9quTd+kEBAYDnfiiYo6LIbtEaD3+vXIYpNTk7uxrLbsHwrwRwYsNJMCKy4\nlDaiQz5xekNwR7v6yYj4CIVIPeuJPEarLGyn6BbptU+TioIlhPtMPaQL8UGC\nDgaCkY79rLZs\n--qDaHHVvyPZPGU6aZBGIEag==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d12be",
          "challengeId": "5ec6d78ca54d75e2dc1d12bb",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d12bb",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Crazy Helper #82",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.683Z",
            "createdAt": "2020-05-21T19:33:32.687Z",
            "updatedAt": "2020-05-21T19:33:32.687Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d12bc",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d12bd",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "ehNK8o5Xv1r9F/ZGr4qv//JDTrzbSg86+AXm7rxfCF6zJKm7Wu3BkvkKE+3m\nE9sDitSb5Kb4NHPgzr+kht3zcvqx+aDjcNana1FCfRZB85OQGJyOcAdqUawU\nhRWrD3LtaYdmDFNMDfglygFnfDvQawNTB54F1wt8PK80/H1xxtDyl1BYvAnE\naMvbvzOVpysi\n--ZK51811zHufqX7EKusz4QA==--u"
              }
            ]
          }
        },
        {
          "id": "5ec6d78ca54d75e2dc1d12c2",
          "challengeId": "5ec6d78ca54d75e2dc1d12bf",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5ec6d78ca54d75e2dc1d12bf",
            "$type": "CodeChallenge",
            "teamId": "5ec6d78ca54d75e2dc1d1279",
            "createdById": "5ec6d78ca54d75e2dc1d1281",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Polymorphic Search #83",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2020-05-21T19:33:32.705Z",
            "createdAt": "2020-05-21T19:33:32.709Z",
            "updatedAt": "2020-05-21T19:33:32.709Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5ec6d78ca54d75e2dc1d12c0",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "unitTagMaximums": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5ec6d78ca54d75e2dc1d12c1",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "10.x",
                "languageVersionName": "Node 10.14.0",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd",
                  "jest"
                ],
                "totalTestCases": 1,
                "hiddenTestCases": 0,
                "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
                "setup": "const add = (a, b) => a * b;",
                "testCases": "wiU5QiLdQY3ngpfgwZHBQ7Yu97+v01OwfVWD5SW2HwefxPq0GpueaNXAI8t/\n+94eeOVfhjUhHS+HcH9mdBDoUr8e3y42sro3PpV9JxOH0ZDrRF0l6R73zyDb\nK7RQzBt9t/ygsGPlPfSRZw/wHvTUtsRnnA6Oriwd+zdOCBYG1JoPJWg+K0Bf\nI/UkSFqgl4FN\n--V5/YEo8CijDGsnoXi3i2+Q==--u"
              }
            ]
          }
        }
      ],
      "purpose": "Ratione modi aut ea voluptatibus. Iste quis velit. Iusto ut eos id.",
      "demoLandingOrder": 1000
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 5,
  "meta": {
    "timestamp": "2020-05-21T12:33:33.099-07:00",
    "includes": [
      "challenge_items.challenge"
    ]
  }
}

Import

Endpoint

PUT /v1/assessment_templates/:id/import

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessment_templates/5ec6d78ea54d75e2dc1d1353/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzhlYTU0ZDc1ZTJkYzFkMTM5ZiIsImlkIjoiNWVjNmQ3OGVhNTRkNzVlMmRjMWQxM2EwIiwic2VjcmV0IjoiR2RhYVBnPT0ifQ.1rhy5dndsH93VArD-7a3xA6VwW2CA9Lo1KsGUYchgbE
Content-Type: application/x-www-form-urlencoded

Body

data[title]=Assessment+Title

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d78ea54d75e2dc1d13b4",
  "type": "Assessment",
  "data": {
    "id": "5ec6d78ea54d75e2dc1d13b4",
    "title": "Assessment Title",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5ec6d78ea54d75e2dc1d1399",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": true,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 6,
    "copiedFromId": "5ec6d78ea54d75e2dc1d1353",
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Nobis hic laboriosam voluptatum omnis non. Fuga ut reprehenderit distinctio quis suscipit. Quos sint accusantium. Est at suscipit exercitationem voluptatibus in est.",
    "challengeItems": [
      {
        "id": "5ec6d78fa54d75e2dc1d13c4",
        "challengeId": "5ec6d78ea54d75e2dc1d13b6",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5ec6d78fa54d75e2dc1d13c5",
        "challengeId": "5ec6d78ea54d75e2dc1d13bb",
        "position": 2,
        "disabledLanguages": []
      },
      {
        "id": "5ec6d78fa54d75e2dc1d13c6",
        "challengeId": "5ec6d78fa54d75e2dc1d13c0",
        "position": 3,
        "disabledLanguages": []
      }
    ],
    "purpose": "Architecto odit quia ut voluptas commodi. Dignissimos ad iusto ut quos rerum at odio. Illum esse dolor.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-05-21T19:33:35.076Z",
    "archivedAt": null,
    "createdAt": "2020-05-21T19:33:35.071Z",
    "assessmentResultsSummary": {
      "_id": "5ec6d78fa54d75e2dc1d13c8"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5ec6d78fa54d75e2dc1d13c7",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:35.103-07:00",
    "includes": []
  }
}

Assessments

List

Endpoint

GET /v1/assessments

Parameters

Name Description
includes Valid values are: team, created_by, assessment_results, challenge
order_by ie: "title DESC"
page Default = 1

Request

Route

GET /v1/assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzkwYTU0ZDc1ZTJkYzFkMTQzNyIsImlkIjoiNWVjNmQ3OTBhNTRkNzVlMmRjMWQxNDM4Iiwic2VjcmV0IjoiOWZoRVN3PT0ifQ.24i8EzT3hROq_wmiXbP7ftKFtMnpoGJEOQ0AEPpR8sM

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5ec6d790a54d75e2dc1d1422",
      "title": "Mid-Level Back-End Engineer #74",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5ec6d790a54d75e2dc1d141c",
      "nounUpper": "Assessment",
      "nounLower": "assessment",
      "showPracticeAssessment": true,
      "showSurvey": true,
      "showTitle": true,
      "inviteOnly": false,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 2,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "practiceSlug": "practice-cc",
      "isTemplate": false,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Neque numquam quia alias consectetur. Ea ullam doloremque culpa dolor quis aliquam. Ut animi mollitia.",
      "challengeItems": [
        {
          "id": "5ec6d790a54d75e2dc1d1429",
          "challengeId": "5ec6d790a54d75e2dc1d1426",
          "position": 1,
          "disabledLanguages": []
        }
      ],
      "purpose": "Consequuntur corporis omnis aperiam officia distinctio quia nostrum. Id eveniet vitae commodi possimus repellendus facere officia. Aut voluptas excepturi illum minus atque voluptates.",
      "demoLandingOrder": 1000,
      "publishedAt": "2020-05-21T19:33:36.315Z",
      "archivedAt": null,
      "createdAt": "2020-05-21T19:33:36.348Z",
      "assessmentResultsSummary": {
        "_id": "5ec6d790a54d75e2dc1d142e",
        "all": 2,
        "started": 2
      },
      "labels": null,
      "notificationScheme": null,
      "defaultExpirationDays": null,
      "defaultReminderDays": null,
      "minReviewsBeforeConsideredReviewed": 1,
      "defaultAssignedTeamMemberIds": [],
      "defaultTeamCandidateLabels": null,
      "assignmentTeamMemberIds": [],
      "redirectUrl": null,
      "webhookUrl": null,
      "submissionMessage": null,
      "assignmentLabels": null,
      "assignmentRole": null,
      "workflowPaths": [],
      "bambooConfig": {
        "id": "5ec6d790a54d75e2dc1d143a",
        "jobId": null,
        "resultStateTriggers": null,
        "candidateStateTriggers": null,
        "sendStatus": null
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:33:36.572-07:00",
    "includes": []
  }
}

Get

Returns assessment for both authenticated and unauthenticated users. Only admins and team members can see unpublished assessments.

Endpoint

GET /v1/assessments/:id

Parameters

Name Description
id base16 ObjectId
includes Valid values are: team, challenge, created_by

Request

Route

GET /v1/assessments/5ec6d790a54d75e2dc1d1443

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d790a54d75e2dc1d1443",
  "type": "Assessment",
  "data": {
    "id": "5ec6d790a54d75e2dc1d1443",
    "title": "Junior DevOps Developer #75",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5ec6d790a54d75e2dc1d143d",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 2,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Asperiores sed quia qui voluptate. Aliquid quam accusantium vitae quae. Et sit eveniet quod veniam est numquam voluptatem.",
    "challengeItems": [
      {
        "id": "5ec6d790a54d75e2dc1d144a",
        "challengeId": "5ec6d790a54d75e2dc1d1447",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "activeInvitationsCount": 0
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:36.929-07:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/assessments

Parameters

Name Description
data.title required data.title
data.summary data.summary
data.purpose data.purpose

Request

Route

POST /v1/assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzkxYTU0ZDc1ZTJkYzFkMTQ4MyIsImlkIjoiNWVjNmQ3OTFhNTRkNzVlMmRjMWQxNDg0Iiwic2VjcmV0IjoiMjFFUFFnPT0ifQ.ufDTHUIz5RF8DLQBQ3olfxfkQpgxHRcWNH7n-dY2iis
Content-Type: application/x-www-form-urlencoded

Body

data[title]=Angular+Developer

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d791a54d75e2dc1d1497",
  "type": "Assessment",
  "data": {
    "id": "5ec6d791a54d75e2dc1d1497",
    "title": "Angular Developer",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5ec6d791a54d75e2dc1d147c",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": true,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": null,
    "challengeItems": [],
    "purpose": null,
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2020-05-21T19:33:37.706Z",
    "assessmentResultsSummary": {
      "_id": "5ec6d791a54d75e2dc1d1499"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5ec6d791a54d75e2dc1d1498",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:37.723-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/assessments/:id

Parameters

Name Description
id base16 ObjectId
data.title data.title
data.summary data.summary
data.purpose data.purpose
data.labels Array of labels

Request

Route

PUT /v1/assessments/5ec6d791a54d75e2dc1d14a2

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzkxYTU0ZDc1ZTJkYzFkMTRhMyIsImlkIjoiNWVjNmQ3OTFhNTRkNzVlMmRjMWQxNGE0Iiwic2VjcmV0IjoiNEppVElRPT0ifQ.qpCIzvorMnS8soUVJYL8n6y9vBxDMCwvN1uVTrXxuGQ
Content-Type: application/x-www-form-urlencoded

Body

data[summary]=Junior+to+mid-level&data[labels][]=Test

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d791a54d75e2dc1d14a2",
  "type": "Assessment",
  "data": {
    "id": "5ec6d791a54d75e2dc1d14a2",
    "title": "Junior Node Engineer #78",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5ec6d791a54d75e2dc1d149c",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 2,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Junior to mid-level",
    "challengeItems": [
      {
        "id": "5ec6d791a54d75e2dc1d14a9",
        "challengeId": "5ec6d791a54d75e2dc1d14a6",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "purpose": "Aperiam sit voluptatem aut aut officiis. Aliquam vel reiciendis facilis. Porro voluptas maiores.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-05-21T19:33:37.909Z",
    "archivedAt": null,
    "createdAt": "2020-05-21T19:33:37.943Z",
    "assessmentResultsSummary": {
      "_id": "5ec6d792a54d75e2dc1d14ae",
      "all": 2,
      "started": 2
    },
    "labels": [
      "Test"
    ],
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5ec6d792a54d75e2dc1d14b7",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:38.138-07:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/assessments/:id/publish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5ec6d792a54d75e2dc1d14c0/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzkyYTU0ZDc1ZTJkYzFkMTRjMSIsImlkIjoiNWVjNmQ3OTJhNTRkNzVlMmRjMWQxNGMyIiwic2VjcmV0IjoieXJIVzFBPT0ifQ.qhilXlE8bibf1n2nrHwu85KDkkcDF8EyoaLb-CDKj9g
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d792a54d75e2dc1d14c0",
  "type": "Assessment",
  "data": {
    "id": "5ec6d792a54d75e2dc1d14c0",
    "title": "Mid-Level Mobile Developer #79",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5ec6d792a54d75e2dc1d14ba",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Ducimus maxime corrupti id natus nisi. Ut incidunt adipisci sapiente assumenda commodi voluptas. Quasi sed omnis. Debitis fugit temporibus magnam sit corporis placeat. Aut ea sit incidunt suscipit sit.",
    "challengeItems": [],
    "purpose": "Doloribus et nulla officia ad quam commodi modi. Sint consequatur modi tempora veniam sed. Quod minus iste magni consequatur sunt eligendi. Repellendus est deleniti.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-05-21T19:33:38.312Z",
    "archivedAt": null,
    "createdAt": "2020-05-21T19:33:38.284Z",
    "assessmentResultsSummary": {
      "_id": "5ec6d792a54d75e2dc1d14c5"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5ec6d792a54d75e2dc1d14c4",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:38.335-07:00",
    "includes": []
  }
}

Un-publish

Endpoint

PUT /v1/assessments/:id/unpublish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5ec6d792a54d75e2dc1d14de/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzkyYTU0ZDc1ZTJkYzFkMTRkZiIsImlkIjoiNWVjNmQ3OTJhNTRkNzVlMmRjMWQxNGUwIiwic2VjcmV0IjoibllYbWdnPT0ifQ.cdxSYYk4DDy8Sa7nZ01aKFo4tkXfiv4IsByHbo7_QGc
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d792a54d75e2dc1d14de",
  "type": "Assessment",
  "data": {
    "id": "5ec6d792a54d75e2dc1d14de",
    "title": "Mid-Level DevOps Developer #81",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5ec6d792a54d75e2dc1d14d8",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 2,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Maxime ducimus ut ea. Facilis quis et dolores autem. Sed quia sequi.",
    "challengeItems": [
      {
        "id": "5ec6d792a54d75e2dc1d14e5",
        "challengeId": "5ec6d792a54d75e2dc1d14e2",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "purpose": "Occaecati aperiam minima incidunt. Excepturi placeat et id voluptatem iusto aut. Suscipit laboriosam nesciunt.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2020-05-21T19:33:38.741Z",
    "assessmentResultsSummary": {
      "_id": "5ec6d792a54d75e2dc1d14ea",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5ec6d792a54d75e2dc1d14f3",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:38.924-07:00",
    "includes": []
  }
}

Archive

Archives the assessment

Endpoint

PUT /v1/assessments/:id/archive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5ec6d793a54d75e2dc1d14fc/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzkzYTU0ZDc1ZTJkYzFkMTRmZCIsImlkIjoiNWVjNmQ3OTNhNTRkNzVlMmRjMWQxNGZlIiwic2VjcmV0IjoiVlF5UzZBPT0ifQ.CLCWT0McUdEb-SWshYlYaEGMEKNqVSSF52VDcQBup-s
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d793a54d75e2dc1d14fc",
  "type": "Assessment",
  "data": {
    "id": "5ec6d793a54d75e2dc1d14fc",
    "title": "Junior Ruby Engineer #82",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5ec6d792a54d75e2dc1d14f6",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 2,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Dolores vitae necessitatibus quia voluptatem delectus dolor nihil. Qui dolor ut. Omnis rerum autem molestiae. Inventore nemo voluptas.",
    "challengeItems": [
      {
        "id": "5ec6d793a54d75e2dc1d1503",
        "challengeId": "5ec6d793a54d75e2dc1d1500",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "purpose": "Omnis dolor tenetur quisquam omnis. Veniam ut et. Cum praesentium culpa doloremque.",
    "demoLandingOrder": 1000,
    "publishedAt": "2020-05-21T19:33:39.080Z",
    "archivedAt": "2020-05-21T19:33:39.281Z",
    "createdAt": "2020-05-21T19:33:39.114Z",
    "assessmentResultsSummary": {
      "_id": "5ec6d793a54d75e2dc1d1508",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5ec6d793a54d75e2dc1d1511",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:39.309-07:00",
    "includes": []
  }
}

Unarchive

Unarchives the assessment

Endpoint

PUT /v1/assessments/:id/unarchive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5ec6d793a54d75e2dc1d1537/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzkzYTU0ZDc1ZTJkYzFkMTUxYiIsImlkIjoiNWVjNmQ3OTNhNTRkNzVlMmRjMWQxNTFjIiwic2VjcmV0IjoiVFVHcUh3PT0ifQ._qQzdq_ziplcKHJ5lHru2Im3jWJj-0Vyrve2qh7QOac
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d793a54d75e2dc1d1537",
  "type": "Assessment",
  "data": {
    "id": "5ec6d793a54d75e2dc1d1537",
    "title": "Senior Back-End Engineer #84",
    "state": "draft",
    "teamId": "5ec6d793a54d75e2dc1d1531",
    "inviteOnly": false,
    "summary": "",
    "challengeItems": [],
    "unavailable": true
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:39.787-07:00",
    "includes": []
  }
}

Recover

Recovers the assessment

Endpoint

PUT /v1/assessments/:id/recover

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5ec6d794a54d75e2dc1d1575/recover

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkNzk0YTU0ZDc1ZTJkYzFkMTU2MSIsImlkIjoiNWVjNmQ3OTRhNTRkNzVlMmRjMWQxNTYyIiwic2VjcmV0IjoiWTBEaHJBPT0ifQ.GJ6TzU-nQ0x9mN4pH2UGZahEnS_AptdVD-P2_DDsHhQ
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d794a54d75e2dc1d1575",
  "type": "Assessment",
  "data": {
    "id": "5ec6d794a54d75e2dc1d1575",
    "title": "Junior Node Engineer #87",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5ec6d794a54d75e2dc1d155a",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": false,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Earum omnis nisi. Illum nostrum fugit maxime quaerat vero ratione. Est et deserunt est nihil sequi sed et. A similique natus et qui cum. A molestias quas blanditiis autem perspiciatis.",
    "challengeItems": [],
    "purpose": "Iure dolorum ut architecto voluptates. Architecto error consequuntur porro. Culpa vel eum sapiente a ratione nobis.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": "2020-05-21T19:33:40.475Z",
    "createdAt": "2020-05-21T19:33:40.481Z",
    "assessmentResultsSummary": {
      "_id": "5ec6d794a54d75e2dc1d1577"
    },
    "labels": null,
    "notificationScheme": null,
    "defaultExpirationDays": null,
    "defaultReminderDays": null,
    "minReviewsBeforeConsideredReviewed": 1,
    "defaultAssignedTeamMemberIds": [],
    "defaultTeamCandidateLabels": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": [],
    "bambooConfig": {
      "id": "5ec6d794a54d75e2dc1d1576",
      "jobId": null,
      "resultStateTriggers": null,
      "candidateStateTriggers": null,
      "sendStatus": null
    }
  },
  "meta": {
    "enums": {
      "assignmentRole": [
        {
          "value": "owner",
          "text": "Owner"
        },
        {
          "value": "inviter",
          "text": "Inviter"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind reviewer"
        },
        {
          "value": "any",
          "text": "Any"
        }
      ],
      "assignmentRoleSchedule": [
        {
          "value": "random",
          "text": "Random"
        }
      ],
      "notificationScheme": [
        {
          "value": "by_assignee",
          "text": "By Assigned Team Member"
        },
        {
          "value": "entire_team",
          "text": "Entire Team"
        },
        {
          "value": "all_premium",
          "text": "All Managers and Account Managers"
        },
        {
          "value": "all_owners",
          "text": "All Account Managers"
        },
        {
          "value": "all_inviters",
          "text": "All Managers"
        },
        {
          "value": "all_restricted",
          "text": "All Reviewers and Blind Reviewers"
        },
        {
          "value": "all_blind_reviewers",
          "text": "All Blind Reviewers"
        },
        {
          "value": "disabled",
          "text": "No One (Disabled)"
        }
      ],
      "defaultLanguage": [
        {
          "value": "coffeescript",
          "text": "CoffeeScript"
        },
        {
          "value": "javascript",
          "text": "JavaScript"
        },
        {
          "value": "python",
          "text": "Python"
        },
        {
          "value": "ruby",
          "text": "Ruby"
        },
        {
          "value": "clojure",
          "text": "Clojure"
        },
        {
          "value": "haskell",
          "text": "Haskell"
        },
        {
          "value": "csharp",
          "text": "C#"
        },
        {
          "value": "solidity",
          "text": "Solidity"
        },
        {
          "value": "java",
          "text": "Java"
        },
        {
          "value": "elixir",
          "text": "Elixir"
        },
        {
          "value": "typescript",
          "text": "TypeScript"
        },
        {
          "value": "cpp",
          "text": "C++"
        },
        {
          "value": "php",
          "text": "PHP"
        },
        {
          "value": "sql",
          "text": "SQL"
        },
        {
          "value": "swift",
          "text": "Swift"
        },
        {
          "value": "shell",
          "text": "Shell"
        },
        {
          "value": "fsharp",
          "text": "F#"
        },
        {
          "value": "ocaml",
          "text": "OCaml"
        },
        {
          "value": "erlang",
          "text": "Erlang"
        },
        {
          "value": "scala",
          "text": "Scala"
        },
        {
          "value": "r",
          "text": "R"
        },
        {
          "value": "objc",
          "text": "Objective-C"
        },
        {
          "value": "c",
          "text": "C"
        },
        {
          "value": "go",
          "text": "Go"
        },
        {
          "value": "kotlin",
          "text": "Kotlin"
        },
        {
          "value": "groovy",
          "text": "Groovy"
        },
        {
          "value": "lua",
          "text": "Lua"
        },
        {
          "value": "rust",
          "text": "Rust"
        }
      ],
      "state": [
        {
          "value": "draft",
          "text": "Draft"
        },
        {
          "value": "published",
          "text": "Published"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ],
      "workflowPaths": {
        "assignmentRole": [
          {
            "value": "owner",
            "text": "Owner"
          },
          {
            "value": "inviter",
            "text": "Inviter"
          },
          {
            "value": "reviewer",
            "text": "Reviewer"
          },
          {
            "value": "blind_reviewer",
            "text": "Blind reviewer"
          },
          {
            "value": "any",
            "text": "Any"
          }
        ],
        "assignmentRoleSchedule": [
          {
            "value": "random",
            "text": "Random"
          }
        ],
        "workflowType": [
          {
            "value": "simple_approve",
            "text": "Approve Workflow"
          },
          {
            "value": "simple_reject",
            "text": "Reject Workflow"
          }
        ],
        "assignmentTeamCandidateState": [
          {
            "value": "approved",
            "text": "Approved"
          },
          {
            "value": "rejected",
            "text": "Rejected"
          },
          {
            "value": "archived",
            "text": "Archived"
          }
        ],
        "timeType": [
          {
            "value": "total",
            "text": "Total"
          },
          {
            "value": "accumulated",
            "text": "Active"
          }
        ],
        "conditionsOp": [
          {
            "value": "and",
            "text": "And"
          },
          {
            "value": "or",
            "text": "Or"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:33:40.524-07:00",
    "includes": []
  }
}

Challenge Briefs

Briefs are living report information. They are synced in the background after information related to a challenge is changed. You can consume this data to implement your own reporting tools. Note that all challenge types have been combined into one object, so you will notice fields on each record that may not be relevant to the underlying challenge type.

List

Endpoint

GET /v1/challenge_briefs

Request

Route

GET /v1/challenge_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2EzYTU0ZDc1ZTJkYzFkMTczNSIsImlkIjoiNWVjNmQ3YTNhNTRkNzVlMmRjMWQxNzM2Iiwic2VjcmV0IjoiL0R2b01nPT0ifQ.Fzy4dY25LJabRiANFPrWAzWfZFuhbC2ZxP7nGDPNNe4

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "ChallengeBrief",
  "data": [
    {
      "id": "5ec6d7a3a54d75e2dc1d1728",
      "createdAt": "2020-05-21T19:33:55.905Z",
      "updatedAt": "2020-05-21T19:33:55.905Z",
      "teamId": "5ec6d7a3a54d75e2dc1d171e",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-05-21T19:33:56.905Z",
      "syncs": 1,
      "sourcedFromId": null,
      "templatedFromId": null,
      "copiedFromId": null,
      "createdById": "5ec6d7a3a54d75e2dc1d1726",
      "challengeCreatedAt": "2020-05-21T19:33:55.596Z",
      "challengeUpdatedAt": "2020-05-21T19:33:55.596Z",
      "publishedAt": "2020-05-21T19:33:55.591Z",
      "archivedAt": null,
      "type": "CodeChallenge",
      "state": "published",
      "title": "Cipher Puzzle #126",
      "summary": null,
      "purpose": null,
      "linkedStatus": "false",
      "copiedFromContentType": null,
      "libraryAccess": null,
      "contentType": "normal",
      "passingScore": 100,
      "revisionsCount": 0,
      "copiesCount": 0,
      "assessmentsCount": 1,
      "reviewsCount": 0,
      "assessmentResultsCount": 0,
      "solutionsCount": 1,
      "submittedSolutionsCount": 1,
      "viableSolutionsCount": 0,
      "estimatedTime": 2,
      "timeLimitMin": null,
      "difficulty": 1,
      "languagesCount": 1,
      "topicsCount": null,
      "labelsCount": null,
      "tagsCount": 0,
      "submissionRate": 100.0,
      "viableRate": 0.0,
      "passRate": null,
      "inLibrary": false,
      "copiedFromLibrary": null,
      "titleUniqueFromLibrary": null,
      "recruitment": false,
      "education": true,
      "tags": [],
      "topics": [
        "Algorithms"
      ],
      "labels": [],
      "signalProfilesCount": null,
      "avgSortScore": null,
      "avgKnownScore": null,
      "avgConfidenceScore": null,
      "avgOpinionScore": null,
      "minorOpinionsCount": null,
      "avgKnownObjectivesScore": null,
      "avgKnownQualitiesScore": null,
      "objectivesCount": null,
      "qualitiesCount": null,
      "objectiveCodes": null,
      "qualityCodes": null,
      "subjectCodes": null,
      "signalMappingsId": null,
      "customSignalMappings": null,
      "signalMappingsVersion": null,
      "generated": false,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "defaultLanguage": null,
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "importId": null,
      "clustersCount": 0,
      "risks": {
        "total": 0,
        "max": null
      },
      "services": {},
      "exactness": {},
      "testCases": {
        "min": 1,
        "max": 1
      },
      "solutionLanguages": {
        "javascript": 1
      },
      "filesCount": null,
      "refFilesCount": null,
      "enableExternalIde": null,
      "timeLimitType": null,
      "questionTimeLimitSec": null,
      "questionTimeLimitStartSec": null,
      "questionsCount": null,
      "questionTypes": null,
      "baselineStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "subjectStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "languages": [
        {
          "name": "javascript",
          "Id": "5ec6d7a3a54d75e2dc1d172a",
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "testFramework": "cw-2",
          "generated": null,
          "languageVersion": "10.x",
          "setupMass": null,
          "modificationMass": null,
          "mass": null,
          "linesAdded": null,
          "linesRemoved": null,
          "setupDifferential": null,
          "comparedAt": null,
          "functions": "",
          "functionsCount": 0,
          "identifiers": "",
          "identifiersCount": 0,
          "clusterCount": 0,
          "solutionsStats": {
            "score": null,
            "accumulatedSeconds": null,
            "accumulatedBgSeconds": null,
            "passedAccumulatedSeconds": null,
            "passedAccumulatedBgSeconds": null,
            "wallTime": null,
            "revisions": null,
            "mass": null,
            "functions": null,
            "ccn": null,
            "avgCcn": null
          }
        }
      ],
      "questions": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:33:55.967-07:00",
    "includes": []
  }
}

List Specific IDs

Endpoint

GET /v1/challenge_briefs

Request

Route

GET /v1/challenge_briefs?where=%7B%22id%22%3A%7B%22in%22%3A%5B%225ec6d7a4a54d75e2dc1d1744%22%2C%225ec6d7a4a54d75e2dc1d1754%22%5D%7D%7D

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2E0YTU0ZDc1ZTJkYzFkMTc1MSIsImlkIjoiNWVjNmQ3YTRhNTRkNzVlMmRjMWQxNzUyIiwic2VjcmV0Ijoid09rNXpRPT0ifQ.ZkX3OV7skG76frNbeXscfoAp1oc3vqm3mdGfqpsirFc

Query Parameters

where={"id":{"in":["5ec6d7a4a54d75e2dc1d1744","5ec6d7a4a54d75e2dc1d1754"]}}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "ChallengeBrief",
  "data": [
    {
      "id": "5ec6d7a4a54d75e2dc1d1744",
      "createdAt": "2020-05-21T19:33:56.514Z",
      "updatedAt": "2020-05-21T19:33:56.514Z",
      "teamId": "5ec6d7a4a54d75e2dc1d173a",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-05-21T19:33:57.514Z",
      "syncs": 1,
      "sourcedFromId": null,
      "templatedFromId": null,
      "copiedFromId": null,
      "createdById": "5ec6d7a4a54d75e2dc1d1742",
      "challengeCreatedAt": "2020-05-21T19:33:56.198Z",
      "challengeUpdatedAt": "2020-05-21T19:33:56.198Z",
      "publishedAt": "2020-05-21T19:33:56.193Z",
      "archivedAt": null,
      "type": "CodeChallenge",
      "state": "published",
      "title": "Functional Regex #127",
      "summary": null,
      "purpose": null,
      "linkedStatus": "false",
      "copiedFromContentType": null,
      "libraryAccess": null,
      "contentType": "normal",
      "passingScore": 100,
      "revisionsCount": 0,
      "copiesCount": 0,
      "assessmentsCount": 1,
      "reviewsCount": 0,
      "assessmentResultsCount": 0,
      "solutionsCount": 1,
      "submittedSolutionsCount": 1,
      "viableSolutionsCount": 0,
      "estimatedTime": 2,
      "timeLimitMin": null,
      "difficulty": 1,
      "languagesCount": 1,
      "topicsCount": null,
      "labelsCount": null,
      "tagsCount": 0,
      "submissionRate": 100.0,
      "viableRate": 0.0,
      "passRate": null,
      "inLibrary": false,
      "copiedFromLibrary": null,
      "titleUniqueFromLibrary": null,
      "recruitment": false,
      "education": true,
      "tags": [],
      "topics": [
        "Algorithms"
      ],
      "labels": [],
      "signalProfilesCount": null,
      "avgSortScore": null,
      "avgKnownScore": null,
      "avgConfidenceScore": null,
      "avgOpinionScore": null,
      "minorOpinionsCount": null,
      "avgKnownObjectivesScore": null,
      "avgKnownQualitiesScore": null,
      "objectivesCount": null,
      "qualitiesCount": null,
      "objectiveCodes": null,
      "qualityCodes": null,
      "subjectCodes": null,
      "signalMappingsId": null,
      "customSignalMappings": null,
      "signalMappingsVersion": null,
      "generated": false,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "defaultLanguage": null,
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "importId": null,
      "clustersCount": 0,
      "risks": {
        "total": 0,
        "max": null
      },
      "services": {},
      "exactness": {},
      "testCases": {
        "min": 1,
        "max": 1
      },
      "solutionLanguages": {
        "javascript": 1
      },
      "filesCount": null,
      "refFilesCount": null,
      "enableExternalIde": null,
      "timeLimitType": null,
      "questionTimeLimitSec": null,
      "questionTimeLimitStartSec": null,
      "questionsCount": null,
      "questionTypes": null,
      "baselineStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "subjectStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "languages": [
        {
          "name": "javascript",
          "Id": "5ec6d7a4a54d75e2dc1d1746",
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "testFramework": "cw-2",
          "generated": null,
          "languageVersion": "10.x",
          "setupMass": null,
          "modificationMass": null,
          "mass": null,
          "linesAdded": null,
          "linesRemoved": null,
          "setupDifferential": null,
          "comparedAt": null,
          "functions": "",
          "functionsCount": 0,
          "identifiers": "",
          "identifiersCount": 0,
          "clusterCount": 0,
          "solutionsStats": {
            "score": null,
            "accumulatedSeconds": null,
            "accumulatedBgSeconds": null,
            "passedAccumulatedSeconds": null,
            "passedAccumulatedBgSeconds": null,
            "wallTime": null,
            "revisions": null,
            "mass": null,
            "functions": null,
            "ccn": null,
            "avgCcn": null
          }
        }
      ],
      "questions": null
    },
    {
      "id": "5ec6d7a4a54d75e2dc1d1754",
      "createdAt": "2020-05-21T19:33:56.598Z",
      "updatedAt": "2020-05-21T19:33:56.715Z",
      "teamId": "5ec6d7a4a54d75e2dc1d173a",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-05-21T19:33:57.714Z",
      "syncs": 1,
      "sourcedFromId": null,
      "templatedFromId": null,
      "copiedFromId": null,
      "createdById": "5ec6d7a4a54d75e2dc1d1756",
      "challengeCreatedAt": "2020-05-21T19:33:56.587Z",
      "challengeUpdatedAt": "2020-05-21T19:33:56.587Z",
      "publishedAt": null,
      "archivedAt": null,
      "type": "CodeChallenge",
      "state": "draft",
      "title": "Sane Encoding #128",
      "summary": null,
      "purpose": null,
      "linkedStatus": "false",
      "copiedFromContentType": null,
      "libraryAccess": null,
      "contentType": "normal",
      "passingScore": 100,
      "revisionsCount": 0,
      "copiesCount": 0,
      "assessmentsCount": 0,
      "reviewsCount": 0,
      "assessmentResultsCount": 0,
      "solutionsCount": 0,
      "submittedSolutionsCount": 0,
      "viableSolutionsCount": null,
      "estimatedTime": 2,
      "timeLimitMin": null,
      "difficulty": 1,
      "languagesCount": 1,
      "topicsCount": null,
      "labelsCount": null,
      "tagsCount": 0,
      "submissionRate": null,
      "viableRate": null,
      "passRate": null,
      "inLibrary": false,
      "copiedFromLibrary": null,
      "titleUniqueFromLibrary": null,
      "recruitment": false,
      "education": true,
      "tags": [],
      "topics": [
        "Algorithms"
      ],
      "labels": [],
      "signalProfilesCount": null,
      "avgSortScore": null,
      "avgKnownScore": null,
      "avgConfidenceScore": null,
      "avgOpinionScore": null,
      "minorOpinionsCount": null,
      "avgKnownObjectivesScore": null,
      "avgKnownQualitiesScore": null,
      "objectivesCount": null,
      "qualitiesCount": null,
      "objectiveCodes": null,
      "qualityCodes": null,
      "subjectCodes": null,
      "signalMappingsId": null,
      "customSignalMappings": null,
      "signalMappingsVersion": null,
      "generated": false,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "defaultLanguage": null,
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "importId": null,
      "clustersCount": 0,
      "risks": {
        "total": 0,
        "max": null
      },
      "services": {},
      "exactness": {},
      "testCases": {
        "min": 1,
        "max": 1
      },
      "solutionLanguages": {},
      "filesCount": null,
      "refFilesCount": null,
      "enableExternalIde": null,
      "timeLimitType": null,
      "questionTimeLimitSec": null,
      "questionTimeLimitStartSec": null,
      "questionsCount": null,
      "questionTypes": null,
      "baselineStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "subjectStats": {
        "score": null,
        "accumulatedSeconds": null,
        "accumulatedBgSeconds": null,
        "passedAccumulatedSeconds": null,
        "passedAccumulatedBgSeconds": null,
        "revisions": null,
        "mass": null,
        "maxSimilarity": null,
        "ccn": null
      },
      "languages": [
        {
          "name": "javascript",
          "Id": "5ec6d7a4a54d75e2dc1d1759",
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "testFramework": "cw-2",
          "generated": null,
          "languageVersion": "10.x",
          "setupMass": null,
          "modificationMass": null,
          "mass": null,
          "linesAdded": null,
          "linesRemoved": null,
          "setupDifferential": null,
          "comparedAt": null,
          "functions": "",
          "functionsCount": 0,
          "identifiers": "",
          "identifiersCount": 0,
          "clusterCount": 0,
          "solutionsStats": {
            "score": null,
            "accumulatedSeconds": null,
            "accumulatedBgSeconds": null,
            "passedAccumulatedSeconds": null,
            "passedAccumulatedBgSeconds": null,
            "wallTime": null,
            "revisions": null,
            "mass": null,
            "functions": null,
            "ccn": null,
            "avgCcn": null
          }
        }
      ],
      "questions": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 2,
  "meta": {
    "timestamp": "2020-05-21T12:33:56.941-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/challenge_briefs/:id

Request

Route

GET /v1/challenge_briefs/5ec6d7a5a54d75e2dc1d176e

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2E1YTU0ZDc1ZTJkYzFkMTc3YiIsImlkIjoiNWVjNmQ3YTVhNTRkNzVlMmRjMWQxNzdjIiwic2VjcmV0Ijoidjc0TGJRPT0ifQ.WJq77EVP0uKQWrbls9Px2MVfJLmolk9ueaDzZHnAY5M

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7a5a54d75e2dc1d176e",
  "type": "ChallengeBrief",
  "data": {
    "id": "5ec6d7a5a54d75e2dc1d176e",
    "createdAt": "2020-05-21T19:33:57.527Z",
    "updatedAt": "2020-05-21T19:33:57.527Z",
    "teamId": "5ec6d7a5a54d75e2dc1d1764",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-05-21T19:33:58.527Z",
    "syncs": 1,
    "sourcedFromId": null,
    "templatedFromId": null,
    "copiedFromId": null,
    "createdById": "5ec6d7a5a54d75e2dc1d176c",
    "challengeCreatedAt": "2020-05-21T19:33:57.154Z",
    "challengeUpdatedAt": "2020-05-21T19:33:57.154Z",
    "publishedAt": "2020-05-21T19:33:57.149Z",
    "archivedAt": null,
    "type": "CodeChallenge",
    "state": "published",
    "title": "Balanced Events #130",
    "summary": null,
    "purpose": null,
    "linkedStatus": "false",
    "copiedFromContentType": null,
    "libraryAccess": null,
    "contentType": "normal",
    "passingScore": 100,
    "revisionsCount": 0,
    "copiesCount": 0,
    "assessmentsCount": 1,
    "reviewsCount": 0,
    "assessmentResultsCount": 0,
    "solutionsCount": 1,
    "submittedSolutionsCount": 1,
    "viableSolutionsCount": 0,
    "estimatedTime": 2,
    "timeLimitMin": null,
    "difficulty": 1,
    "languagesCount": 1,
    "topicsCount": null,
    "labelsCount": null,
    "tagsCount": 0,
    "submissionRate": 100.0,
    "viableRate": 0.0,
    "passRate": null,
    "inLibrary": false,
    "copiedFromLibrary": null,
    "titleUniqueFromLibrary": null,
    "recruitment": false,
    "education": true,
    "tags": [],
    "topics": [
      "Meta-programming"
    ],
    "labels": [],
    "signalProfilesCount": null,
    "avgSortScore": null,
    "avgKnownScore": null,
    "avgConfidenceScore": null,
    "avgOpinionScore": null,
    "minorOpinionsCount": null,
    "avgKnownObjectivesScore": null,
    "avgKnownQualitiesScore": null,
    "objectivesCount": null,
    "qualitiesCount": null,
    "objectiveCodes": null,
    "qualityCodes": null,
    "subjectCodes": null,
    "signalMappingsId": null,
    "customSignalMappings": null,
    "signalMappingsVersion": null,
    "generated": false,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "defaultLanguage": null,
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "importId": null,
    "clustersCount": 0,
    "risks": {
      "total": 0,
      "max": null
    },
    "services": {},
    "exactness": {},
    "testCases": {
      "min": 1,
      "max": 1
    },
    "solutionLanguages": {
      "javascript": 1
    },
    "filesCount": null,
    "refFilesCount": null,
    "enableExternalIde": null,
    "timeLimitType": null,
    "questionTimeLimitSec": null,
    "questionTimeLimitStartSec": null,
    "questionsCount": null,
    "questionTypes": null,
    "baselineStats": {
      "score": null,
      "accumulatedSeconds": null,
      "accumulatedBgSeconds": null,
      "passedAccumulatedSeconds": null,
      "passedAccumulatedBgSeconds": null,
      "revisions": null,
      "mass": null,
      "maxSimilarity": null,
      "ccn": null
    },
    "subjectStats": {
      "score": null,
      "accumulatedSeconds": null,
      "accumulatedBgSeconds": null,
      "passedAccumulatedSeconds": null,
      "passedAccumulatedBgSeconds": null,
      "revisions": null,
      "mass": null,
      "maxSimilarity": null,
      "ccn": null
    },
    "languages": [
      {
        "name": "javascript",
        "Id": "5ec6d7a5a54d75e2dc1d1770",
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "testFramework": "cw-2",
        "generated": null,
        "languageVersion": "10.x",
        "setupMass": null,
        "modificationMass": null,
        "mass": null,
        "linesAdded": null,
        "linesRemoved": null,
        "setupDifferential": null,
        "comparedAt": null,
        "functions": "",
        "functionsCount": 0,
        "identifiers": "",
        "identifiersCount": 0,
        "clusterCount": 0,
        "solutionsStats": {
          "score": null,
          "accumulatedSeconds": null,
          "accumulatedBgSeconds": null,
          "passedAccumulatedSeconds": null,
          "passedAccumulatedBgSeconds": null,
          "wallTime": null,
          "revisions": null,
          "mass": null,
          "functions": null,
          "ccn": null,
          "avgCcn": null
        }
      }
    ],
    "questions": null
  },
  "meta": {
    "timestamp": "2020-05-21T12:33:57.590-07:00",
    "includes": []
  }
}

Challenges

List

Returns all global and team challenges

Endpoint

GET /v1/challenges

Parameters

Name Description
collection if provided will filter by either "team" or "global" challenges
includes Valid values are: team, created_by, solutions
templates If set to true, will return only templates. By default everything but templates are returned
$type The subtype to filter by. Useful as a replacement for using the type specific endpoint

Request

Route

GET /v1/challenges

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2E3YTU0ZDc1ZTJkYzFkMTg0ZiIsImlkIjoiNWVjNmQ3YTdhNTRkNzVlMmRjMWQxODUwIiwic2VjcmV0IjoicFl2TWhBPT0ifQ.lg2fnm1Ml2nZOcWA2g7e86iuFoQPLuH8_C4z_4sIJow

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "CodeChallenge",
  "data": [
    {
      "id": "5ec6d7a7a54d75e2dc1d184e",
      "$type": "CodeChallenge",
      "teamId": "5ec6d7a7a54d75e2dc1d1848",
      "createdById": "5ec6d7a7a54d75e2dc1d1850",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Super Problem #138",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Fundamentals"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-05-21T19:33:59.864Z",
      "createdAt": "2020-05-21T19:33:59.869Z",
      "updatedAt": "2020-05-21T19:33:59.869Z",
      "libraryAccess": null,
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5ec6d7a7a54d75e2dc1d1852",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "team",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "unitTagMaximums": [],
      "associatedTags": [],
      "signalMappingsId": null,
      "embeddable": false,
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "yamlConfig": null,
      "languages": [
        {
          "id": "5ec6d7a7a54d75e2dc1d1853",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "10.x",
          "languageVersionName": "Node 10.14.0",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "setup": "const add = (a, b) => a * b;",
          "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "preloaded": null,
          "solution": "const add = (a, b) => a + b;",
          "validationHash": 0,
          "exampleValidationHash": 0
        }
      ]
    },
    {
      "id": "5ec6d7a7a54d75e2dc1d185c",
      "$type": "CodeChallenge",
      "teamId": "5ec6d7a7a54d75e2dc1d1856",
      "createdById": "5ec6d7a7a54d75e2dc1d185d",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Password Process #139",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Algorithms"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-05-21T19:33:59.976Z",
      "createdAt": "2020-05-21T19:33:59.981Z",
      "updatedAt": "2020-05-21T19:33:59.981Z",
      "libraryAccess": "limited",
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5ec6d7a7a54d75e2dc1d1860",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "commons",
      "protected": true,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "unitTagMaximums": [],
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "languages": [
        {
          "id": "5ec6d7a7a54d75e2dc1d1861",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "10.x",
          "languageVersionName": "Node 10.14.0",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "setup": "const add = (a, b) => a * b;",
          "testCases": "A8IcH3bNxPZWaJaNDwFVrM0XGQVcayqR4TcZ89qub8XrDXFhb1/PeGDxuy0O\nZGDT67tbq2C8RzcBNwKXbD8EvBKs4vbUcg8AfU/bx0W0lzwdu+CV77GvJI2u\nfMnLXayQfz5MOgIKupMYqfPpGdVUtuj9XHLNgl83AZXz94oPl5/aIQoxwnrq\nRKmDD5Jf0pxv\n--SySL8jqkkjURHOuONe30Mg==--u"
        }
      ]
    },
    {
      "id": "5ec6d7a8a54d75e2dc1d1865",
      "$type": "CodeChallenge",
      "teamId": "5ec6d7a7a54d75e2dc1d1856",
      "createdById": "5ec6d7a7a54d75e2dc1d185d",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Actor Generator #141",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Fundamentals"
      ],
      "labels": [
        "Templates"
      ],
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2020-05-21T19:34:00.009Z",
      "createdAt": "2020-05-21T19:34:00.014Z",
      "updatedAt": "2020-05-21T19:34:00.014Z",
      "libraryAccess": "limited",
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "template",
      "productTypes": {
        "_id": "5ec6d7a8a54d75e2dc1d1866",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "commons",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "unitTagMaximums": [],
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "languages": [
        {
          "id": "5ec6d7a8a54d75e2dc1d1867",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "10.x",
          "languageVersionName": "Node 10.14.0",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd",
            "jest"
          ],
          "totalTestCases": 1,
          "hiddenTestCases": 0,
          "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "setup": "const add = (a, b) => a * b;",
          "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
          "preloaded": null,
          "solution": "const add = (a, b) => a + b;",
          "validationHash": 0,
          "exampleValidationHash": 0
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 3,
  "meta": {
    "timestamp": "2020-05-21T12:34:00.094-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/challenges/:id

Parameters

Name Description
id base16 ObjectId

Request

Route

GET /v1/challenges/5ec6d7a9a54d75e2dc1d18e5

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2E5YTU0ZDc1ZTJkYzFkMThlNiIsImlkIjoiNWVjNmQ3YTlhNTRkNzVlMmRjMWQxOGU3Iiwic2VjcmV0IjoicExFVEtRPT0ifQ.BqiKskTFhlxdDlj6K1J0UmxcimHre0uZt_oSkQ0z03Q

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7a9a54d75e2dc1d18e5",
  "type": "CodeChallenge",
  "data": {
    "id": "5ec6d7a9a54d75e2dc1d18e5",
    "$type": "CodeChallenge",
    "teamId": "5ec6d7a9a54d75e2dc1d18df",
    "createdById": "5ec6d7a9a54d75e2dc1d18e7",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Greedy Problem #159",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-05-21T19:34:01.353Z",
    "createdAt": "2020-05-21T19:34:01.359Z",
    "updatedAt": "2020-05-21T19:34:01.359Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7a9a54d75e2dc1d18e9",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5ec6d7a9a54d75e2dc1d18ea",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:01.411-07:00",
    "includes": []
  }
}

Create (Code Challenge)

Endpoint

POST /v1/challenges

Parameters

Name Description
data.$type required The type of challenge to create
data.title data.title
data.instructions data.instructions
data.purpose data.purpose
data.summary data.summary
data.estimated_time data.estimated time
data.difficulty data.difficulty
data.topics data.topics
data.state The state of the challenge, can be published, draft or archived
data.enforce_all_tests_on_publish Code Challenge only field: True if all tests should pass on publish, otherwise only a single test must pass. Default is true for new records
data.languages Code Challenge only field: An array of language objects.

Request

Route

POST /v1/challenges

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2E5YTU0ZDc1ZTJkYzFkMThmNCIsImlkIjoiNWVjNmQ3YTlhNTRkNzVlMmRjMWQxOGY1Iiwic2VjcmV0IjoiMER3UW93PT0ifQ.qwGQqAdaMZaqbD_hqni5roMxpseGpQ39Mlus2KMnWks

Body

{
  "data": {
    "$type": "CodeChallenge",
    "title": "test challenge",
    "purpose": "abc",
    "enforceAllTestsOnPublish": false,
    "state": "published",
    "instructions": "Do some work",
    "languages": [
      {
        "name": "javascript",
        "solution": "var a = 2",
        "test_cases": "Test.assertEquals(a,2)"
      }
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7a9a54d75e2dc1d18f9",
  "type": "CodeChallenge",
  "data": {
    "id": "5ec6d7a9a54d75e2dc1d18f9",
    "$type": "CodeChallenge",
    "teamId": "5ec6d7a9a54d75e2dc1d18ed",
    "createdById": "5ec6d7a9a54d75e2dc1d18f5",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "test challenge",
    "instructions": "Do some work",
    "difficulty": null,
    "summary": null,
    "purpose": "abc",
    "topics": null,
    "labels": null,
    "estimatedTime": null,
    "state": "published",
    "publishedAt": "2020-05-21T19:34:01.637Z",
    "createdAt": "2020-05-21T19:34:01.641Z",
    "updatedAt": "2020-05-21T19:34:01.641Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7a9a54d75e2dc1d18f0",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": false,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5ec6d7a9a54d75e2dc1d18fa",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 0,
        "hiddenTestCases": 0,
        "exampleTestCases": null,
        "setup": null,
        "testCases": "Test.assertEquals(a,2)",
        "preloaded": null,
        "solution": "var a = 2",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:01.664-07:00",
    "includes": []
  }
}

Create (Quiz Challenge)

Endpoint

POST /v1/challenges

Parameters

Name Description
data.title data.title
data.instructions data.instructions
data.purpose data.purpose
data.summary data.summary
data.estimated_time data.estimated time
data.difficulty data.difficulty
data.topics data.topics
data.state The state of the challenge, can be published, draft or archived

Request

Route

POST /v1/challenges

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2E5YTU0ZDc1ZTJkYzFkMTkwNSIsImlkIjoiNWVjNmQ3YTlhNTRkNzVlMmRjMWQxOTA2Iiwic2VjcmV0IjoiSEZoa3B3PT0ifQ.DKPkLP-bwbRWBSHSDl4HK8xI7luCah3vfQM_g_RAsqU

Body

{
  "data": {
    "$type": "QuizChallenge",
    "title": "test challenge",
    "purpose": "abc",
    "state": "draft",
    "instructions": "Do some work"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7a9a54d75e2dc1d1911",
  "type": "QuizChallenge",
  "data": {
    "id": "5ec6d7a9a54d75e2dc1d1911",
    "$type": "QuizChallenge",
    "teamId": "5ec6d7a9a54d75e2dc1d18fe",
    "createdById": "5ec6d7a9a54d75e2dc1d1906",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "test challenge",
    "instructions": "Do some work",
    "difficulty": null,
    "summary": null,
    "purpose": "abc",
    "topics": null,
    "labels": null,
    "estimatedTime": null,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2020-05-21T19:34:01.879Z",
    "updatedAt": "2020-05-21T19:34:01.879Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7a9a54d75e2dc1d1901",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "timeLimitType": "none",
    "questionTimeLimitSec": null,
    "questionTimeLimitStartSec": null,
    "questions": []
  },
  "meta": {
    "enums": {
      "timeLimitType": [
        {
          "value": "none",
          "text": "No Time Limit"
        },
        {
          "value": "challenge",
          "text": "Challenge Time Limit"
        },
        {
          "value": "per_question",
          "text": "Per Question Time Limit"
        },
        {
          "value": "per_question_bonus",
          "text": "Per Question Time Limit with Time Bonus"
        }
      ],
      "questions": {
        "language": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:01.898-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/challenges/:id

Parameters

Name Description
id required base16 ObjectId
data.title data.title
data.instructions data.instructions
data.purpose data.purpose
data.summary data.summary
data.estimated_time data.estimated time
data.difficulty data.difficulty
data.topics data.topics
data.languages CodeChallenge only field: An array of language objects. Provide a removed: true value if you wish to remove an existing challenge language

Request

Route

PUT /v1/challenges/5ec6d7aaa54d75e2dc1d191b

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2FhYTU0ZDc1ZTJkYzFkMTkxYyIsImlkIjoiNWVjNmQ3YWFhNTRkNzVlMmRjMWQxOTFkIiwic2VjcmV0IjoiQ2tXVVRnPT0ifQ.HmmCgWthEE46RiUIM9nXHCELc3Kno0oedOreRS7gD90

Body

{
  "data": {
    "$type": "CodeChallenge",
    "languages": [
      {
        "name": "ruby",
        "solution": "a = 1"
      }
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7aaa54d75e2dc1d191b",
  "type": "CodeChallenge",
  "data": {
    "id": "5ec6d7aaa54d75e2dc1d191b",
    "$type": "CodeChallenge",
    "teamId": "5ec6d7a9a54d75e2dc1d1915",
    "createdById": "5ec6d7aaa54d75e2dc1d191d",
    "lastUpdatedById": "5ec6d7aaa54d75e2dc1d191d",
    "copiedFromId": null,
    "title": "Email Game #162",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2020-05-21T19:34:02.073Z",
    "updatedAt": "2020-05-21T19:34:02.135Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7aaa54d75e2dc1d191f",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5ec6d7aaa54d75e2dc1d1921",
        "name": "ruby",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "2.5.x",
        "languageVersionName": "MRI 2.5.1",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "rspec"
        ],
        "totalTestCases": 0,
        "hiddenTestCases": 0,
        "exampleTestCases": null,
        "setup": null,
        "testCases": null,
        "preloaded": null,
        "solution": "a = 1",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:02.155-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/challenges/:id

Request

Route

DELETE /v1/challenges/5ec6d7aaa54d75e2dc1d192a

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2FhYTU0ZDc1ZTJkYzFkMTkyYiIsImlkIjoiNWVjNmQ3YWFhNTRkNzVlMmRjMWQxOTJjIiwic2VjcmV0Ijoib0txNUVBPT0ifQ.xVI6nYSDUnbX6-MBBmEKrBB545JSuFf1iO4qtZWzXOw
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Un-Publish

Endpoint

PUT /v1/challenges/:id/unpublish

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5ec6d7aaa54d75e2dc1d1938/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2FhYTU0ZDc1ZTJkYzFkMTkzOSIsImlkIjoiNWVjNmQ3YWFhNTRkNzVlMmRjMWQxOTNhIiwic2VjcmV0IjoiRncwLzBRPT0ifQ.v-G6B7LPDAy_qabrsSpcGaps4gWGLaQidCgE_tByiAQ
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7aaa54d75e2dc1d1938",
  "type": "CodeChallenge",
  "data": {
    "id": "5ec6d7aaa54d75e2dc1d1938",
    "$type": "CodeChallenge",
    "teamId": "5ec6d7aaa54d75e2dc1d1932",
    "createdById": "5ec6d7aaa54d75e2dc1d193a",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Fibonacci Handler #164",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2020-05-21T19:34:02.541Z",
    "updatedAt": "2020-05-21T19:34:02.585Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7aaa54d75e2dc1d193c",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5ec6d7aaa54d75e2dc1d193d",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:02.607-07:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/challenges/:id/publish

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5ec6d7aaa54d75e2dc1d1946/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2FhYTU0ZDc1ZTJkYzFkMTk0NyIsImlkIjoiNWVjNmQ3YWFhNTRkNzVlMmRjMWQxOTQ4Iiwic2VjcmV0IjoieFM1dVZBPT0ifQ.hkwRp-dVFC90RuxA326v-UCHx8JhknldGRp-rMKsZTM
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7aaa54d75e2dc1d1946",
  "type": "CodeChallenge",
  "data": {
    "id": "5ec6d7aaa54d75e2dc1d1946",
    "$type": "CodeChallenge",
    "teamId": "5ec6d7aaa54d75e2dc1d1940",
    "createdById": "5ec6d7aaa54d75e2dc1d1948",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Polymorphic Game #165",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-05-21T19:34:02.779Z",
    "createdAt": "2020-05-21T19:34:02.749Z",
    "updatedAt": "2020-05-21T19:34:02.785Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7aaa54d75e2dc1d194a",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5ec6d7aaa54d75e2dc1d194b",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:02.804-07:00",
    "includes": []
  }
}

Archive

Endpoint

PUT /v1/challenges/:id/archive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5ec6d7aaa54d75e2dc1d1954/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2FhYTU0ZDc1ZTJkYzFkMTk1NSIsImlkIjoiNWVjNmQ3YWFhNTRkNzVlMmRjMWQxOTU2Iiwic2VjcmV0IjoickV2Rk9nPT0ifQ.hwnzix124SejJnH8l-bww5NYJV__y9T_Qt8HzsjiAYY
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7aaa54d75e2dc1d1954",
  "type": "CodeChallenge",
  "data": {
    "id": "5ec6d7aaa54d75e2dc1d1954",
    "$type": "CodeChallenge",
    "teamId": "5ec6d7aaa54d75e2dc1d194e",
    "createdById": "5ec6d7aaa54d75e2dc1d1956",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Value Methods #166",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "archived",
    "publishedAt": "2020-05-21T19:34:02.990Z",
    "createdAt": "2020-05-21T19:34:02.994Z",
    "updatedAt": "2020-05-21T19:34:03.035Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7aaa54d75e2dc1d1958",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5ec6d7aaa54d75e2dc1d1959",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:03.054-07:00",
    "includes": []
  }
}

Un-archive

Endpoint

PUT /v1/challenges/:id/unarchive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5ec6d7aba54d75e2dc1d1972/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2FiYTU0ZDc1ZTJkYzFkMTk3MyIsImlkIjoiNWVjNmQ3YWJhNTRkNzVlMmRjMWQxOTc0Iiwic2VjcmV0IjoiLzFjR2J3PT0ifQ.DUaun0tiQ1f-rvmyNRzdtkMyow2Ysz9wFZnrw2fUJ7M
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7aba54d75e2dc1d1972",
  "type": "CodeChallenge",
  "data": {
    "id": "5ec6d7aba54d75e2dc1d1972",
    "$type": "CodeChallenge",
    "teamId": "5ec6d7aba54d75e2dc1d196c",
    "createdById": "5ec6d7aba54d75e2dc1d1974",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Value Helper #168",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Logic"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-05-21T19:34:03.440Z",
    "createdAt": "2020-05-21T19:34:03.408Z",
    "updatedAt": "2020-05-21T19:34:03.447Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7aba54d75e2dc1d1976",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5ec6d7aba54d75e2dc1d1977",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:03.468-07:00",
    "includes": []
  }
}

Import

Imports a challenge into the team library. Can also be used to copy challenges

Endpoint

POST /v1/challenges/:id/import

Parameters

Name Description
id required base16 ObjectId

Request

Route

POST /v1/challenges/5ec6d7aca54d75e2dc1d1a1d/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2FjYTU0ZDc1ZTJkYzFkMWExZSIsImlkIjoiNWVjNmQ3YWNhNTRkNzVlMmRjMWQxYTFmIiwic2VjcmV0IjoiZml4WXdRPT0ifQ.nzQT_zUVa8g1Rv8wu4oiWjMrP3db5LhvNNCgYNQc0e8
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7aca54d75e2dc1d1a24",
  "type": "CodeChallenge",
  "data": {
    "id": "5ec6d7aca54d75e2dc1d1a24",
    "$type": "CodeChallenge",
    "teamId": "5ec6d7aca54d75e2dc1d1a17",
    "createdById": "5ec6d7aca54d75e2dc1d1a1f",
    "lastUpdatedById": null,
    "copiedFromId": "5ec6d7aca54d75e2dc1d1a1d",
    "title": "Email Calculator #172 (2020-05-21)",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2020-05-21T19:34:04.973Z",
    "createdAt": "2020-05-21T19:34:04.930Z",
    "updatedAt": "2020-05-21T19:34:04.930Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": false,
    "copiedFromContentType": "normal",
    "contentType": "normal",
    "productTypes": {
      "_id": "5ec6d7aca54d75e2dc1d1a27",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": true,
    "galleryImage": null,
    "unitTagMaximums": [],
    "associatedTags": [],
    "signalMappingsId": null,
    "embeddable": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5ec6d7aca54d75e2dc1d1a26",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "10.x",
        "languageVersionName": "Node 10.14.0",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd",
          "jest"
        ],
        "totalTestCases": 1,
        "hiddenTestCases": 0,
        "exampleTestCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "setup": "const add = (a, b) => a * b;",
        "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
        "preloaded": null,
        "solution": "const add = (a, b) => a + b;",
        "validationHash": 0,
        "exampleValidationHash": 0
      }
    ]
  },
  "meta": {
    "enums": {
      "successMode": [
        {
          "value": "specs",
          "text": "Specs"
        },
        {
          "value": "assertions",
          "text": "Assertions"
        }
      ],
      "similarityMode": [
        {
          "value": "full",
          "text": "Full"
        },
        {
          "value": "no_risk",
          "text": "No risk"
        },
        {
          "value": "none",
          "text": "None"
        }
      ],
      "languages": {
        "name": [
          {
            "value": "coffeescript",
            "text": "Coffeescript"
          },
          {
            "value": "javascript",
            "text": "Javascript"
          },
          {
            "value": "python",
            "text": "Python"
          },
          {
            "value": "ruby",
            "text": "Ruby"
          },
          {
            "value": "clojure",
            "text": "Clojure"
          },
          {
            "value": "haskell",
            "text": "Haskell"
          },
          {
            "value": "csharp",
            "text": "Csharp"
          },
          {
            "value": "solidity",
            "text": "Solidity"
          },
          {
            "value": "java",
            "text": "Java"
          },
          {
            "value": "elixir",
            "text": "Elixir"
          },
          {
            "value": "typescript",
            "text": "Typescript"
          },
          {
            "value": "cpp",
            "text": "Cpp"
          },
          {
            "value": "php",
            "text": "Php"
          },
          {
            "value": "sql",
            "text": "Sql"
          },
          {
            "value": "swift",
            "text": "Swift"
          },
          {
            "value": "shell",
            "text": "Shell"
          },
          {
            "value": "fsharp",
            "text": "Fsharp"
          },
          {
            "value": "ocaml",
            "text": "Ocaml"
          },
          {
            "value": "erlang",
            "text": "Erlang"
          },
          {
            "value": "scala",
            "text": "Scala"
          },
          {
            "value": "r",
            "text": "R"
          },
          {
            "value": "objc",
            "text": "Objc"
          },
          {
            "value": "c",
            "text": "C"
          },
          {
            "value": "go",
            "text": "Go"
          },
          {
            "value": "kotlin",
            "text": "Kotlin"
          },
          {
            "value": "groovy",
            "text": "Groovy"
          },
          {
            "value": "lua",
            "text": "Lua"
          },
          {
            "value": "rust",
            "text": "Rust"
          }
        ]
      }
    },
    "timestamp": "2020-05-21T12:34:05.008-07:00",
    "includes": []
  }
}

Label History

List

Endpoint

GET /v1/label_histories

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/label_histories?team_id=5ec6d7c0a54d75e2dc1d1d93

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2MwYTU0ZDc1ZTJkYzFkMWQ5YSIsImlkIjoiNWVjNmQ3YzBhNTRkNzVlMmRjMWQxZDliIiwic2VjcmV0IjoiQUFBZHFRPT0ifQ.tGjllMJhta-WWPW8crB4ML-uCKpwpj4H_ePdIz-igMw

Query Parameters

team_id=5ec6d7c0a54d75e2dc1d1d93

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "LabelHistory",
  "data": [
    {
      "id": "5ec6d7c0a54d75e2dc1d1d99",
      "name": "Test",
      "addedAt": "2020-05-21T19:34:24.954Z",
      "removedAt": null,
      "teamId": "5ec6d7c0a54d75e2dc1d1d93",
      "labeledId": "5ec6d7c0a54d75e2dc1d1d90",
      "labeledType": "TeamCandidate",
      "addedById": null,
      "removedById": null,
      "labeled": {
        "id": "5ec6d7c0a54d75e2dc1d1d90",
        "candidateId": "5ec6d7c0a54d75e2dc1d1d8f",
        "teamId": "5ec6d7c0a54d75e2dc1d1d93",
        "state": "invited",
        "demoData": false,
        "prevState": null,
        "assessmentIds": [],
        "assessmentResultIds": [],
        "blinding": "blind_reviewers",
        "createdAt": "2020-05-21T19:34:24.933Z",
        "updatedAt": "2020-05-21T19:34:24.933Z",
        "decidedAt": null,
        "invitedAt": "2020-05-21T19:34:24.933Z",
        "interactSessions": 0,
        "stateUpdatedAt": "2020-05-21T19:34:24.933Z",
        "testTeamMember": false,
        "assignedTeamMemberIds": [],
        "labels": null,
        "archived": false,
        "firstName": "Joe",
        "lastName": "Smith448",
        "anonymousName": "Olive Swan",
        "email": "[email protected]",
        "name": "Joe Smith448",
        "isBlinded": false,
        "stateLabel": "Invited",
        "stateTransitions": [
          "idle",
          "invited",
          "started",
          "submitted",
          "risk_detected",
          "reviewed",
          "approved",
          "rejected",
          "archived"
        ],
        "risks": null,
        "assessmentsRecap": {
          "id": "5ec6d7c1a54d75e2dc1d1d9d",
          "subjects": []
        }
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:34:25.042-07:00",
    "includes": []
  }
}

Notes

List

Endpoint

GET /v1/notes

Parameters

Name Description
includes Valid values are:
notable_id required id of the parent the note belongs to

Request

Route

GET /v1/notes?notable_id=5ec6d7c1a54d75e2dc1d1dab

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2MxYTU0ZDc1ZTJkYzFkMWQ5ZSIsImlkIjoiNWVjNmQ3YzFhNTRkNzVlMmRjMWQxZDlmIiwic2VjcmV0IjoiOWxVbXJnPT0ifQ.TxZkzuQF5AC-chiwECGIQyPJrORZEOkROkTn2xT78Js

Query Parameters

notable_id=5ec6d7c1a54d75e2dc1d1dab

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "Note",
  "data": [
    {
      "id": "5ec6d7c1a54d75e2dc1d1db8",
      "body": "Numquam porro dignissimos aut.",
      "userId": "5ec6d7c1a54d75e2dc1d1db0",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5ec6d7c1a54d75e2dc1d1dab"
    },
    {
      "id": "5ec6d7c1a54d75e2dc1d1db9",
      "body": "Modi nemo ea voluptatem est soluta.",
      "userId": "5ec6d7c1a54d75e2dc1d1db6",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5ec6d7c1a54d75e2dc1d1dab"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 2,
  "meta": {
    "timestamp": "2020-05-21T12:34:25.361-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/notes/:id

Parameters

Name Description
notable_id id of the parent the note belongs to

Request

Route

GET /v1/notes/5ec6d7c1a54d75e2dc1d1df4

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2MxYTU0ZDc1ZTJkYzFkMWRkYSIsImlkIjoiNWVjNmQ3YzFhNTRkNzVlMmRjMWQxZGRiIiwic2VjcmV0IjoiWE1pbGJ3PT0ifQ.wnHKFabJ-_jwm0wsXVuroRiOZ-8b2OYIVa1Z-025KaE

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7c1a54d75e2dc1d1df4",
  "type": "Note",
  "data": {
    "id": "5ec6d7c1a54d75e2dc1d1df4",
    "body": "Assumenda vitae consequuntur placeat consectetur ut esse veniam eum.",
    "userId": "5ec6d7c1a54d75e2dc1d1dec",
    "createdAt": null,
    "updatedAt": null,
    "notableId": "5ec6d7c1a54d75e2dc1d1de7"
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:25.958-07:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/notes

Parameters

Name Description
data.body required data.body
data.notable_id required id of the parent the note belongs to
data.notable_type type of the parent. Defaults to TeamCandidate

Request

Route

POST /v1/notes

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2MxYTU0ZDc1ZTJkYzFkMWRmNiIsImlkIjoiNWVjNmQ3YzJhNTRkNzVlMmRjMWQxZGY3Iiwic2VjcmV0IjoiazdkKzFRPT0ifQ.o1pE_rw4aBa2OXvREEjZqWg6gd_6u-y_sbEIqf4-5IE

Body

{
  "data": {
    "body": "body",
    "notable_id": "5ec6d7c2a54d75e2dc1d1e03",
    "notable_type": "TeamCandidate"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7c2a54d75e2dc1d1e12",
  "type": "Note",
  "data": {
    "id": "5ec6d7c2a54d75e2dc1d1e12",
    "body": "body",
    "userId": "5ec6d7c2a54d75e2dc1d1df7",
    "createdAt": "2020-05-21T19:34:26.233Z",
    "updatedAt": "2020-05-21T19:34:26.233Z",
    "notableId": "5ec6d7c2a54d75e2dc1d1e03"
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:26.237-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/notes/:id

Parameters

Name Description
data.foo required data.foo

Request

Route

PUT /v1/notes/5ec6d7c3a54d75e2dc1d1e6b

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2MyYTU0ZDc1ZTJkYzFkMWU1MSIsImlkIjoiNWVjNmQ3YzJhNTRkNzVlMmRjMWQxZTUyIiwic2VjcmV0IjoiKzQ4b2pBPT0ifQ.1hmbUiTAR-D69u6hcZvW9noK53IF-UvlWVZCXi-J_cg

Body

{
  "data": {
    "body": "foo"
  },
  "includes": []
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7c3a54d75e2dc1d1e6b",
  "type": "Note",
  "data": {
    "id": "5ec6d7c3a54d75e2dc1d1e6b",
    "body": "foo",
    "userId": "5ec6d7c3a54d75e2dc1d1e63",
    "createdAt": null,
    "updatedAt": "2020-05-21T19:34:27.169Z",
    "notableId": "5ec6d7c3a54d75e2dc1d1e5e"
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:27.172-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/notes/:id

Request

Route

DELETE /v1/notes/5ec6d7c3a54d75e2dc1d1e87

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2MzYTU0ZDc1ZTJkYzFkMWU2ZCIsImlkIjoiNWVjNmQ3YzNhNTRkNzVlMmRjMWQxZTZlIiwic2VjcmV0IjoiKys5aTFnPT0ifQ.nzI74g1dP6KQqDrHrfNv73vCzYkcWx739l-17W3dRfI
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Quiz Questions

List

This endpoint will return a list of questions for a particular quiz challenge.

Endpoint

GET /v1/quiz_questions

Parameters

Name Description
includes Valid values are: revisions

Request

Route

GET /v1/quiz_questions?challenge_id=5ec6d7c6a54d75e2dc1d1f82

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2M2YTU0ZDc1ZTJkYzFkMWY4MyIsImlkIjoiNWVjNmQ3YzZhNTRkNzVlMmRjMWQxZjg0Iiwic2VjcmV0IjoiY3FhVmdRPT0ifQ.jHjVCiZIkx7sYdiyczRveEGl1fIWvylsKr1TmmmFyl0

Query Parameters

challenge_id=5ec6d7c6a54d75e2dc1d1f82

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "QuizMultipleChoiceQuestion",
  "data": [
    {
      "id": "5ec6d7c6a54d75e2dc1d1f87",
      "$type": "QuizMultipleChoiceQuestion",
      "prompt": "Ipsam id culpa corrupti. Quos ipsa repellat facere voluptas omnis enim. Dolorem error itaque eos atque dolore eveniet.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {},
      "weight": 1.0,
      "unitTags": [],
      "choices": [
        "True",
        "False"
      ],
      "maxSelections": null,
      "answers": [
        0
      ]
    },
    {
      "id": "5ec6d7c6a54d75e2dc1d1f88",
      "$type": "QuizTextQuestion",
      "prompt": "Omnis quidem quos eum inventore consequatur ab qui. Vitae fuga omnis totam. Odio vel sapiente velit rem perspiciatis voluptas hic. Fugit nostrum sit quo dolor beatae maxime.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {},
      "weight": 1.0,
      "unitTags": [],
      "minCharacters": 5,
      "maxCharacters": 200,
      "defaultValue": "",
      "matchers": null
    },
    {
      "id": "5ec6d7c6a54d75e2dc1d1f89",
      "$type": "QuizWeightedChoiceQuestion",
      "prompt": "Reiciendis illum quae qui dolorem doloribus. Cum sequi aut ut et. Magni beatae rerum consequuntur neque. Possimus facere in voluptas ea vel. Sit nesciunt architecto adipisci.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {
        "automax": true
      },
      "weight": 1.0,
      "unitTags": [],
      "maxSelections": 5,
      "maxSum": 5.0,
      "weightedScoring": true,
      "choices": [
        {
          "label": "Ruby",
          "value": 1.0,
          "unitTags": []
        },
        {
          "label": "Python",
          "value": 0.0,
          "unitTags": []
        },
        {
          "label": "Php",
          "value": -1.0,
          "unitTags": []
        },
        {
          "label": "JavaScript",
          "value": 2.0,
          "unitTags": []
        },
        {
          "label": "TypeScript",
          "value": 2.0,
          "unitTags": []
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 3,
  "meta": {
    "timestamp": "2020-05-21T12:34:30.464-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/quiz_questions/:id

Parameters

Name Description
id base16 ObjectId
challenge_id base16 ObjectId: optional but recommended for faster question lookup

Request

Route

GET /v1/quiz_questions/5ec6d7c6a54d75e2dc1d1fb1

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2M2YTU0ZDc1ZTJkYzFkMWZhZCIsImlkIjoiNWVjNmQ3YzZhNTRkNzVlMmRjMWQxZmFlIiwic2VjcmV0IjoiU3NXclF3PT0ifQ.fV9jvyfgKRoHwZTrUxZeX7M-bD88E3L8EmETw0z_mfo

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7c6a54d75e2dc1d1fb1",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5ec6d7c6a54d75e2dc1d1fb1",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "Ut iure dolor quia. Officiis ut optio aut provident eos. Neque nam laboriosam aut consequatur in ut. Nobis veritatis aut molestias.",
    "position": null,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "unitTags": [],
    "choices": [
      "True",
      "False"
    ],
    "maxSelections": null,
    "answers": [
      0
    ]
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:30.644-07:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/quiz_questions

Parameters

Name Description
data.prompt required data.prompt
data.$type required The type of class that should be created. Can also use "type" or "_type" as param name.
data.challenge_id required the ID of the challenge to add the question to
data.position The 1 based position of the challenge within the list. Will be auto-set to the end of the list if omitted.
data.options data.options
data.weight data.weight
data.all_or_nothing data.all or nothing
data.language A language tag for this question.
data.answers A QuizMulitipleChoiceQuestion only field
data.choices A QuizMultipleChoiceQuestion/QuizWeightedChoiceQuestion only field
data.max_selections A QuizMultipleChoiceQuestion/QuizWeightedChoiceQuestion only field
data.max_sum A QuizWeightedChoiceQuestion only field
data.sorted A QuizMultipleChoiceQuestion/ only field
data.matchers A QuizTextQuestion only field
data.min_characters A QuizTextQuestion only field
data.max_characters A QuizTextQuestion only field

Request

Route

POST /v1/quiz_questions

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2M2YTU0ZDc1ZTJkYzFkMWZjMiIsImlkIjoiNWVjNmQ3YzZhNTRkNzVlMmRjMWQxZmMzIiwic2VjcmV0IjoiWDhneHRBPT0ifQ.GHucHsD8WpK8nUsrKfDoLUS1kUQJVq4L03vmiMHGnhU

Body

{
  "data": {
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "test multiple choice question",
    "challenge_id": "5ec6d7c6a54d75e2dc1d1fc1",
    "choices": [
      "True",
      "False"
    ],
    "answers": [
      1
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7c6a54d75e2dc1d1fce",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5ec6d7c6a54d75e2dc1d1fce",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "test multiple choice question",
    "position": 4,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "unitTags": [],
    "choices": [
      "True",
      "False"
    ],
    "maxSelections": 1,
    "answers": [
      1
    ]
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:30.822-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/quiz_questions/:id

Parameters

Name Description
id required base16 ObjectId
data.prompt required data.prompt
data.position data.position
data.options data.options
data.weight data.weight
data.all_or_nothing data.all or nothing
data.answers A QuizMultipleChoiceQuestion only field
data.choices A QuizMultipleChoiceQuestion/QuizWeightedChoiceQuestion only field
data.max_selections A QuizMultipleChoiceQuestion/QuizWeightedChoiceQuestion only field
data.max_sum A QuizWeightedChoiceQuestion only field
data.sorted A QuizMultipleChoiceQuestion only field
data.matchers A QuizTextQuestion only field
data.min_characters A QuizTextQuestion only field
data.max_characters A QuizTextQuestion only field

Request

Route

PUT /v1/quiz_questions/5ec6d7c6a54d75e2dc1d1fdc

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2M2YTU0ZDc1ZTJkYzFkMWZkOCIsImlkIjoiNWVjNmQ3YzZhNTRkNzVlMmRjMWQxZmQ5Iiwic2VjcmV0IjoiMzVSRkRBPT0ifQ.cPxTs8birH64vej-1jVgKbCtgITt8g-l7AYC1vleGAg

Body

{
  "data": {
    "prompt": "abcd",
    "choices": [
      {
        "label": "Red",
        "value": 0
      },
      {
        "label": "Yellow",
        "value": 1
      },
      {
        "label": "Green",
        "value": 1
      }
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7c6a54d75e2dc1d1fdc",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5ec6d7c6a54d75e2dc1d1fdc",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "abcd",
    "position": 3,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "unitTags": [],
    "choices": [
      "Red",
      "Yellow",
      "Green"
    ],
    "maxSelections": 1,
    "answers": [
      1,
      2
    ]
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:31.041-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/quiz_questions/:id

Request

Route

DELETE /v1/quiz_questions/5ec6d7c7a54d75e2dc1d1ff3

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2M3YTU0ZDc1ZTJkYzFkMWZlZiIsImlkIjoiNWVjNmQ3YzdhNTRkNzVlMmRjMWQxZmYwIiwic2VjcmV0Ijoibk9WM1lRPT0ifQ.ugQoRpLLcfHIfPsIVG8rk7auITpfqKzQAU7DhF-Gp3g
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Solution Briefs

Briefs are living report information. They are synced in the background after information related to a solution is changed. You can consume this data to implement your own reporting tools.

List

Endpoint

GET /v1/solution_briefs

Request

Route

GET /v1/solution_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2QxYTU0ZDc1ZTJkYzFkMjI5MyIsImlkIjoiNWVjNmQ3ZDFhNTRkNzVlMmRjMWQyMjk0Iiwic2VjcmV0IjoiRWFaTitnPT0ifQ.l2jE-jvLFNkXzQgcqs63RpQIiQnDtnYqUpA6DatBop0

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "SolutionBrief",
  "data": [
    {
      "id": "5ec6d7d0a54d75e2dc1d2276",
      "createdAt": "2020-05-21T19:34:41.158Z",
      "updatedAt": "2020-05-21T19:34:41.342Z",
      "teamId": "5ec6d7d0a54d75e2dc1d2270",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-05-21T19:34:42.332Z",
      "syncs": 1,
      "schemaVersion": 2,
      "candidateId": "5ec6d7d0a54d75e2dc1d2278",
      "teamCandidateId": "5ec6d7d0a54d75e2dc1d2279",
      "assessmentResultId": "5ec6d7d1a54d75e2dc1d228a",
      "challengeId": "5ec6d7d1a54d75e2dc1d2286",
      "sourcedFromId": null,
      "copiedFromId": null,
      "assessmentId": "5ec6d7d1a54d75e2dc1d2282",
      "solutionCreatedAt": "2020-05-21T19:33:40.914Z",
      "solutionUpdatedAt": "2020-05-21T19:34:41.133Z",
      "score": 0.0,
      "accumulatedSeconds": 0,
      "accumulatedBgSeconds": 0,
      "candidateNotes": null,
      "reviewRatings": {},
      "type": "CodeSolution",
      "revisions": 0,
      "revisionTags": {},
      "reviewsCount": 0,
      "submittedIn": null,
      "submittedAt": null,
      "viable": false,
      "passingScore": false,
      "baseline": false,
      "sortScore": 0.0,
      "selectionScore": 0.0,
      "knownScore": null,
      "confidenceScore": 0.5,
      "opinionScore": null,
      "knownObjectivesScore": null,
      "knownQualitiesScore": null,
      "signalBandsCount": 1,
      "signalBands": {
        "construct_score": {},
        "strength": {},
        "strength_score": {}
      },
      "attempts": 1,
      "passedTestCases": 1,
      "hiddenPassedTestCases": 0,
      "wallTime": 40,
      "testAttempts": 0,
      "totalTestCases": 1,
      "hiddenTestCases": 0,
      "solutionLength": 10,
      "firstTestCaseSolvedAt": "2020-05-21T19:34:40.914Z",
      "completedAt": "2020-05-21T19:34:40.914Z",
      "completedIn": null,
      "language": "javascript",
      "fileCount": null,
      "reopenedCount": null,
      "foreignTestCasesCount": null,
      "usedExternalIde": null,
      "completion": null,
      "answers": null,
      "codeMetrics": null,
      "similarity": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:34:41.393-07:00",
    "includes": []
  }
}

Solution Reviews

List

Endpoint

GET /v1/solution_reviews

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/solution_reviews

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2QyYTU0ZDc1ZTJkYzFkMjJkZSIsImlkIjoiNWVjNmQ3ZDJhNTRkNzVlMmRjMWQyMmRmIiwic2VjcmV0IjoiM1pkaHB3PT0ifQ.SiwrC65ITbiZ8wFz4C_W13wZ-HIXrG4s0vuV4qXr3Ng

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "SolutionReview",
  "data": [
    {
      "id": "5ec6d7d2a54d75e2dc1d22e1",
      "reviewedById": "5ec6d7d2a54d75e2dc1d22df",
      "reviewedByStaff": null,
      "assessmentId": "5ec6d7d2a54d75e2dc1d22d2",
      "assessmentResultId": "5ec6d7d2a54d75e2dc1d22da",
      "teamCandidateId": "5ec6d7d2a54d75e2dc1d22c9",
      "candidateId": "5ec6d7d2a54d75e2dc1d22c8",
      "challengeId": "5ec6d7d2a54d75e2dc1d22d6",
      "solutionId": "5ec6d7d2a54d75e2dc1d22c6",
      "feedback": null,
      "assessmentResultReviewId": "5ec6d7d2a54d75e2dc1d22e2",
      "rating": 3,
      "ratingLabel": "Neutral",
      "ratingScore": 0.5,
      "score": 0.5,
      "qualitiesScore": null,
      "positiveQualityIds": [],
      "negativeQualityIds": [],
      "qualities": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:34:42.511-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solution_reviews/:id

Request

Route

GET /v1/solution_reviews/5ec6d7d2a54d75e2dc1d2309

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2QyYTU0ZDc1ZTJkYzFkMjMwNiIsImlkIjoiNWVjNmQ3ZDJhNTRkNzVlMmRjMWQyMzA3Iiwic2VjcmV0IjoicXdWdVhBPT0ifQ.AvAE10189eiwDT1xENI2SmN5_BC2dZq4vhU6JBsoaG8

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7d2a54d75e2dc1d2309",
  "type": "SolutionReview",
  "data": {
    "id": "5ec6d7d2a54d75e2dc1d2309",
    "reviewedById": "5ec6d7d2a54d75e2dc1d2307",
    "reviewedByStaff": null,
    "assessmentId": "5ec6d7d2a54d75e2dc1d22fa",
    "assessmentResultId": "5ec6d7d2a54d75e2dc1d2302",
    "teamCandidateId": "5ec6d7d2a54d75e2dc1d22f1",
    "candidateId": "5ec6d7d2a54d75e2dc1d22f0",
    "challengeId": "5ec6d7d2a54d75e2dc1d22fe",
    "solutionId": "5ec6d7d2a54d75e2dc1d22ee",
    "feedback": null,
    "assessmentResultReviewId": "5ec6d7d2a54d75e2dc1d230a",
    "rating": 3,
    "ratingLabel": "Neutral",
    "ratingScore": 0.5,
    "score": 0.5,
    "qualitiesScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:43.011-07:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/solution_reviews

Parameters

Name Description
data.assessment_result_review_id required data.assessment result review
data.solution_id required data.solution
data.feedback data.feedback

Request

Route

POST /v1/solution_reviews

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2QzYTU0ZDc1ZTJkYzFkMjMyZSIsImlkIjoiNWVjNmQ3ZDNhNTRkNzVlMmRjMWQyMzJmIiwic2VjcmV0IjoiRXh5YWNRPT0ifQ.8kk6xuSOyR6jAiVR_ZnKA-sSKN5XlV7k44v0dM7oE_M

Body

{
  "data": {
    "feedback": "",
    "solution_id": "5ec6d7d3a54d75e2dc1d2316",
    "assessment_result_review_id": "5ec6d7d3a54d75e2dc1d2331"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7d3a54d75e2dc1d2332",
  "type": "SolutionReview",
  "data": {
    "id": "5ec6d7d3a54d75e2dc1d2332",
    "reviewedById": "5ec6d7d3a54d75e2dc1d232f",
    "reviewedByStaff": false,
    "assessmentId": "5ec6d7d3a54d75e2dc1d2322",
    "assessmentResultId": "5ec6d7d3a54d75e2dc1d232a",
    "teamCandidateId": "5ec6d7d3a54d75e2dc1d2319",
    "candidateId": "5ec6d7d3a54d75e2dc1d2318",
    "challengeId": "5ec6d7d3a54d75e2dc1d2326",
    "solutionId": "5ec6d7d3a54d75e2dc1d2316",
    "feedback": "",
    "assessmentResultReviewId": "5ec6d7d3a54d75e2dc1d2331",
    "rating": null,
    "ratingLabel": null,
    "ratingScore": null,
    "score": null,
    "qualitiesScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:43.553-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/solution_reviews/:id

Parameters

Name Description
data.feedback required data.feedback

Request

Route

PUT /v1/solution_reviews/5ec6d7d4a54d75e2dc1d2356

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q0YTU0ZDc1ZTJkYzFkMjM1MyIsImlkIjoiNWVjNmQ3ZDRhNTRkNzVlMmRjMWQyMzU0Iiwic2VjcmV0Ijoiby9oaDNBPT0ifQ.vuQkajJGCUXptUX2MPvAokifIpssj3PHtC9PrTaeQS8

Body

{
  "data": {
    "feedback": "feedback"
  },
  "includes": []
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7d4a54d75e2dc1d2356",
  "type": "SolutionReview",
  "data": {
    "id": "5ec6d7d4a54d75e2dc1d2356",
    "reviewedById": "5ec6d7d4a54d75e2dc1d2354",
    "reviewedByStaff": false,
    "assessmentId": "5ec6d7d3a54d75e2dc1d2347",
    "assessmentResultId": "5ec6d7d3a54d75e2dc1d234f",
    "teamCandidateId": "5ec6d7d3a54d75e2dc1d233e",
    "candidateId": "5ec6d7d3a54d75e2dc1d233d",
    "challengeId": "5ec6d7d3a54d75e2dc1d234b",
    "solutionId": "5ec6d7d3a54d75e2dc1d233b",
    "feedback": "feedback",
    "assessmentResultReviewId": "5ec6d7d4a54d75e2dc1d2357",
    "rating": 3,
    "ratingLabel": "Neutral",
    "ratingScore": 0.5,
    "score": 0.5,
    "qualitiesScore": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:44.184-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/solution_reviews/:id

Request

Route

DELETE /v1/solution_reviews/5ec6d7d4a54d75e2dc1d237e

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q0YTU0ZDc1ZTJkYzFkMjM3YiIsImlkIjoiNWVjNmQ3ZDRhNTRkNzVlMmRjMWQyMzdjIiwic2VjcmV0Ijoia043MmRRPT0ifQ.Hl7MCQTS6hWfFiuSkiWooHyfJdmHdSMCDDotO0FxejQ
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Solutions

List

Endpoint

GET /v1/solutions

Parameters

Name Description
includes Valid values are: candidate, challenge, assessment_result, cloned_from, clones, similarity
challenge_id Also available via /challenges/:challenge_id/solutions
assessment_result_id Also available via /assessment_results/:assessment_result_id/solutions

Request

Route

GET /v1/solutions?data[team_candidate_id]=5ec6d7d5a54d75e2dc1d23b1

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q1YTU0ZDc1ZTJkYzFkMjNiZSIsImlkIjoiNWVjNmQ3ZDVhNTRkNzVlMmRjMWQyM2JmIiwic2VjcmV0IjoiYU42Q1JnPT0ifQ.n-_w17SrzJLoMK9UK4Wb4kYfVLD5TsjA0TLVjrI0aYw

Query Parameters

data={"team_candidate_id"=>"5ec6d7d5a54d75e2dc1d23b1"}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "CodeSolution",
  "data": [
    {
      "id": "5ec6d7d5a54d75e2dc1d23b6",
      "$type": "CodeSolution",
      "estimatedTime": null,
      "createdAt": "2020-05-21T19:33:45.167Z",
      "updatedAt": "2020-05-21T19:34:45.213Z",
      "challengeId": "5ec6d7d5a54d75e2dc1d23b7",
      "assessmentResultId": "5ec6d7d5a54d75e2dc1d23b2",
      "assessmentId": "5ec6d7d5a54d75e2dc1d23ab",
      "candidateId": "5ec6d7d5a54d75e2dc1d23b0",
      "teamCandidateId": "5ec6d7d5a54d75e2dc1d23b1",
      "teamId": "5ec6d7d5a54d75e2dc1d23a5",
      "clonedFromId": null,
      "lastHeartbeat": null,
      "accumulatedSeconds": 0,
      "candidateNotes": null,
      "language": "javascript",
      "firstTestCaseSolvedAt": "2020-05-21T19:34:45.167Z",
      "completedAt": "2020-05-21T19:34:45.167Z",
      "code": "var a = 1;",
      "testCases": "Test.assertEquals(a, 1)",
      "testFramework": "cw-2",
      "attempts": 1,
      "output": [
        {
          "t": "passed",
          "v": "Test Passed"
        }
      ],
      "wallTime": 40,
      "firstTestCompletedIn": 60.0,
      "completedIn": 60.0,
      "specs": null,
      "assertions": null,
      "response": null,
      "testResponse": null,
      "successMode": "specs",
      "passedTestCases": 1,
      "hiddenPassedTestCases": 0,
      "totalTestCases": 1,
      "hiddenTestCases": 0,
      "sampleTestCasesEnabled": true,
      "cursor": {},
      "revisionCount": 0,
      "score": 0.0
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:34:45.250-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solutions/:id

Request

Route

GET /v1/solutions/5ec6d7d7a54d75e2dc1d2487

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q3YTU0ZDc1ZTJkYzFkMjQ4OCIsImlkIjoiNWVjNmQ3ZDdhNTRkNzVlMmRjMWQyNDg5Iiwic2VjcmV0IjoiRnNEUm1nPT0ifQ.QYG8_mrUT5HhzdzUsoCu2UHgs70ZGtuED8LLYUoZTFE

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7d7a54d75e2dc1d2487",
  "type": "CodeSolution",
  "data": {
    "id": "5ec6d7d7a54d75e2dc1d2487",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-05-21T19:33:47.339Z",
    "updatedAt": "2020-05-21T19:34:47.507Z",
    "challengeId": "5ec6d7d7a54d75e2dc1d2497",
    "assessmentResultId": "5ec6d7d7a54d75e2dc1d249b",
    "assessmentId": "5ec6d7d7a54d75e2dc1d2493",
    "candidateId": "5ec6d7d7a54d75e2dc1d2489",
    "teamCandidateId": "5ec6d7d7a54d75e2dc1d248a",
    "teamId": "5ec6d7d7a54d75e2dc1d2481",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2020-05-21T19:34:47.339Z",
    "completedAt": "2020-05-21T19:34:47.339Z",
    "code": "var a = 1;",
    "testCases": "Test.assertEquals(a, 1)",
    "testFramework": "cw-2",
    "attempts": 1,
    "output": [
      {
        "t": "passed",
        "v": "Test Passed"
      }
    ],
    "wallTime": 40,
    "firstTestCompletedIn": 60.0,
    "completedIn": 60.0,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 1,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "hiddenTestCases": 0,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 0,
    "score": 100.0
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:47.539-07:00",
    "includes": []
  }
}

Create

Creates a new solution of the type specified. This is an alias endpoint for the subtype specific route. See each type specific section for more details. For this example, this route is actually linking to the POST /v1/code_solutions route.

Endpoint

POST /v1/solutions

Parameters

Name Description
data.$type required The type of solution to create
data.language required initial language the user started in
data.assessment_result_id required data.assessment result
data.challenge_id required data.challenge

Request

Route

POST /v1/solutions

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q3YTU0ZDc1ZTJkYzFkMjRiMCIsImlkIjoiNWVjNmQ3ZDdhNTRkNzVlMmRjMWQyNGIxIiwic2VjcmV0IjoiVmpSOFJnPT0ifQ.UgI9ZJ41dUAz9Zt2Yl_-TWkm39dDgPI7RwChSIBkHRU

Body

{
  "data": {
    "$type": "CodeSolution",
    "assessment_result_id": "5ec6d7d7a54d75e2dc1d24af",
    "challenge_id": "5ec6d7d7a54d75e2dc1d24ab",
    "language": "javascript"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7d7a54d75e2dc1d24b6",
  "type": "CodeSolution",
  "data": {
    "id": "5ec6d7d7a54d75e2dc1d24b6",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-05-21T19:34:47.881Z",
    "updatedAt": "2020-05-21T19:34:47.881Z",
    "challengeId": "5ec6d7d7a54d75e2dc1d24ab",
    "assessmentResultId": "5ec6d7d7a54d75e2dc1d24af",
    "assessmentId": "5ec6d7d7a54d75e2dc1d24a7",
    "candidateId": "5ec6d7d7a54d75e2dc1d24b1",
    "teamCandidateId": "5ec6d7d7a54d75e2dc1d24b2",
    "teamId": "5ec6d7d7a54d75e2dc1d24a1",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": null,
    "completedAt": null,
    "code": "const add = (a, b) => a * b;",
    "testCases": "const assert = require('chai').assert;\ndescribe('add', () => {\n  it('returns sum', () => {\n    assert.strictEqual(add(1, 1), 2);\n  });\n});\n",
    "testFramework": "cw-2",
    "attempts": 0,
    "output": null,
    "wallTime": null,
    "firstTestCompletedIn": null,
    "completedIn": null,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 0,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "hiddenTestCases": 0,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 0,
    "score": 0.0
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:47.899-07:00",
    "includes": []
  }
}

Fetch or Create

Fetches or creates a new solution of the type specified. This is an alias endpoint for the subtype specific route. See each type specific section for more details. For this example, this route is actually linking to the POST /v1/code_solutions route.

Endpoint

POST /v1/solutions

Parameters

Name Description
data.$type required The type of solution to create
data.language required initial language the user started in
data.assessment_result_id required data.assessment result
data.challenge_id required data.challenge

Request

Route

POST /v1/solutions

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q4YTU0ZDc1ZTJkYzFkMjRjOCIsImlkIjoiNWVjNmQ3ZDhhNTRkNzVlMmRjMWQyNGM5Iiwic2VjcmV0IjoiZDdWSDFBPT0ifQ.NZgtHLBgWT-1S2eo30S6curpv_2CKn9dhePuFpeJFrs

Body

{
  "data": {
    "$type": "CodeSolution",
    "assessment_result_id": "5ec6d7d8a54d75e2dc1d24c7",
    "challenge_id": "5ec6d7d8a54d75e2dc1d24c3",
    "language": "javascript"
  },
  "fetch": true
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7d8a54d75e2dc1d24ce",
  "type": "CodeSolution",
  "data": {
    "id": "5ec6d7d8a54d75e2dc1d24ce",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-05-21T19:34:48.248Z",
    "updatedAt": "2020-05-21T19:34:48.248Z",
    "challengeId": "5ec6d7d8a54d75e2dc1d24c3",
    "assessmentResultId": "5ec6d7d8a54d75e2dc1d24c7",
    "assessmentId": "5ec6d7d8a54d75e2dc1d24bf",
    "candidateId": "5ec6d7d8a54d75e2dc1d24c9",
    "teamCandidateId": "5ec6d7d8a54d75e2dc1d24ca",
    "teamId": "5ec6d7d7a54d75e2dc1d24b9",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": null,
    "completedAt": null,
    "code": null,
    "testCases": null,
    "testFramework": "cw-2",
    "attempts": 0,
    "output": null,
    "wallTime": null,
    "firstTestCompletedIn": null,
    "completedIn": null,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 0,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "hiddenTestCases": 0,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 0,
    "score": 0.0
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:48.288-07:00",
    "includes": []
  }
}

Update

This route is used as an alias to the subtype specific update. For example, this example maps to PUT /code_solutions/:id

Endpoint

PUT /v1/solutions/:id

Parameters

Name Description
data.$type required The type of solution to create
data.language The language that the user is taking the challenge in
data.code The user's solution code
data.test_cases The user's test case code
data.tag a revision tag
data.message a revision message

Request

Route

PUT /v1/solutions/5ec6d7d8a54d75e2dc1d24d7

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q4YTU0ZDc1ZTJkYzFkMjRkOCIsImlkIjoiNWVjNmQ3ZDhhNTRkNzVlMmRjMWQyNGQ5Iiwic2VjcmV0IjoiU3lpMUJRPT0ifQ.58YM8pLPkxJMZwRPumLoWKHrv4it4qlntB0ZDIy8zs0

Body

{
  "data": {
    "$type": "CodeSolution",
    "code": "var b = a = 1;",
    "tag": "paste"
  },
  "includes": [
    "revisions"
  ]
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7d8a54d75e2dc1d24d7",
  "type": "CodeSolution",
  "data": {
    "id": "5ec6d7d8a54d75e2dc1d24d7",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2020-05-21T19:33:48.482Z",
    "updatedAt": "2020-05-21T19:34:48.804Z",
    "challengeId": "5ec6d7d8a54d75e2dc1d24e7",
    "assessmentResultId": "5ec6d7d8a54d75e2dc1d24eb",
    "assessmentId": "5ec6d7d8a54d75e2dc1d24e3",
    "candidateId": "5ec6d7d8a54d75e2dc1d24d9",
    "teamCandidateId": "5ec6d7d8a54d75e2dc1d24da",
    "teamId": "5ec6d7d8a54d75e2dc1d24d1",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2020-05-21T19:34:48.483Z",
    "completedAt": "2020-05-21T19:34:48.483Z",
    "code": "var b = a = 1;",
    "testCases": "Test.assertEquals(a, 1)",
    "testFramework": "cw-2",
    "attempts": 1,
    "output": [
      {
        "t": "passed",
        "v": "Test Passed"
      }
    ],
    "wallTime": 40,
    "firstTestCompletedIn": 60.001,
    "completedIn": 60.001,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 1,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "hiddenTestCases": 0,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 2,
    "score": 100.0,
    "revisions": [
      {
        "id": "5ec6d7d8a54d75e2dc1d24ef",
        "createdAt": "2020-05-21T19:33:48.482Z",
        "number": 0,
        "message": null,
        "tag": null,
        "revisedAttributes": {
          "output": [
            {
              "t": "passed",
              "v": "Test Passed"
            }
          ],
          "wall_time": 40,
          "specs": null,
          "assertions": null,
          "passed_test_cases": 1,
          "response": null,
          "test_response": null,
          "test_attempts": 0,
          "test_passed_test_cases": 0,
          "test_total_test_cases": 0,
          "test_output": null,
          "test_wall_time": null,
          "code": "var a = 1;",
          "test_cases": "Test.assertEquals(a, 1)",
          "language": "javascript",
          "attempts": 1,
          "first_test_case_solved_at": "2020-05-21T19:34:48.483Z",
          "completed_at": "2020-05-21T19:34:48.483Z",
          "reopened_count": 0,
          "cursor": {}
        }
      },
      {
        "id": "5ec6d7d8a54d75e2dc1d24f0",
        "createdAt": "2020-05-21T19:34:48.741Z",
        "number": 1,
        "message": null,
        "tag": "paste",
        "revisedAttributes": {
          "code": "var b = a = 1;"
        }
      }
    ]
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:48.810-07:00",
    "includes": [
      "revisions"
    ]
  }
}

Team Candidate Briefs

Briefs are living report information. They are synced in the background after information related to a team candidate is changed. You can consume this data to implement your own reporting tools.

List

Endpoint

GET /v1/team_candidate_briefs

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/team_candidate_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q5YTU0ZDc1ZTJkYzFkMjUxMSIsImlkIjoiNWVjNmQ3ZDlhNTRkNzVlMmRjMWQyNTEyIiwic2VjcmV0IjoiZkdOd3RnPT0ifQ.qT-Qx3waH3-JuvOT9KFzefpdJfWcNZPoyhjrpX9m0uY

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "TeamCandidateBrief",
  "data": [
    {
      "id": "5ec6d7d9a54d75e2dc1d251e",
      "createdAt": "2020-05-21T19:34:49.489Z",
      "updatedAt": "2020-05-21T19:34:49.535Z",
      "teamId": "5ec6d7d9a54d75e2dc1d2515",
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2020-05-21T19:34:50.534Z",
      "syncs": 1,
      "candidateId": null,
      "firstName": "Joe",
      "lastName": "Smith628",
      "name": "Joe Smith628",
      "sortName": "Smith628, Joe",
      "anonymousName": "Cyan Swordfish",
      "email": "[email protected]",
      "state": "invited",
      "sortState": "1",
      "prevState": null,
      "nonArchivedState": "invited",
      "blinding": "blind_reviewers",
      "stems": "j jo joe s sm smi smit smith smith6 smith62 smith628 l lo log logi login logini loginid loginide e ex exa exam examp exampl example c cy cya cyan sw swo swor sword swordf swordfi swordfis",
      "labels": null,
      "languages": [],
      "redFlags": [],
      "assessmentResultReviews": [],
      "assessmentResults": [],
      "assignedTeamMemberIds": [],
      "reviewedByIds": [],
      "testTeamMember": false,
      "demoData": false,
      "forgotten": null,
      "recentlyAbandoned": false,
      "stateUpdatedAt": "2020-05-21T19:34:49.466Z",
      "teamCandidateUpdatedAt": "2020-05-21T19:34:49.466Z",
      "interactSessionsCount": 0,
      "solutionsCount": 0,
      "submittedAssessmentResultsCount": 0,
      "avgSubmissionScore": null,
      "risks": {
        "total": 0,
        "max": null
      },
      "sortScore": 0.0,
      "selectionScore": 0.0,
      "knownScore": null,
      "confidenceScore": 1.0,
      "opinionScore": null,
      "knownObjectivesScore": null,
      "knownQualitiesScore": null,
      "signalBandsCount": 0,
      "signalBands": {
        "construct_score": {},
        "strength": {},
        "strength_score": {}
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:34:49.563-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/team_candidate_briefs/:id

Request

Route

GET /v1/team_candidate_briefs/5ec6d7d9a54d75e2dc1d252e

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2Q5YTU0ZDc1ZTJkYzFkMjUyMSIsImlkIjoiNWVjNmQ3ZDlhNTRkNzVlMmRjMWQyNTIyIiwic2VjcmV0IjoiaVd2UkpRPT0ifQ.WMRHAw60gkYe_eqCMusb-wjORWEtufYTHQBwAFBS5Bc

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7d9a54d75e2dc1d252e",
  "type": "TeamCandidateBrief",
  "data": {
    "id": "5ec6d7d9a54d75e2dc1d252e",
    "createdAt": "2020-05-21T19:34:49.747Z",
    "updatedAt": "2020-05-21T19:34:49.795Z",
    "teamId": "5ec6d7d9a54d75e2dc1d2525",
    "lastSyncEnqueuedAt": null,
    "lastSyncedAt": "2020-05-21T19:34:50.794Z",
    "syncs": 1,
    "candidateId": null,
    "firstName": "Joe",
    "lastName": "Smith630",
    "name": "Joe Smith630",
    "sortName": "Smith630, Joe",
    "anonymousName": "Beige Echidna",
    "email": "[email protected]",
    "state": "invited",
    "sortState": "1",
    "prevState": null,
    "nonArchivedState": "invited",
    "blinding": "blind_reviewers",
    "stems": "j jo joe s sm smi smit smith smith6 smith63 smith630 l lo log logi login logini loginid loginide e ex exa exam examp exampl example b be bei beig beige ec ech echi echid echidn echidna",
    "labels": null,
    "languages": [],
    "redFlags": [],
    "assessmentResultReviews": [],
    "assessmentResults": [],
    "assignedTeamMemberIds": [],
    "reviewedByIds": [],
    "testTeamMember": false,
    "demoData": false,
    "forgotten": null,
    "recentlyAbandoned": false,
    "stateUpdatedAt": "2020-05-21T19:34:49.724Z",
    "teamCandidateUpdatedAt": "2020-05-21T19:34:49.724Z",
    "interactSessionsCount": 0,
    "solutionsCount": 0,
    "submittedAssessmentResultsCount": 0,
    "avgSubmissionScore": null,
    "risks": {
      "total": 0,
      "max": null
    },
    "sortScore": 0.0,
    "selectionScore": 0.0,
    "knownScore": null,
    "confidenceScore": 1.0,
    "opinionScore": null,
    "knownObjectivesScore": null,
    "knownQualitiesScore": null,
    "signalBandsCount": 0,
    "signalBands": {
      "construct_score": {},
      "strength": {},
      "strength_score": {}
    }
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:49.814-07:00",
    "includes": []
  }
}

Team Candidates

List

Endpoint

GET /v1/team_candidates

Parameters

Name Description
includes Valid values are: assessments, assessment_results, solutions

Request

Route

GET /v1/team_candidates

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2RhYTU0ZDc1ZTJkYzFkMjU1MCIsImlkIjoiNWVjNmQ3ZGFhNTRkNzVlMmRjMWQyNTUxIiwic2VjcmV0IjoieTVnbGFBPT0ifQ.azXX9GG_kzVJSXaGFR_RMgEbFleicNbmfzsETA5B0Zc

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "TeamCandidate",
  "data": [
    {
      "id": "5ec6d7d9a54d75e2dc1d2533",
      "candidateId": "5ec6d7d9a54d75e2dc1d2532",
      "teamId": "5ec6d7d9a54d75e2dc1d2536",
      "state": "started",
      "demoData": false,
      "prevState": null,
      "assessmentIds": [
        "5ec6d7d9a54d75e2dc1d253c",
        "5ec6d7daa54d75e2dc1d2548"
      ],
      "assessmentResultIds": [
        "5ec6d7daa54d75e2dc1d2544",
        "5ec6d7daa54d75e2dc1d254d"
      ],
      "blinding": "blind_reviewers",
      "createdAt": "2020-05-21T19:34:49.946Z",
      "updatedAt": "2020-05-21T19:34:50.134Z",
      "decidedAt": null,
      "invitedAt": null,
      "interactSessions": 0,
      "stateUpdatedAt": "2020-05-21T19:34:49.946Z",
      "testTeamMember": false,
      "assignedTeamMemberIds": [],
      "labels": null,
      "archived": false,
      "firstName": "Joe",
      "lastName": "Smith631",
      "anonymousName": "Mahogany Echidna",
      "email": "[email protected]",
      "name": "Joe Smith631",
      "isBlinded": false,
      "stateLabel": "Assessment Started",
      "stateTransitions": [
        "idle",
        "invited",
        "started",
        "submitted",
        "risk_detected",
        "reviewed",
        "approved",
        "rejected",
        "archived"
      ],
      "risks": null,
      "assessmentsRecap": {
        "id": "5ec6d7daa54d75e2dc1d2546",
        "subjects": [
          {
            "id": "5ec6d7daa54d75e2dc1d2547",
            "assessmentResultId": "5ec6d7daa54d75e2dc1d2544",
            "assessmentId": "5ec6d7d9a54d75e2dc1d253c",
            "state": "started"
          },
          {
            "id": "5ec6d7daa54d75e2dc1d254f",
            "assessmentResultId": "5ec6d7daa54d75e2dc1d254d",
            "assessmentId": "5ec6d7daa54d75e2dc1d2548",
            "state": "started"
          }
        ]
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:34:50.193-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/team_candidates/:id

Parameters

Name Description
id required Object ID
includes Valid values are: assessments, assessment_results, solutions, team

Request

Route

GET /v1/team_candidates/5ec6d7dca54d75e2dc1d25fb

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2RjYTU0ZDc1ZTJkYzFkMjYxOCIsImlkIjoiNWVjNmQ3ZGNhNTRkNzVlMmRjMWQyNjE5Iiwic2VjcmV0IjoiVCthZ3ZBPT0ifQ.GefmazMkn_PUHQMA4cnX5TSZJR35Dj2i-7_9jpkpxNs

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7dca54d75e2dc1d25fb",
  "type": "TeamCandidate",
  "data": {
    "id": "5ec6d7dca54d75e2dc1d25fb",
    "candidateId": "5ec6d7dca54d75e2dc1d25fa",
    "teamId": "5ec6d7dca54d75e2dc1d25fe",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5ec6d7dca54d75e2dc1d2604",
      "5ec6d7dca54d75e2dc1d2610"
    ],
    "assessmentResultIds": [
      "5ec6d7dca54d75e2dc1d260c",
      "5ec6d7dca54d75e2dc1d2615"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2020-05-21T19:34:52.381Z",
    "updatedAt": "2020-05-21T19:34:52.593Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2020-05-21T19:34:52.381Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": null,
    "archived": false,
    "firstName": "Joe",
    "lastName": "Smith648",
    "anonymousName": "Coral Penguin",
    "email": "[email protected]",
    "name": "Joe Smith648",
    "isBlinded": false,
    "stateLabel": "Assessment Started",
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "risk_detected",
      "reviewed",
      "approved",
      "rejected",
      "archived"
    ],
    "risks": null,
    "assessmentsRecap": {
      "id": "5ec6d7dca54d75e2dc1d260e",
      "subjects": [
        {
          "id": "5ec6d7dca54d75e2dc1d260f",
          "assessmentResultId": "5ec6d7dca54d75e2dc1d260c",
          "assessmentId": "5ec6d7dca54d75e2dc1d2604",
          "state": "started"
        },
        {
          "id": "5ec6d7dca54d75e2dc1d2617",
          "assessmentResultId": "5ec6d7dca54d75e2dc1d2615",
          "assessmentId": "5ec6d7dca54d75e2dc1d2610",
          "state": "started"
        }
      ]
    }
  },
  "meta": {
    "enums": {
      "blinding": [
        {
          "value": "none",
          "text": "None"
        },
        {
          "value": "blind_reviewers",
          "text": "Blind reviewers"
        },
        {
          "value": "restricted",
          "text": "Restricted"
        },
        {
          "value": "team",
          "text": "Team"
        }
      ],
      "state": [
        {
          "value": "idle",
          "text": "Idle"
        },
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Assessment Started"
        },
        {
          "value": "submitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "risk_detected",
          "text": "Plagiarism Risk Detected"
        },
        {
          "value": "reviewed",
          "text": "Assessment Reviewed"
        },
        {
          "value": "approved",
          "text": "Approved"
        },
        {
          "value": "rejected",
          "text": "Rejected"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ]
    },
    "timestamp": "2020-05-21T12:34:52.652-07:00",
    "includes": []
  }
}

Update

Updates basic info for a team candidate.

Endpoint

PUT /v1/team_candidates/:id

Parameters

Name Description
data.email A valid email
data.first_name data.first name
data.last_name data.last name
data.state Valid values are: started, submitted, approved, rejected

Request

Route

PUT /v1/team_candidates/5ec6d7dda54d75e2dc1d2655

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2RkYTU0ZDc1ZTJkYzFkMjY3MiIsImlkIjoiNWVjNmQ3ZGRhNTRkNzVlMmRjMWQyNjczIiwic2VjcmV0IjoiSDRiVW13PT0ifQ.AaK7JtVj_bjwWb_y8hH1p-RjeigepY7qj4jJOe-iyns

Body

{
  "data": {
    "first_name": "Test",
    "last_name": "Time"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7dda54d75e2dc1d2655",
  "type": "TeamCandidate",
  "data": {
    "id": "5ec6d7dda54d75e2dc1d2655",
    "candidateId": "5ec6d7dda54d75e2dc1d2654",
    "teamId": "5ec6d7dda54d75e2dc1d2658",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5ec6d7dda54d75e2dc1d265e",
      "5ec6d7dda54d75e2dc1d266a"
    ],
    "assessmentResultIds": [
      "5ec6d7dda54d75e2dc1d2666",
      "5ec6d7dda54d75e2dc1d266f"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2020-05-21T19:34:53.517Z",
    "updatedAt": "2020-05-21T19:34:53.795Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2020-05-21T19:34:53.517Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": [],
    "archived": false,
    "firstName": "Test",
    "lastName": "Time",
    "anonymousName": "Turquoise Coral",
    "email": "[email protected]",
    "name": "Test Time",
    "isBlinded": false,
    "stateLabel": "Assessment Started",
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "risk_detected",
      "reviewed",
      "approved",
      "rejected",
      "archived"
    ],
    "risks": null,
    "assessmentsRecap": {
      "id": "5ec6d7dda54d75e2dc1d2668",
      "subjects": [
        {
          "id": "5ec6d7dda54d75e2dc1d2669",
          "assessmentResultId": "5ec6d7dda54d75e2dc1d2666",
          "assessmentId": "5ec6d7dda54d75e2dc1d265e",
          "state": "started"
        },
        {
          "id": "5ec6d7dda54d75e2dc1d2671",
          "assessmentResultId": "5ec6d7dda54d75e2dc1d266f",
          "assessmentId": "5ec6d7dda54d75e2dc1d266a",
          "state": "started"
        }
      ]
    }
  },
  "meta": {
    "enums": {
      "blinding": [
        {
          "value": "none",
          "text": "None"
        },
        {
          "value": "blind_reviewers",
          "text": "Blind reviewers"
        },
        {
          "value": "restricted",
          "text": "Restricted"
        },
        {
          "value": "team",
          "text": "Team"
        }
      ],
      "state": [
        {
          "value": "idle",
          "text": "Idle"
        },
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Assessment Started"
        },
        {
          "value": "submitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "risk_detected",
          "text": "Plagiarism Risk Detected"
        },
        {
          "value": "reviewed",
          "text": "Assessment Reviewed"
        },
        {
          "value": "approved",
          "text": "Approved"
        },
        {
          "value": "rejected",
          "text": "Rejected"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ]
    },
    "timestamp": "2020-05-21T12:34:53.844-07:00",
    "includes": []
  }
}

Bulk Update

Endpoint

POST /v1/team_candidates/bulk_update

Parameters

Name Description
ids required ids of team candidates to process
bulk_action required the action to take: update, approve, cancel, reject, archive, restore
data.add_labels data.add labels
data.remove_labels data.remove labels
data.add_note a note to add to all candidates

Request

Route

POST /v1/team_candidates/bulk_update

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2RlYTU0ZDc1ZTJkYzFkMjY5NCIsImlkIjoiNWVjNmQ3ZGVhNTRkNzVlMmRjMWQyNjk1Iiwic2VjcmV0IjoiY2t0VlBRPT0ifQ.Zh4RG42foNekm2TgywHv1XJCS0GAw694OhPC-1LsDT4

Body

{
  "ids": [
    "5ec6d7dda54d75e2dc1d2677",
    "5ec6d7dea54d75e2dc1d2699"
  ],
  "bulk_action": "archive",
  "data": {
    "add_labels": [
      "Bulk Archived"
    ]
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7dea54d75e2dc1d269a",
  "type": "TeamCandidateBulkEditOperation",
  "data": {
    "id": "5ec6d7dea54d75e2dc1d269a",
    "action": "archive",
    "createdAt": "2020-05-21T19:34:54.280Z",
    "lastCompletionAt": null,
    "totalCount": 2,
    "completedCount": 0,
    "todoCount": 2,
    "completionPercentage": 0.0
  },
  "meta": {
    "timestamp": "2020-05-21T12:34:54.366-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/team_candidates/:id

Parameters

Name Description
id required base16 ObjectId

Request

Route

DELETE /v1/team_candidates/5ec6d7e2a54d75e2dc1d27d8

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2UyYTU0ZDc1ZTJkYzFkMjdmNiIsImlkIjoiNWVjNmQ3ZTJhNTRkNzVlMmRjMWQyN2Y3Iiwic2VjcmV0IjoiMkJIMG13PT0ifQ.V1FtE9YjkR7Skd8r98oYy79m4sb863YHoLWfAxDf4fc
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Team Members

List

Returns all non-staff members for admins

Endpoint

GET /v1/team_members

Request

Route

GET /v1/team_members

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2UzYTU0ZDc1ZTJkYzFkMjg0MSIsImlkIjoiNWVjNmQ3ZTNhNTRkNzVlMmRjMWQyODQyIiwic2VjcmV0IjoiSE5YdWFRPT0ifQ.vh8MeJOfTlmhtCpHaxxYXkKb8RqJuf28bO8z1pKjunw

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "TeamMember",
  "data": [
    {
      "id": "5ec6d7e3a54d75e2dc1d2839",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith712",
      "name": "Joe Smith712",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-05-21T19:34:59.447Z",
      "updatedAt": "2020-05-21T19:34:59.447Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_QHp2MPdWdrrmLpHbr20sYQ",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "5OHxbHm7sfpyGg.5ec6d7e3a54d75e2dc1d2839",
      "teamId": "5ec6d7e3a54d75e2dc1d282c",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-05-21T19:34:59.444Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5ec6d7e3a54d75e2dc1d283a",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5ec6d7e3a54d75e2dc1d2836",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith711",
      "name": "Joe Smith711",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-05-21T19:34:59.429Z",
      "updatedAt": "2020-05-21T19:34:59.429Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_JmgRR6Eh4iLh5bwrLdddew",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "SrcJwYHhwcw6jg.5ec6d7e3a54d75e2dc1d2836",
      "teamId": "5ec6d7e3a54d75e2dc1d282c",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-05-21T19:34:59.426Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5ec6d7e3a54d75e2dc1d2837",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5ec6d7e3a54d75e2dc1d2833",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith710",
      "name": "Joe Smith710",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-05-21T19:34:59.409Z",
      "updatedAt": "2020-05-21T19:34:59.409Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_2HqrHK8P2pz2PC9g3qfTyg",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "z45dxvL9pWszVQ.5ec6d7e3a54d75e2dc1d2833",
      "teamId": "5ec6d7e3a54d75e2dc1d282c",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-05-21T19:34:59.406Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5ec6d7e3a54d75e2dc1d2834",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5ec6d7e3a54d75e2dc1d2828",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith709",
      "name": "Joe Smith709",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-05-21T19:34:59.348Z",
      "updatedAt": "2020-05-21T19:34:59.348Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_NkKjiXwy40ZzMTaLaP4gnA",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "Kf5cgHiu5gh4Ng.5ec6d7e3a54d75e2dc1d2828",
      "teamId": "5ec6d7e3a54d75e2dc1d281e",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-05-21T19:34:59.345Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5ec6d7e3a54d75e2dc1d2829",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5ec6d7e3a54d75e2dc1d2825",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith708",
      "name": "Joe Smith708",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2020-05-21T19:34:59.316Z",
      "updatedAt": "2020-05-21T19:34:59.316Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_AB4XUS7bYt2Lbc8zbWbBBA",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "BG49q60gfDNA0Q.5ec6d7e3a54d75e2dc1d2825",
      "teamId": "5ec6d7e3a54d75e2dc1d281e",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "activatedAt": "2020-05-21T19:34:59.313Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5ec6d7e3a54d75e2dc1d2826",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 5,
  "meta": {
    "timestamp": "2020-05-21T12:34:59.545-07:00",
    "includes": []
  }
}

Get

Returns the team member account if the current user can view it

Endpoint

GET /v1/team_members/:id

Parameters

Name Description
includes Valid values are: team, authored_challenges, authored_assessments

Request

Route

GET /v1/team_members/5ec6d7e4a54d75e2dc1d28bd?includes[]=team&includes[]=authored_challenges&includes[]=authored_assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2U0YTU0ZDc1ZTJkYzFkMjhiZiIsImlkIjoiNWVjNmQ3ZTRhNTRkNzVlMmRjMWQyOGMwIiwic2VjcmV0IjoiNEhnOTJRPT0ifQ.9sojCEs6EpVKYa46vlrcmi6ayQcjGfZGL69dymMkPw4

Query Parameters

includes=["team", "authored_challenges", "authored_assessments"]

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7e4a54d75e2dc1d28bd",
  "type": "TeamMember",
  "data": {
    "id": "5ec6d7e4a54d75e2dc1d28bd",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith737",
    "name": "Joe Smith737",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-05-21T19:35:00.658Z",
    "updatedAt": "2020-05-21T19:35:00.658Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_mzy4k9EsGPr4KpKASpYLrg",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "jniOktptb9EG4w.5ec6d7e4a54d75e2dc1d28bd",
    "teamId": "5ec6d7e4a54d75e2dc1d28b6",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "team": {
      "id": "5ec6d7e4a54d75e2dc1d28b6",
      "name": "team311",
      "updatedAt": "2020-05-21T19:35:00.621Z",
      "highConcept": null,
      "website": null,
      "productTypes": {
        "_id": "5ec6d7e4a54d75e2dc1d28b9",
        "education": true,
        "recruitment": true
      },
      "customerId": "5ec6d7e4a54d75e2dc1d28b4",
      "hasDemoData": false,
      "buildingDemoData": false,
      "destroyingDemoData": false,
      "surveysDisabled": null,
      "defaultEnableExternalIde": true,
      "labs": {
        "externalIde": false
      },
      "logoImg": {
        "id": "5ec6d7e4a54d75e2dc1d28b8",
        "fileId": "ri7vQA",
        "fileFormat": "jpg",
        "width": 500,
        "height": 500,
        "url": "//res.cloudinary.com/strive/image/upload/ri7vQA.jpg",
        "rawUrl": "https://s3-us-west-1.amazonaws.com/strive-uploads/ri7vQA.jpg",
        "size": null,
        "brightness": null,
        "background": null
      },
      "createdAt": "2020-05-21T19:35:00.621Z",
      "state": "inactive",
      "assessmentsEnabled": true,
      "publishedAssessmentCount": 0,
      "assessmentResultCount": 0,
      "growthSpeed": "high_growth",
      "companySize": null,
      "engineeringTeamSize": null,
      "referenceInfo": null,
      "notificationScheme": "entire_team",
      "setupAssessmentId": null,
      "setupComplete": false,
      "desiredLanguages": null,
      "assessmentNounUpper": "Assessment",
      "showReviewsToReviewers": false,
      "unblindAfterDecision": false,
      "loginProviders": [
        "qualified"
      ],
      "primaryTeam": true,
      "bambooConfig": {
        "id": "5ec6d7e4a54d75e2dc1d28c1",
        "subdomain": null,
        "url": null,
        "jobStatuses": null,
        "jobs": null,
        "lastPollAt": null
      },
      "bambooConnected": false,
      "apiKey": null,
      "zapierApiKey": null,
      "greenhouseApiKey": null,
      "embedClientKey": null,
      "workableApiKey": null,
      "hasBlindReviewers": false,
      "msaSigned": false,
      "desiredFeatures": {
        "id": "5ec6d7e4a54d75e2dc1d28bb",
        "takeHome": true
      },
      "progressEvents": {
        "id": "5ec6d7e4a54d75e2dc1d28c2"
      },
      "nameWasGenerated": false,
      "teamMemberRoleCounts": {
        "owner": 1
      },
      "desiredIntegration": null,
      "desiredIntegrationIsCurrent": null,
      "evaluatedCandidatesMonthly": null,
      "evaluatedCandidatesYearly": null,
      "msaSignedAt": null,
      "msaSignedById": null,
      "samlIssuer": null,
      "samlMetadata": null,
      "samlMetadataUrl": null,
      "utmTracking": {
        "id": "5ec6d7e4a54d75e2dc1d28ba",
        "utmSource": "qualified"
      }
    },
    "activatedAt": "2020-05-21T19:35:00.655Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5ec6d7e4a54d75e2dc1d28be",
      "assessmentStarted": true,
      "assessmentSubmitted": true,
      "assessmentResultReviewSubmitted": true,
      "candidateApproved": true,
      "candidateRejected": true,
      "noteAdded": true
    },
    "phone": null,
    "title": null,
    "authoredAssessments": [],
    "authoredChallenges": [],
    "initialUser": false
  },
  "meta": {
    "enums": {
      "role": [
        {
          "value": "owner",
          "text": "Account Manager"
        },
        {
          "value": "inviter",
          "text": "Manager"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind Reviewer"
        },
        {
          "value": "staff",
          "text": "Qualified Staff Member"
        },
        {
          "value": "api",
          "text": "API"
        },
        {
          "value": "demo",
          "text": "Demo Team Member"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "active",
          "text": "Active"
        },
        {
          "value": "inactive",
          "text": "Inactive"
        }
      ]
    },
    "flags": {
      "notifications": [
        {
          "value": "assessmentStarted",
          "text": "Assessment Started"
        },
        {
          "value": "assessmentSubmitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "assessmentResultReviewSubmitted",
          "text": "Assessment Review Submitted"
        },
        {
          "value": "candidateApproved",
          "text": "Candidate Approved"
        },
        {
          "value": "candidateRejected",
          "text": "Candidate Rejected"
        },
        {
          "value": "noteAdded",
          "text": "Note added"
        }
      ]
    },
    "timestamp": "2020-05-21T12:35:00.723-07:00",
    "includes": [
      "team",
      "authored_challenges",
      "authored_assessments"
    ]
  }
}

Create

Creates a new team member user. This API is allowed only for authenticated admin and team owners.

Endpoint

POST /v1/team_members

Parameters

Name Description
data.email required A valid email
data.first_name required data.first name
data.last_name required data.last name
data.password data.password
data.bio data.bio
data.teamId required The team must be created first. Not required if team member is authenticated user
data.ui_prefs A json object for storing custom client-side preferences

Request

Route

POST /v1/team_members

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2U0YTU0ZDc1ZTJkYzFkMjhjMyIsImlkIjoiNWVjNmQ3ZTRhNTRkNzVlMmRjMWQyOGM0Iiwic2VjcmV0IjoiclZtUE5BPT0ifQ.R3-DMGrBSL_1JcjjgBZPVgrYw7zmkLbOWOm0XbFgIUw

Body

{
  "data": {
    "first_name": "Joe",
    "last_name": "Smith",
    "password": "password",
    "email": "[email protected]",
    "team_id": "5ec6d7e4a54d75e2dc1d28c7"
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7e4a54d75e2dc1d28ce",
  "type": "TeamMember",
  "data": {
    "id": "5ec6d7e4a54d75e2dc1d28ce",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith",
    "name": "Joe Smith",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-05-21T19:35:00.875Z",
    "updatedAt": "2020-05-21T19:35:00.875Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_FZrUs7EcwdFGjEgzKpbGww",
    "hasPassword": false,
    "intercomUrl": null,
    "confirmationToken": "thLE2tdWdckbQQ.5ec6d7e4a54d75e2dc1d28ce",
    "teamId": "5ec6d7e4a54d75e2dc1d28c7",
    "role": "owner",
    "state": "invited",
    "disabled": false,
    "activatedAt": "2020-05-21T19:35:00.875Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5ec6d7e4a54d75e2dc1d28cf",
      "assessmentStarted": true,
      "assessmentSubmitted": true,
      "assessmentResultReviewSubmitted": true,
      "candidateApproved": true,
      "candidateRejected": true,
      "noteAdded": true
    },
    "phone": null,
    "title": null,
    "initialUser": false
  },
  "meta": {
    "enums": {
      "role": [
        {
          "value": "owner",
          "text": "Account Manager"
        },
        {
          "value": "inviter",
          "text": "Manager"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind Reviewer"
        },
        {
          "value": "staff",
          "text": "Qualified Staff Member"
        },
        {
          "value": "api",
          "text": "API"
        },
        {
          "value": "demo",
          "text": "Demo Team Member"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "active",
          "text": "Active"
        },
        {
          "value": "inactive",
          "text": "Inactive"
        }
      ]
    },
    "flags": {
      "notifications": [
        {
          "value": "assessmentStarted",
          "text": "Assessment Started"
        },
        {
          "value": "assessmentSubmitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "assessmentResultReviewSubmitted",
          "text": "Assessment Review Submitted"
        },
        {
          "value": "candidateApproved",
          "text": "Candidate Approved"
        },
        {
          "value": "candidateRejected",
          "text": "Candidate Rejected"
        },
        {
          "value": "noteAdded",
          "text": "Note added"
        }
      ]
    },
    "timestamp": "2020-05-21T12:35:00.884-07:00",
    "includes": []
  }
}

Update

Updates a team member.

Endpoint

PUT /v1/team_members/:id

Parameters

Name Description
data.email A valid email
data.first_name data.first name
data.last_name data.last name
data.suffix data.suffix
data.bio data.bio
data.ui_prefs A json object for storing custom client-side preferences

Request

Route

PUT /v1/team_members/5ec6d7e4a54d75e2dc1d28d3

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2U0YTU0ZDc1ZTJkYzFkMjhkMCIsImlkIjoiNWVjNmQ3ZTRhNTRkNzVlMmRjMWQyOGQxIiwic2VjcmV0IjoiWDNCQkZBPT0ifQ.f7GJX7CxKaxzjM4J5wt6sD0dqmHF8BeGO3Jy6NjuTz8

Body

{
  "data": {
    "first_name": "Test",
    "last_name": "Time",
    "uiPrefs": {
      "theme": "dark"
    }
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7e4a54d75e2dc1d28d3",
  "type": "TeamMember",
  "data": {
    "id": "5ec6d7e4a54d75e2dc1d28d3",
    "$type": "TeamMember",
    "firstName": "Test",
    "lastName": "Time",
    "name": "Test Time",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2020-05-21T19:35:01.035Z",
    "updatedAt": "2020-05-21T19:35:01.075Z",
    "uiPrefs": {
      "theme": "dark"
    },
    "experiments": null,
    "envRoomId": "test_vLHdcxzASgHGaPMrBZGxRw",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "mzpG4qeCyU3YOQ.5ec6d7e4a54d75e2dc1d28d3",
    "teamId": "5ec6d7e5a54d75e2dc1d28d6",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "activatedAt": "2020-05-21T19:35:00.964Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5ec6d7e5a54d75e2dc1d28dc",
      "assessmentStarted": true,
      "assessmentSubmitted": true,
      "assessmentResultReviewSubmitted": true,
      "candidateApproved": true,
      "candidateRejected": true,
      "noteAdded": true
    },
    "phone": null,
    "title": null,
    "initialUser": false
  },
  "meta": {
    "enums": {
      "role": [
        {
          "value": "owner",
          "text": "Account Manager"
        },
        {
          "value": "inviter",
          "text": "Manager"
        },
        {
          "value": "reviewer",
          "text": "Reviewer"
        },
        {
          "value": "blind_reviewer",
          "text": "Blind Reviewer"
        },
        {
          "value": "staff",
          "text": "Qualified Staff Member"
        },
        {
          "value": "api",
          "text": "API"
        },
        {
          "value": "demo",
          "text": "Demo Team Member"
        }
      ],
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "active",
          "text": "Active"
        },
        {
          "value": "inactive",
          "text": "Inactive"
        }
      ]
    },
    "flags": {
      "notifications": [
        {
          "value": "assessmentStarted",
          "text": "Assessment Started"
        },
        {
          "value": "assessmentSubmitted",
          "text": "Assessment Submitted"
        },
        {
          "value": "assessmentResultReviewSubmitted",
          "text": "Assessment Review Submitted"
        },
        {
          "value": "candidateApproved",
          "text": "Candidate Approved"
        },
        {
          "value": "candidateRejected",
          "text": "Candidate Rejected"
        },
        {
          "value": "noteAdded",
          "text": "Note added"
        }
      ]
    },
    "timestamp": "2020-05-21T12:35:01.082-07:00",
    "includes": []
  }
}

Webhook Examples

Resources for simulating and firing webhooks for a given resource and event. Note that the data returned is in snake case, as opposed to camel case. This is because webhook data does not support camel casing, unlike the data normally returned by the API.

Simulate Team Candidate Started Assessment Response

Endpoint

GET /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to simulate
event required snake cased name of the event to simulate
type required Resource type name to be simulated, i.e. Challenge

Request

Route

GET /v1/webhook_examples/5ec6d7eba54d75e2dc1d2bde?type=AssessmentResult&event=team_candidate.started_assessment

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2VhYTU0ZDc1ZTJkYzFkMmJjZSIsImlkIjoiNWVjNmQ3ZWFhNTRkNzVlMmRjMWQyYmNmIiwic2VjcmV0IjoiMXV1VEp3PT0ifQ.ebcaH1SVD0fhHwxceTAuaoosjqq3DGzikEsdhHpJz9E

Query Parameters

type=AssessmentResult
event=team_candidate.started_assessment

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "team_candidate_started_assessment",
  "data": {
    "abandoned": false,
    "accumulated_seconds": 0,
    "browser_user_agent": null,
    "candidate_remarks": null,
    "dry_run": false,
    "invited_at": null,
    "redirect_url": null,
    "review_ratings": {},
    "score": 0.0,
    "started_at": "2020-05-21T19:35:07.222Z",
    "state": "started",
    "submitted_at": null,
    "workflow_name": null,
    "workflow_path_id": null,
    "workflow_trigger": null,
    "id": "5ec6d7eba54d75e2dc1d2bde",
    "candidate": {
      "email": "[email protected]",
      "first_name": "Joe",
      "last_name": "Smith772"
    },
    "team_candidate": {
      "anonymous_name": "Aqua Dolphin",
      "prev_state": null,
      "state": "started",
      "id": "5ec6d7eba54d75e2dc1d2be1"
    },
    "assessment": {
      "labels": null,
      "title": "Mid-Level Node Engineer #197",
      "id": "5ec6d7eba54d75e2dc1d2bd9"
    },
    "solutions": [
      {
        "_type": "CodeSolution",
        "attempts": 1,
        "completed_at": "2020-05-21T19:35:07.261Z",
        "first_test_case_solved_at": "2020-05-21T19:35:07.261Z",
        "language": "javascript",
        "passed_test_cases": 1,
        "score": 0.0,
        "total_test_cases": 1,
        "wall_time": 40,
        "id": "5ec6d7eba54d75e2dc1d2be5",
        "challenge": {
          "_type": "CodeChallenge",
          "title": "Large Events #307",
          "estimated_time": 2,
          "topics": [
            "Logic"
          ],
          "summary": null,
          "purpose": null,
          "id": "5ec6d7eba54d75e2dc1d2bda"
        }
      }
    ]
  }
}

Simulate Team Candidate Submitted Assessment Response

Endpoint

GET /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to simulate
event required snake cased name of the event to simulate
type required Resource type name to be simulated, i.e. Challenge

Request

Route

GET /v1/webhook_examples/5ec6d7eba54d75e2dc1d2bf7?type=AssessmentResult&event=team_candidate.submitted_assessment

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2ViYTU0ZDc1ZTJkYzFkMmJlNyIsImlkIjoiNWVjNmQ3ZWJhNTRkNzVlMmRjMWQyYmU4Iiwic2VjcmV0IjoidjY3YXdRPT0ifQ.QS6Tmaapww1m623hBUz5qvIeOv6zMs6D0-PncouwUXE

Query Parameters

type=AssessmentResult
event=team_candidate.submitted_assessment

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "team_candidate_submitted_assessment",
  "data": {
    "abandoned": false,
    "accumulated_seconds": 0,
    "browser_user_agent": null,
    "candidate_remarks": null,
    "dry_run": false,
    "invited_at": null,
    "redirect_url": null,
    "review_ratings": {},
    "score": 0.0,
    "started_at": null,
    "state": "submitted",
    "submitted_at": "2020-05-21T19:35:07.590Z",
    "workflow_name": null,
    "workflow_path_id": null,
    "workflow_trigger": null,
    "id": "5ec6d7eba54d75e2dc1d2bf7",
    "candidate": {
      "email": "[email protected]",
      "first_name": "Joe",
      "last_name": "Smith774"
    },
    "team_candidate": {
      "anonymous_name": "Lilac Hedgehog",
      "prev_state": "invited",
      "state": "submitted",
      "id": "5ec6d7eba54d75e2dc1d2bfa"
    },
    "assessment": {
      "labels": null,
      "title": "Junior Rails Developer #198",
      "id": "5ec6d7eba54d75e2dc1d2bf2"
    },
    "solutions": [
      {
        "_type": "CodeSolution",
        "attempts": 1,
        "completed_at": "2020-05-21T19:35:07.632Z",
        "first_test_case_solved_at": "2020-05-21T19:35:07.632Z",
        "language": "javascript",
        "passed_test_cases": 1,
        "score": 0.0,
        "total_test_cases": 1,
        "wall_time": 40,
        "id": "5ec6d7eba54d75e2dc1d2bfe",
        "challenge": {
          "_type": "CodeChallenge",
          "title": "Async Sequence #308",
          "estimated_time": 2,
          "topics": [
            "Algorithms"
          ],
          "summary": null,
          "purpose": null,
          "id": "5ec6d7eba54d75e2dc1d2bf3"
        }
      }
    ]
  }
}

Simulate Solution Updated Response

Endpoint

GET /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to simulate
event required snake cased name of the event to simulate
type required Resource type name to be simulated, i.e. Challenge

Request

Route

GET /v1/webhook_examples/5ec6d7eba54d75e2dc1d2c0b?type=Solution&event=solution.updated

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2ViYTU0ZDc1ZTJkYzFkMmMwMCIsImlkIjoiNWVjNmQ3ZWJhNTRkNzVlMmRjMWQyYzAxIiwic2VjcmV0IjoiWDFoVnVnPT0ifQ.sBNIWUM9STMk2eJ21glRGIWdqbfloUGRAueE37ZOaLs

Query Parameters

type=Solution
event=solution.updated

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "solution_updated",
  "data": {
    "_type": "CodeSolution",
    "assessment_id": "5ec6d7eba54d75e2dc1d2c17",
    "assessment_result_id": "5ec6d7eba54d75e2dc1d2c1f",
    "attempts": 1,
    "completed_at": "2020-05-21T19:35:07.870Z",
    "first_test_case_solved_at": "2020-05-21T19:35:07.870Z",
    "language": "javascript",
    "passed_test_cases": 1,
    "score": 0.0,
    "team_candidate_id": "5ec6d7eba54d75e2dc1d2c0e",
    "team_id": "5ec6d7eba54d75e2dc1d2c04",
    "total_test_cases": 1,
    "wall_time": 40,
    "id": "5ec6d7eba54d75e2dc1d2c0b",
    "challenge": {
      "_type": "CodeChallenge",
      "title": "Cipher Helper #309",
      "estimated_time": 2,
      "topics": [
        "Algorithms"
      ],
      "summary": null,
      "purpose": null,
      "id": "5ec6d7eba54d75e2dc1d2c1b"
    }
  }
}

Simulate Team Candidate State Changed Response

Endpoint

GET /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to simulate
event required snake cased name of the event to simulate
type required Resource type name to be simulated, i.e. Challenge

Request

Route

GET /v1/webhook_examples/5ec6d7eca54d75e2dc1d2c31?type=TeamCandidate&event=team_candidate.state_changed

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2VjYTU0ZDc1ZTJkYzFkMmMyNCIsImlkIjoiNWVjNmQ3ZWNhNTRkNzVlMmRjMWQyYzI1Iiwic2VjcmV0IjoidjZlbFBBPT0ifQ.jqCq195Rz1CuU4GLEGGgBGZcFD1o-nqi29SLqdApQd8

Query Parameters

type=TeamCandidate
event=team_candidate.state_changed

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "team_candidate_state_changed",
  "data": {
    "anonymous_name": "Silver Muskox",
    "email": "[email protected]",
    "first_name": "Joe",
    "labels": null,
    "last_name": "Smith779",
    "name": "Joe Smith779",
    "prev_state": null,
    "state": "invited",
    "test_team_member": false,
    "id": "5ec6d7eca54d75e2dc1d2c31",
    "highest_score": null,
    "assessment_results_count": 0
  }
}

Trigger Solution Updated Hook

Triggers a web hook to be sent to the url provided, allowing you to test what its like for the system to send hooks

Endpoint

POST /v1/webhook_examples/:id

Parameters

Name Description
id required ID of the model to trigger
event required snake cased name of the event to trigger
type required Resource type name to be triggered, i.e. Challenge, Solution, TeamCandidate, Note
url required URL to send the webhook to

Request

Route

POST /v1/webhook_examples/5ec6d7eca54d75e2dc1d2c3e

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2VjYTU0ZDc1ZTJkYzFkMmMzMyIsImlkIjoiNWVjNmQ3ZWNhNTRkNzVlMmRjMWQyYzM0Iiwic2VjcmV0IjoiUFNMYkFBPT0ifQ.ZxDXng3u9Lo7Tn0uSkjRB8x3aOe7-tJlc8oZlAWTnKw

Body

{
  "type": "Solution",
  "event": "solution_updated",
  "url": "https://example.com/hook"
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "event": "solution_updated",
  "data": {
    "_type": "CodeSolution",
    "assessment_id": "5ec6d7eca54d75e2dc1d2c4a",
    "assessment_result_id": "5ec6d7eca54d75e2dc1d2c52",
    "attempts": 1,
    "completed_at": "2020-05-21T19:35:08.457Z",
    "first_test_case_solved_at": "2020-05-21T19:35:08.457Z",
    "language": "javascript",
    "passed_test_cases": 1,
    "score": 0.0,
    "team_candidate_id": "5ec6d7eca54d75e2dc1d2c41",
    "team_id": "5ec6d7eca54d75e2dc1d2c37",
    "total_test_cases": 1,
    "wall_time": 40,
    "id": "5ec6d7eca54d75e2dc1d2c3e",
    "challenge": {
      "_type": "CodeChallenge",
      "title": "Travel Methods #310",
      "estimated_time": 2,
      "topics": [
        "Fundamentals"
      ],
      "summary": null,
      "purpose": null,
      "id": "5ec6d7eca54d75e2dc1d2c4e"
    }
  }
}

Webhook Subscriptions

List

Endpoint

GET /v1/webhook_subscriptions

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/webhook_subscriptions

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2VjYTU0ZDc1ZTJkYzFkMmM1OCIsImlkIjoiNWVjNmQ3ZWNhNTRkNzVlMmRjMWQyYzU5Iiwic2VjcmV0IjoiVGs5QlFBPT0ifQ.OlGpueXXFe8OnyymcD9Z2ekHOIRAJY0E2-OCBwcTlNw

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "type": "WebhookSubscription",
  "data": [
    {
      "id": "5ec6d7eca54d75e2dc1d2c63",
      "name": "Default",
      "url": "https://www.test.com/hxbsy",
      "schema": "v1",
      "triggerOnAll": false,
      "eventTriggers": {
        "id": "5ec6d7eca54d75e2dc1d2c64",
        "challengeCreated": true
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2020-05-21T12:35:08.951-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/webhook_subscriptions/:id

Request

Route

GET /v1/webhook_subscriptions/5ec6d7eda54d75e2dc1d2c70

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2VjYTU0ZDc1ZTJkYzFkMmM2NSIsImlkIjoiNWVjNmQ3ZWRhNTRkNzVlMmRjMWQyYzY2Iiwic2VjcmV0IjoiSXZCL09nPT0ifQ.JMHcfwiWJ-ZSGs4EMtz5h3iJ4nPEJlcoJ4b5KxGTmYM

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7eda54d75e2dc1d2c70",
  "type": "WebhookSubscription",
  "data": {
    "id": "5ec6d7eda54d75e2dc1d2c70",
    "name": "Default",
    "url": "https://www.test.com/eyxoc",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5ec6d7eda54d75e2dc1d2c71",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-05-21T12:35:09.130-07:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/webhook_subscriptions

Parameters

Name Description
data.url required data.url
data.eventTriggers Object
data.triggerOnAll Boolean

Request

Route

POST /v1/webhook_subscriptions

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2VkYTU0ZDc1ZTJkYzFkMmM3MiIsImlkIjoiNWVjNmQ3ZWRhNTRkNzVlMmRjMWQyYzczIiwic2VjcmV0IjoiMWp0V0p3PT0ifQ.dxaFn7ErBcjl_JV_J4Yxfi7IIk34VHWCmCqjiih3yJY

Body

{
  "data": {
    "name": "My Hook",
    "url": "https://www.test.com/d8d3fa",
    "eventTriggers": {
      "challenge_created": true
    }
  }
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7eda54d75e2dc1d2c7d",
  "type": "WebhookSubscription",
  "data": {
    "id": "5ec6d7eda54d75e2dc1d2c7d",
    "name": "My Hook",
    "url": "https://www.test.com/d8d3fa",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5ec6d7eda54d75e2dc1d2c7e",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-05-21T12:35:09.312-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/webhook_subscriptions/:id

Parameters

Name Description
data.url required data.url
data.eventTriggers Object
data.triggerOnAll Boolean

Request

Route

PUT /v1/webhook_subscriptions/5ec6d7eda54d75e2dc1d2c99

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2VkYTU0ZDc1ZTJkYzFkMmM4ZSIsImlkIjoiNWVjNmQ3ZWRhNTRkNzVlMmRjMWQyYzhmIiwic2VjcmV0IjoiekNBMlRRPT0ifQ.h1aDPhdxU7RPZZzM0HSDIT_loZrvU6dofeBZTGEPndg

Body

{
  "data": {
    "name": "My Hook"
  },
  "includes": []
}

Response

Simulated Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": "5ec6d7eda54d75e2dc1d2c99",
  "type": "WebhookSubscription",
  "data": {
    "id": "5ec6d7eda54d75e2dc1d2c99",
    "name": "My Hook",
    "url": "https://www.test.com/rubgm",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5ec6d7eda54d75e2dc1d2c9a",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2020-05-21T12:35:09.716-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/webhook_subscriptions/:id

Request

Route

DELETE /v1/webhook_subscriptions/5ec6d7eda54d75e2dc1d2ca6

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVlYzZkN2VkYTU0ZDc1ZTJkYzFkMmM5YiIsImlkIjoiNWVjNmQ3ZWRhNTRkNzVlMmRjMWQyYzljIiwic2VjcmV0IjoiYjBLWm5RPT0ifQ.vdSRkMc6ylTqVat6rVTzusqINGnO_1mtIG0fpUVhCQ0
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Delete By Url

Endpoint

DELETE /v1/webhook_subscriptions/url?url=:url

Request

Route

DELETE /v1/webhook_subscriptions/url?url=https://www.test.com/jpsef

Headers

Authorization: gWZWJxJSy26q3tGUU8GhnxJe5rFB+VGt
Content-Type: application/x-www-form-urlencoded

Query Parameters

url=https://www.test.com/jpsef

Response

Simulated Response

Status

204