Qualified API Documentation

The API is currently in beta and as such is subject to change. If you have a request for a specific integration endpoint not documented here, please reach out to at [email protected], or via our help feature within the app.

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.




Assessment Challenge Items

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/5d9d27fbeea25f27419d0b6d/challenge_items/

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyN2ZiZWVhMjVmMjc0MTlkMGI2ZSIsImlkIjoiNWQ5ZDI3ZmJlZWEyNWYyNzQxOWQwYjZmIiwic2VjcmV0IjoiR3ZlSG5BPT0ifQ.-pRs0H-8AuM0i-qDFuiji-fKftRmiC2nwtx7LvL_gPk

Body

{
  "data": {
    "challenge_id": "5d9d27fbeea25f27419d0b71"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d27fbeea25f27419d0b77",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5d9d27fbeea25f27419d0b77",
    "challengeId": "5d9d27fbeea25f27419d0b71",
    "position": 1,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2019-10-08T17:21:15.786-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/5d9d27fbeea25f27419d0b80/challenge_items/5d9d27fbeea25f27419d0b87

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyN2ZiZWVhMjVmMjc0MTlkMGI4MSIsImlkIjoiNWQ5ZDI3ZmJlZWEyNWYyNzQxOWQwYjgyIiwic2VjcmV0Ijoic3l4SHlBPT0ifQ.T9Ybqdl1UVjE6HOcPXZGcykduXZlZKAY48C4pfhNJOo

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d27fbeea25f27419d0b87",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5d9d27fbeea25f27419d0b87",
    "challengeId": "5d9d27fbeea25f27419d0b84",
    "position": 2,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2019-10-08T17:21:16.037-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/5d9d27fceea25f27419d0b94/challenge_items/5d9d27fceea25f27419d0b9b

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyN2ZjZWVhMjVmMjc0MTlkMGI5NSIsImlkIjoiNWQ5ZDI3ZmNlZWEyNWYyNzQxOWQwYjk2Iiwic2VjcmV0Ijoia0FkMlN3PT0ifQ.m8jkz6gyNnlHRtcR4wn6OWU60COXad-Jih5_pYaxH8U
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Assessment Invitations

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.eyJpZGVudGl0eV9pZCI6IjVkOWQyN2ZjZWVhMjVmMjc0MTlkMGJhNCIsImlkIjoiNWQ5ZDI3ZmNlZWEyNWYyNzQxOWQwYmE1Iiwic2VjcmV0IjoiT2pFNFNRPT0ifQ.k45d523li3mdYqX7wrtCUrFHJnfRd0HNiGVP1E8eKCQ

Query Parameters

{}=

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5d9d27fceea25f27419d0bb9",
      "state": "active",
      "teamCandidateId": "5d9d27fceea25f27419d0bc1",
      "assessmentId": "5d9d27fceea25f27419d0bba",
      "assessmentResultId": "5d9d27fceea25f27419d0bc5",
      "teamId": "5d9d27fceea25f27419d0b9e",
      "teamMemberId": "5d9d27fceea25f27419d0bc3",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Junior Angular Engineer #101",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith124",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5d9d27fceea25f27419d0bba?activate=4MxuRrCbss3Bsw.5d9d27fceea25f27419d0bc0&email=loginidentity124%40example.com&invite=By8rS6iJR3PqfA",
      "invitePracticePath": "/assess/practice-cc?activate=4MxuRrCbss3Bsw.5d9d27fceea25f27419d0bc0&email=loginidentity124%40example.com&invite=By8rS6iJR3PqfA&returnTo=%2Fassess%2F5d9d27fceea25f27419d0bba%3Factivate%3D4MxuRrCbss3Bsw.5d9d27fceea25f27419d0bc0%26email%3Dloginidentity124%2540example.com%26invite%3DBy8rS6iJR3PqfA"
    },
    {
      "id": "5d9d27fceea25f27419d0bc9",
      "state": "active",
      "teamCandidateId": "5d9d27fceea25f27419d0bd1",
      "assessmentId": "5d9d27fceea25f27419d0bca",
      "assessmentResultId": "5d9d27fceea25f27419d0bd5",
      "teamId": "5d9d27fceea25f27419d0b9e",
      "teamMemberId": "5d9d27fceea25f27419d0bd3",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Senior JavaScript Developer #102",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith126",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5d9d27fceea25f27419d0bca?activate=scpks0tgkExgbg.5d9d27fceea25f27419d0bd0&email=loginidentity126%40example.com&invite=dwPULpZub3z9aA",
      "invitePracticePath": "/assess/practice-cc?activate=scpks0tgkExgbg.5d9d27fceea25f27419d0bd0&email=loginidentity126%40example.com&invite=dwPULpZub3z9aA&returnTo=%2Fassess%2F5d9d27fceea25f27419d0bca%3Factivate%3Dscpks0tgkExgbg.5d9d27fceea25f27419d0bd0%26email%3Dloginidentity126%2540example.com%26invite%3DdwPULpZub3z9aA"
    },
    {
      "id": "5d9d27fceea25f27419d0bd9",
      "state": "active",
      "teamCandidateId": "5d9d27fceea25f27419d0be1",
      "assessmentId": "5d9d27fceea25f27419d0bda",
      "assessmentResultId": "5d9d27fceea25f27419d0be5",
      "teamId": "5d9d27fceea25f27419d0b9e",
      "teamMemberId": "5d9d27fceea25f27419d0be3",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Mid-Level Django Developer #103",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith128",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5d9d27fceea25f27419d0bda?activate=mRdFcUgXA3LEuw.5d9d27fceea25f27419d0be0&email=loginidentity128%40example.com&invite=rFoHveewMRmrKg",
      "invitePracticePath": "/assess/practice-cc?activate=mRdFcUgXA3LEuw.5d9d27fceea25f27419d0be0&email=loginidentity128%40example.com&invite=rFoHveewMRmrKg&returnTo=%2Fassess%2F5d9d27fceea25f27419d0bda%3Factivate%3DmRdFcUgXA3LEuw.5d9d27fceea25f27419d0be0%26email%3Dloginidentity128%2540example.com%26invite%3DrFoHveewMRmrKg"
    }
  ],
  "meta": {
    "timestamp": "2019-10-08T17:21:17.120-07:00",
    "includes": []
  }
}

Invite Candidates

The way to create a candidate within the system is to invite them to an assessment. NOTE: This API is in flux and may change its signature.

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.eyJpZGVudGl0eV9pZCI6IjVkOWQyN2ZkZWVhMjVmMjc0MTlkMGJmMSIsImlkIjoiNWQ5ZDI3ZmRlZWEyNWYyNzQxOWQwYmYyIiwic2VjcmV0IjoiZ0R0NGhnPT0ifQ.ihaXB29KEqbmMl7ZWz5x1UaE9HG67GXmI6lYN6EolS8

Body

{
  "data": {
    "candidates": [
      "[email protected]"
    ],
    "assessment_id": "5d9d27fdeea25f27419d0bf4",
    "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": "5d9d27fdeea25f27419d0bfc",
      "state": "active",
      "teamCandidateId": "5d9d27fdeea25f27419d0bf7",
      "assessmentId": "5d9d27fdeea25f27419d0bf4",
      "assessmentResultId": "5d9d27fdeea25f27419d0bf8",
      "teamId": "5d9d27fdeea25f27419d0beb",
      "teamMemberId": "5d9d27fdeea25f27419d0bf2",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Mid-Level Django Developer #104",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "George Smith",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5d9d27fdeea25f27419d0bf4?activate=83UONBuzzAigYA.5d9d27fdeea25f27419d0bf6&email=George%40place.com&invite=yg62NAtPnss09g",
      "invitePracticePath": "/assess/practice-?activate=83UONBuzzAigYA.5d9d27fdeea25f27419d0bf6&email=George%40place.com&invite=yg62NAtPnss09g&returnTo=%2Fassess%2F5d9d27fdeea25f27419d0bf4%3Factivate%3D83UONBuzzAigYA.5d9d27fdeea25f27419d0bf6%26email%3DGeorge%2540place.com%26invite%3Dyg62NAtPnss09g"
    }
  ],
  "meta": {
    "timestamp": "2019-10-08T17:21:17.452-07:00",
    "includes": []
  }
}

Invite Team Members

Allows you to invite a team member to a specific assessment. They will receive an email. NOTE: This API is in flux and may change its signature.

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.eyJpZGVudGl0eV9pZCI6IjVkOWQyN2ZkZWVhMjVmMjc0MTlkMGMxYiIsImlkIjoiNWQ5ZDI3ZmRlZWEyNWYyNzQxOWQwYzFjIiwic2VjcmV0IjoidFVVM0NBPT0ifQ._x3GMkn3159iJkd2BY5it2XEM5d-cG_OrnBwGmdmq04

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5d9d27feeea25f27419d0c28",
      "state": "active",
      "teamCandidateId": "5d9d27feeea25f27419d0c23",
      "assessmentId": "5d9d27fdeea25f27419d0c1e",
      "assessmentResultId": "5d9d27feeea25f27419d0c24",
      "teamId": "5d9d27fdeea25f27419d0c15",
      "teamMemberId": "5d9d27fdeea25f27419d0c1c",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "customMessage": null,
      "assessmentTitle": "Mid-Level Big-Data Developer #106",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "",
      "candidateEmail": "[email protected]",
      "testTeamMember": true,
      "inviterRole": "owner",
      "invitePath": "/assess/5d9d27fdeea25f27419d0c1e?activate=FC2ScbWYBo8OMA.5d9d27feeea25f27419d0c22&email=George%40place.com&invite=79veNjyFqF8u2A",
      "invitePracticePath": "/assess/practice-?activate=FC2ScbWYBo8OMA.5d9d27feeea25f27419d0c22&email=George%40place.com&invite=79veNjyFqF8u2A&returnTo=%2Fassess%2F5d9d27fdeea25f27419d0c1e%3Factivate%3DFC2ScbWYBo8OMA.5d9d27feeea25f27419d0c22%26email%3DGeorge%2540place.com%26invite%3D79veNjyFqF8u2A"
    }
  ],
  "meta": {
    "timestamp": "2019-10-08T17:21:18.123-07:00",
    "includes": []
  }
}

Assessment Result Reviews

List

Endpoint

GET /v1/assessment_result_reviews

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/assessment_result_reviews

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyN2ZmZWVhMjVmMjc0MTlkMGM5OSIsImlkIjoiNWQ5ZDI3ZmZlZWEyNWYyNzQxOWQwYzlhIiwic2VjcmV0IjoiaFRDSVpBPT0ifQ.2e4Yz3rI1bS3eT4u8NobYzxGR0_Hb8Vwp6BOxzd8dGs

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentResultReview",
  "data": [
    {
      "id": "5d9d27ffeea25f27419d0c95",
      "reviewedById": "5d9d27ffeea25f27419d0c97",
      "reviewedByStaff": null,
      "assessmentId": "5d9d27ffeea25f27419d0c86",
      "assessmentResultId": "5d9d27ffeea25f27419d0c8e",
      "teamCandidateId": "5d9d27ffeea25f27419d0c91",
      "candidateId": "5d9d27ffeea25f27419d0c90",
      "rating": 5,
      "feedback": "great!",
      "state": "started"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:21:19.501-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_result_reviews/:id

Request

Route

GET /v1/assessment_result_reviews/5d9d27ffeea25f27419d0cb6

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyN2ZmZWVhMjVmMjc0MTlkMGNiMyIsImlkIjoiNWQ5ZDI3ZmZlZWEyNWYyNzQxOWQwY2I0Iiwic2VjcmV0IjoiTk5sc2hBPT0ifQ.bBwn_c2pWPP2qNQ9GWC5_hCD0F6olymnTiWKHvBdZXM

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d27ffeea25f27419d0cb6",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5d9d27ffeea25f27419d0cb6",
    "reviewedById": "5d9d27ffeea25f27419d0cb8",
    "reviewedByStaff": null,
    "assessmentId": "5d9d27ffeea25f27419d0ca4",
    "assessmentResultId": "5d9d27ffeea25f27419d0cac",
    "teamCandidateId": "5d9d27ffeea25f27419d0caf",
    "candidateId": "5d9d27ffeea25f27419d0cae",
    "rating": 5,
    "feedback": "great!",
    "state": "started"
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2019-10-08T17:21:19.842-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyODAwZWVhMjVmMjc0MTlkMGNkMSIsImlkIjoiNWQ5ZDI4MDBlZWEyNWYyNzQxOWQwY2QyIiwic2VjcmV0IjoiZ2FOY1R3PT0ifQ.11ww6gpzHIl2AYXXddz3Z67JGdnLr7zppMEozn7lRm0

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2800eea25f27419d0cd4",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5d9d2800eea25f27419d0cd4",
    "reviewedById": "5d9d2800eea25f27419d0cd2",
    "reviewedByStaff": false,
    "assessmentId": "5d9d27ffeea25f27419d0cc2",
    "assessmentResultId": "5d9d2800eea25f27419d0cca",
    "teamCandidateId": "5d9d2800eea25f27419d0ccd",
    "candidateId": "5d9d2800eea25f27419d0ccc",
    "rating": null,
    "feedback": "super duper",
    "state": "started"
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2019-10-08T17:21:20.209-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/5d9d2800eea25f27419d0cef

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODAwZWVhMjVmMjc0MTlkMGNlYyIsImlkIjoiNWQ5ZDI4MDBlZWEyNWYyNzQxOWQwY2VkIiwic2VjcmV0IjoiVXRkNldRPT0ifQ.xlevXrf8HNr9d_ei3UmfBX1dG4a1aiYn_vGCZKMPHbU

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2800eea25f27419d0cef",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5d9d2800eea25f27419d0cef",
    "reviewedById": "5d9d2800eea25f27419d0cf1",
    "reviewedByStaff": false,
    "assessmentId": "5d9d2800eea25f27419d0cdd",
    "assessmentResultId": "5d9d2800eea25f27419d0ce5",
    "teamCandidateId": "5d9d2800eea25f27419d0ce8",
    "candidateId": "5d9d2800eea25f27419d0ce7",
    "rating": 3,
    "feedback": "feedback",
    "state": "started"
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2019-10-08T17:21:20.581-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/assessment_result_reviews/:id

Request

Route

DELETE /v1/assessment_result_reviews/5d9d2800eea25f27419d0d0d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODAwZWVhMjVmMjc0MTlkMGQwYSIsImlkIjoiNWQ5ZDI4MDBlZWEyNWYyNzQxOWQwZDBiIiwic2VjcmV0IjoiZ2hLN0VBPT0ifQ.gGBj-erYKphZxdCXzRLIhyxnLtsGAYVTcbQZGnXOGz8
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.eyJpZGVudGl0eV9pZCI6IjVkOWQyODAxZWVhMjVmMjc0MTlkMGQzYiIsImlkIjoiNWQ5ZDI4MDFlZWEyNWYyNzQxOWQwZDNjIiwic2VjcmV0IjoiSDQzK1pBPT0ifQ.kOv5--ssDUbuMoDkJvHngOsD2hMSlXHZmI6o8hPYNd4

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentResult",
  "data": [
    {
      "id": "5d9d2801eea25f27419d0d35",
      "assessmentId": "5d9d2801eea25f27419d0d30",
      "candidateId": "5d9d2801eea25f27419d0d12",
      "teamCandidateId": "5d9d2801eea25f27419d0d36",
      "teamId": "5d9d2801eea25f27419d0d15",
      "state": "started",
      "createdAt": "2019-10-09T00:21:21.309Z",
      "updatedAt": "2019-10-09T00:21:21.309Z",
      "startedAt": "2019-10-09T00:21:21.309Z",
      "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,
      "totalSubmissionSeconds": null,
      "totalOriginalSubmissionSeconds": null,
      "accumulatedSeconds": 0,
      "enforcedTimeLimit": null,
      "timerExpiresIn": null,
      "wallTimeSinceStart": 0,
      "reopenedById": null,
      "activeTimedSolutionId": null,
      "isActiveInteractSession": false,
      "candidateName": "Joe Smith164",
      "candidateEmail": "[email protected]",
      "candidatePhone": null,
      "interviewerIds": [],
      "activeInterviewerIds": [],
      "abandoned": false,
      "workflowName": null,
      "isInteractSession": false,
      "challengeItems": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:21:21.402-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_results/:id/report_url

Parameters

Name Description
id base64 or base16 ObjectId

Request

Route

GET /v1/assessment_results/5d9d2803eea25f27419d0e10/report_url

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODAzZWVhMjVmMjc0MTlkMGRlYyIsImlkIjoiNWQ5ZDI4MDNlZWEyNWYyNzQxOWQwZGVkIiwic2VjcmV0IjoiRVVTd3hBPT0ifQ.6XmlNhnAkqrThzbaqUSqwKC5Ay3NHSS5HfuwHxDPVpI

Response

Simulated Response

Status

200

Headers

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

Body

{
  "url": "https://localhost:3001/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjVkOWQyODAzZWVhMjVmMjc0MTlkMGUxMCIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWQ5ZDI4MDNlZWEyNWYyNzQxOWQwZGYwIn0.J4IPmApM3DyZTbM10rgFb-zSHZLIJcEGJafYe7V-EDM",
  "pdf": "https://localhost:3001/pdf/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjVkOWQyODAzZWVhMjVmMjc0MTlkMGUxMCIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWQ5ZDI4MDNlZWEyNWYyNzQxOWQwZGYwIn0.J4IPmApM3DyZTbM10rgFb-zSHZLIJcEGJafYe7V-EDM"
}

Get

Endpoint

GET /v1/assessment_results/:id/report_url

Parameters

Name Description
id base64 or base16 ObjectId

Request

Route

GET /v1/assessment_results/5d9d2803eea25f27419d0e10/report_url

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODAzZWVhMjVmMjc0MTlkMGRlYyIsImlkIjoiNWQ5ZDI4MDNlZWEyNWYyNzQxOWQwZGVkIiwic2VjcmV0IjoiRVVTd3hBPT0ifQ.6XmlNhnAkqrThzbaqUSqwKC5Ay3NHSS5HfuwHxDPVpI

Response

Simulated Response

Status

200

Headers

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

Body

{
  "url": "https://localhost:3001/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjVkOWQyODAzZWVhMjVmMjc0MTlkMGUxMCIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWQ5ZDI4MDNlZWEyNWYyNzQxOWQwZGYwIn0.J4IPmApM3DyZTbM10rgFb-zSHZLIJcEGJafYe7V-EDM",
  "pdf": "https://localhost:3001/pdf/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjVkOWQyODAzZWVhMjVmMjc0MTlkMGUxMCIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWQ5ZDI4MDNlZWEyNWYyNzQxOWQwZGYwIn0.J4IPmApM3DyZTbM10rgFb-zSHZLIJcEGJafYe7V-EDM"
}

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/5d9d2807eea25f27419d0eea/unsubmit

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODA3ZWVhMjVmMjc0MTlkMGVlMyIsImlkIjoiNWQ5ZDI4MDdlZWEyNWYyNzQxOWQwZWU0Iiwic2VjcmV0IjoicTJTNUpnPT0ifQ.JJwUvjqGJQ7d2E4eJQTK6ap7m40J3U52-UfufqbL4Y8
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2807eea25f27419d0eea",
  "type": "AssessmentResult",
  "data": {
    "id": "5d9d2807eea25f27419d0eea",
    "assessmentId": "5d9d2807eea25f27419d0ee2",
    "candidateId": "5d9d2807eea25f27419d0ed9",
    "teamCandidateId": "5d9d2807eea25f27419d0eeb",
    "teamId": "5d9d2807eea25f27419d0edc",
    "state": "opened",
    "createdAt": "1970-01-01T03:58:00.857Z",
    "updatedAt": "2019-10-09T00:21:27.949Z",
    "startedAt": null,
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "1970-01-01T02:00:00.857Z",
    "openedAt": "2019-10-09T00:21:27.942Z",
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": "2019-10-09T00:21:27.863Z",
    "dryRun": false,
    "candidateRemarks": null,
    "score": 0.0,
    "closedReason": null,
    "redirectUrl": null,
    "submissionMessage": null,
    "nextAssessmentId": null,
    "totalSubmissionSeconds": null,
    "totalOriginalSubmissionSeconds": null,
    "accumulatedSeconds": 0,
    "enforcedTimeLimit": null,
    "timerExpiresIn": null,
    "wallTimeSinceStart": 0,
    "reopenedById": "5d9d2807eea25f27419d0ee4",
    "activeTimedSolutionId": null,
    "isActiveInteractSession": false,
    "candidateName": "Joe Smith248",
    "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": "2019-10-08T17:21:27.981-07:00",
    "includes": []
  }
}

Assessment Templates

List

Endpoint

GET /v1/assessment_templates

Request

Route

GET /v1/assessment_templates

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODA4ZWVhMjVmMjc0MTlkMGY0MyIsImlkIjoiNWQ5ZDI4MDhlZWEyNWYyNzQxOWQwZjQ0Iiwic2VjcmV0IjoiOUllSGlBPT0ifQ.S0ZXysNYJEswTt9GSBcjHEJ6QlJPPOZ7XwhJcxF5XWk

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5d9d2808eea25f27419d0ef7",
      "title": "Junior Front-End Engineer #126",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5d9d2808eea25f27419d0ef1",
      "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": "Laudantium reiciendis consequatur voluptatem voluptates deleniti aliquam illo. Error quasi dolorem libero. Autem modi aliquam omnis. Iusto accusantium debitis.",
      "challengeItems": [
        {
          "id": "5d9d2808eea25f27419d0efe",
          "challengeId": "5d9d2808eea25f27419d0efb",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0efb",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Actor Numbers #135",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.129Z",
            "createdAt": "2019-10-09T00:21:28.136Z",
            "updatedAt": "2019-10-09T00:21:28.136Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0efc",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0efd",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "oNJ81aYOn61Xr4HTU9hlRyW8kFLjRIS69o2oHdpsScQ=\n--0HM1KgN4zfGXlhn3FMbNag==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f02",
          "challengeId": "5d9d2808eea25f27419d0eff",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0eff",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Date Encoding #136",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.180Z",
            "createdAt": "2019-10-09T00:21:28.184Z",
            "updatedAt": "2019-10-09T00:21:28.184Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f00",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f01",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "+HJgccLDMzmhQMeumMBGsP5uEYKm3VvDMF8V4LCX+LQ=\n--OThnh+65F2bZFHss5YTIJg==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f06",
          "challengeId": "5d9d2808eea25f27419d0f03",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f03",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Inverted Array #137",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.202Z",
            "createdAt": "2019-10-09T00:21:28.206Z",
            "updatedAt": "2019-10-09T00:21:28.206Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f04",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f05",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "srwcXFlHcZ4TdQFPKaSJVmRXpNvpsP+MybTK45VoqaE=\n--WYjkd33RvZNFF7VDCFyfYA==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Animi a ut sit consectetur dolor voluptatem dolorum. Ratione aut sunt. Quos suscipit dolore consequatur consectetur eos accusamus. Quis consequuntur perspiciatis sunt nihil reprehenderit omnis qui. Autem et et excepturi ut possimus qui magnam.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5d9d2808eea25f27419d0f07",
      "title": "Mid-Level Ruby Developer #127",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5d9d2808eea25f27419d0ef1",
      "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": "Voluptatibus non eos et vel a. Et quia aliquam at. Itaque non consequatur perferendis ipsum. Quaerat neque eligendi alias occaecati magni iure.",
      "challengeItems": [
        {
          "id": "5d9d2808eea25f27419d0f0b",
          "challengeId": "5d9d2808eea25f27419d0f08",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f08",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Greedy Methods #138",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.232Z",
            "createdAt": "2019-10-09T00:21:28.237Z",
            "updatedAt": "2019-10-09T00:21:28.237Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f09",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f0a",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "KVZ9C4aHQxBj98xQd9CfyFhNm9jni5D107hFEgI9VN4=\n--4oyrAcTNIB0bkEQB0cCjVg==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f0f",
          "challengeId": "5d9d2808eea25f27419d0f0c",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f0c",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Light Parser #139",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.258Z",
            "createdAt": "2019-10-09T00:21:28.262Z",
            "updatedAt": "2019-10-09T00:21:28.262Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f0d",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f0e",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "eXiJtRj0epjjrery9DZz3KI+O1lW9LnGZUWSguNFsWo=\n--EThugSPaix7iRGZWG2+URQ==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f13",
          "challengeId": "5d9d2808eea25f27419d0f10",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f10",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Actor Solution #140",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.278Z",
            "createdAt": "2019-10-09T00:21:28.282Z",
            "updatedAt": "2019-10-09T00:21:28.282Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f11",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f12",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "R/y1A+0gkmM0LEqXJEtXtguf+fpKPVpUx3kzJSNA0Do=\n--O6LcUKfd3UOxBIJagL4L5g==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Cumque est perspiciatis sunt. Cumque tempore quia neque reprehenderit repellendus ipsa. Debitis repudiandae nulla sint ab in ut.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5d9d2808eea25f27419d0f14",
      "title": "Mid-Level Rails Developer #128",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5d9d2808eea25f27419d0ef1",
      "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": "Cupiditate consequuntur porro. Sapiente assumenda repellendus dolorum vel. Sit quis saepe nostrum aut reprehenderit est unde.",
      "challengeItems": [
        {
          "id": "5d9d2808eea25f27419d0f18",
          "challengeId": "5d9d2808eea25f27419d0f15",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f15",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Heavy Numbers #141",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.309Z",
            "createdAt": "2019-10-09T00:21:28.313Z",
            "updatedAt": "2019-10-09T00:21:28.313Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f16",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f17",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "6Hp1xC4Iak6e0AEPwJJwawSffYaeGZLvkkmgd7ta74g=\n--rqFG+nVJoRYDtAZACVJJ8Q==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f1c",
          "challengeId": "5d9d2808eea25f27419d0f19",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f19",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Large Process #142",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.334Z",
            "createdAt": "2019-10-09T00:21:28.338Z",
            "updatedAt": "2019-10-09T00:21:28.338Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f1a",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f1b",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "0R2Nubz7GJVls+jnPeATtuZI9n58B0ykAixewLU9eQk=\n--fIvf04opU6DJdqL0+KCSlQ==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f20",
          "challengeId": "5d9d2808eea25f27419d0f1d",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f1d",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Email Array #143",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.355Z",
            "createdAt": "2019-10-09T00:21:28.359Z",
            "updatedAt": "2019-10-09T00:21:28.359Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f1e",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f1f",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "JLpG/bA67CTdk4seipy4yzJmkbJDBfTnkCkPrcyhQiI=\n--R74NtpYvvo34O1/2DjvH5g==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Facilis corporis ullam et et. Enim consectetur eius. Sed culpa voluptatem et facere repellendus molestiae unde. Voluptas aperiam rerum qui officiis quidem. Ea impedit ut qui temporibus.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5d9d2808eea25f27419d0f21",
      "title": "Mid-Level Database Developer #129",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5d9d2808eea25f27419d0ef1",
      "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": "Sint nulla est debitis tenetur. Asperiores porro et quo aliquam sed fugiat provident. Similique non magni porro exercitationem vero dolor eaque.",
      "challengeItems": [
        {
          "id": "5d9d2808eea25f27419d0f25",
          "challengeId": "5d9d2808eea25f27419d0f22",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f22",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Value Problem #144",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.384Z",
            "createdAt": "2019-10-09T00:21:28.388Z",
            "updatedAt": "2019-10-09T00:21:28.388Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f23",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f24",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "RTHbK2OEZKdYbdN+Zba/lNFo3FdscVqpVIpY5/e3Ssg=\n--XUsKh+sMxobLZZ6XYglEpQ==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f29",
          "challengeId": "5d9d2808eea25f27419d0f26",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f26",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Sequential Encoding #145",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.409Z",
            "createdAt": "2019-10-09T00:21:28.413Z",
            "updatedAt": "2019-10-09T00:21:28.413Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f27",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f28",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "KWCukSSHmf6hGWbJLRaliCe5g2U6+JuMm7CocYFlfvA=\n--JCauxmvNc+t+wtSnElVN0A==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f2d",
          "challengeId": "5d9d2808eea25f27419d0f2a",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f2a",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Insane Parser #146",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.431Z",
            "createdAt": "2019-10-09T00:21:28.435Z",
            "updatedAt": "2019-10-09T00:21:28.435Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f2b",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f2c",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "yjqswVuGvsENb0C5WvJvLf+1aFDiafTMcapDt9P+AhE=\n--W0Cz9VCWvsEtiUaWV0dXaw==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Repudiandae optio assumenda nulla voluptas consequatur reprehenderit. Quo nam nesciunt consectetur aspernatur. Neque architecto eum facere.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5d9d2808eea25f27419d0f2e",
      "title": "Senior Rails Developer #130",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5d9d2808eea25f27419d0ef1",
      "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 numquam ex fuga ducimus ratione. Et ut et tempora aut ducimus ut. Qui iste similique in. Aut odio molestias sit. Assumenda enim sit tempora consequatur.",
      "challengeItems": [
        {
          "id": "5d9d2808eea25f27419d0f32",
          "challengeId": "5d9d2808eea25f27419d0f2f",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f2f",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Custom Helper #147",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.461Z",
            "createdAt": "2019-10-09T00:21:28.466Z",
            "updatedAt": "2019-10-09T00:21:28.466Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f30",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f31",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "RzfltVKijRQ/phkg9UiN/AFS2oWRtBBTO2exgudoFzA=\n--Qi1DZbswCay+Yi0wM94/zQ==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f36",
          "challengeId": "5d9d2808eea25f27419d0f33",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f33",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Date Problem #148",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.487Z",
            "createdAt": "2019-10-09T00:21:28.492Z",
            "updatedAt": "2019-10-09T00:21:28.492Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f34",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f35",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "7lDqaiTuOJjr90NPcYU9PFsz7l8OK7HWbmTsdZETNYs=\n--LLur39UJKgL0QirdCJwr2w==--u"
              }
            ]
          }
        },
        {
          "id": "5d9d2808eea25f27419d0f3a",
          "challengeId": "5d9d2808eea25f27419d0f37",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5d9d2808eea25f27419d0f37",
            "$type": "CodeChallenge",
            "teamId": "5d9d2808eea25f27419d0ef1",
            "createdById": "5d9d2808eea25f27419d0ef9",
            "lastUpdatedById": null,
            "copiedFromId": null,
            "title": "Heavy Problem #149",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "published",
            "publishedAt": "2019-10-09T00:21:28.509Z",
            "createdAt": "2019-10-09T00:21:28.514Z",
            "updatedAt": "2019-10-09T00:21:28.514Z",
            "libraryAccess": "limited",
            "timeLimitMin": null,
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5d9d2808eea25f27419d0f38",
              "education": true,
              "recruitment": true
            },
            "tagsUpdatedAt": null,
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "galleryImage": null,
            "maxScoredTags": [],
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "risks": null,
            "languages": [
              {
                "id": "5d9d2808eea25f27419d0f39",
                "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,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "flz80sPLxhn9C+di0+ViiYXo2JxZfA7a2SJuq84INcA=\n--bFaNm4oEUGziktlvde7+Kg==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Quis quo id enim magnam impedit ratione. Harum voluptatibus quia fuga placeat architecto. Nobis dolor repudiandae et beatae. Fugiat quod consequatur recusandae.",
      "demoLandingOrder": 1000
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 5,
  "meta": {
    "timestamp": "2019-10-08T17:21:28.908-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/5d9d280aeea25f27419d0fcb/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBhZWVhMjVmMjc0MTlkMTAxNyIsImlkIjoiNWQ5ZDI4MGFlZWEyNWYyNzQxOWQxMDE4Iiwic2VjcmV0IjoiWWIwSUJ3PT0ifQ.oGUZgrW81FuiiFFfuDdgblQu7R8dt2OCnJFD6MsLbrA
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": "5d9d280aeea25f27419d102c",
  "type": "Assessment",
  "data": {
    "id": "5d9d280aeea25f27419d102c",
    "title": "Assessment Title",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5d9d280aeea25f27419d1011",
    "nounUpper": "Assessment",
    "nounLower": "assessment",
    "showPracticeAssessment": true,
    "showSurvey": true,
    "showTitle": true,
    "inviteOnly": true,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 6,
    "copiedFromId": "5d9d280aeea25f27419d0fcb",
    "showSolutionsToCandidates": true,
    "practiceSlug": "practice-cc",
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Omnis ratione inventore iste officia in fugit. Distinctio repudiandae ipsam nobis. Quia nulla et eum adipisci.",
    "challengeItems": [
      {
        "id": "5d9d280aeea25f27419d103c",
        "challengeId": "5d9d280aeea25f27419d102e",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5d9d280aeea25f27419d103d",
        "challengeId": "5d9d280aeea25f27419d1033",
        "position": 2,
        "disabledLanguages": []
      },
      {
        "id": "5d9d280aeea25f27419d103e",
        "challengeId": "5d9d280aeea25f27419d1038",
        "position": 3,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Recusandae unde vero tempora. Alias rerum provident nulla nihil aspernatur deserunt. Sunt aliquam nihil quia ut. Nemo illo exercitationem dolorem error esse qui ab.",
    "demoLandingOrder": 1000,
    "publishedAt": "2019-10-09T00:21:30.911Z",
    "archivedAt": null,
    "createdAt": "2019-10-09T00:21:30.908Z",
    "assessmentResultsSummary": {
      "_id": "5d9d280aeea25f27419d1040"
    },
    "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": "5d9d280aeea25f27419d103f",
      "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": "2019-10-08T17:21:30.945-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBjZWVhMjVmMjc0MTlkMTBhZiIsImlkIjoiNWQ5ZDI4MGNlZWEyNWYyNzQxOWQxMGIwIiwic2VjcmV0IjoiMU9NNllnPT0ifQ.x-MXkovk0f2lo948TREHHjXrCIc4A38qumr3qO9bktw

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5d9d280beea25f27419d109a",
      "title": "Mid-Level Back-End Engineer #146",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5d9d280beea25f27419d1094",
      "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": "At aut nesciunt. Quia mollitia molestiae ratione inventore accusamus eaque quis. Officiis accusantium neque qui. Repellat earum similique fuga voluptas tempore laborum tempora.",
      "challengeItems": [
        {
          "id": "5d9d280beea25f27419d10a1",
          "challengeId": "5d9d280beea25f27419d109e",
          "position": 1,
          "disabledLanguages": []
        }
      ],
      "activeAssessmentResultsCount": 2,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Voluptatum nam non placeat. Mollitia ratione fugit earum. Dignissimos et est dolor sit omnis neque. Dolorem illo natus. Sed cum officia consequuntur itaque expedita quia eius.",
      "demoLandingOrder": 1000,
      "publishedAt": "2019-10-09T00:21:31.965Z",
      "archivedAt": null,
      "createdAt": "2019-10-09T00:21:31.996Z",
      "assessmentResultsSummary": {
        "_id": "5d9d280ceea25f27419d10a6",
        "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": "5d9d280ceea25f27419d10b2",
        "jobId": null,
        "resultStateTriggers": null,
        "candidateStateTriggers": null,
        "sendStatus": null
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:21:32.231-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/5d9d280ceea25f27419d10bb

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d280ceea25f27419d10bb",
  "type": "Assessment",
  "data": {
    "id": "5d9d280ceea25f27419d10bb",
    "title": "Senior Database Developer #147",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5d9d280ceea25f27419d10b5",
    "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": "Aperiam cupiditate consequatur possimus eligendi laudantium aliquid dolorum. Molestiae qui saepe consectetur temporibus iste consequatur. Ducimus id quo reprehenderit eius. Molestiae nemo ea iste dolorem eveniet reprehenderit. Veritatis ut pariatur.",
    "challengeItems": [
      {
        "id": "5d9d280ceea25f27419d10c2",
        "challengeId": "5d9d280ceea25f27419d10bf",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "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": "2019-10-08T17:21:32.562-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBkZWVhMjVmMjc0MTlkMTBmYiIsImlkIjoiNWQ5ZDI4MGRlZWEyNWYyNzQxOWQxMGZjIiwic2VjcmV0IjoiZkxFZlZBPT0ifQ.rZkPoMr_02zjT6VHGfRWz7ur57oeHSuQ7iSXxAqe2XY
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": "5d9d280deea25f27419d110f",
  "type": "Assessment",
  "data": {
    "id": "5d9d280deea25f27419d110f",
    "title": "Angular Developer",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5d9d280deea25f27419d10f4",
    "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": [],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": null,
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2019-10-09T00:21:33.288Z",
    "assessmentResultsSummary": {
      "_id": "5d9d280deea25f27419d1111"
    },
    "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": "5d9d280deea25f27419d1110",
      "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": "2019-10-08T17:21:33.310-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/5d9d280deea25f27419d111a

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBkZWVhMjVmMjc0MTlkMTExYiIsImlkIjoiNWQ5ZDI4MGRlZWEyNWYyNzQxOWQxMTFjIiwic2VjcmV0IjoiKzFXd013PT0ifQ.-UhZmT-SHFq8vnhP3o97cdQIynstlKyWdrZJzMRiM-k
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": "5d9d280deea25f27419d111a",
  "type": "Assessment",
  "data": {
    "id": "5d9d280deea25f27419d111a",
    "title": "Senior Django Engineer #150",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5d9d280deea25f27419d1114",
    "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": "5d9d280deea25f27419d1121",
        "challengeId": "5d9d280deea25f27419d111e",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Suscipit tempora similique voluptas non qui ut. Dolorem consequatur asperiores vero at dolores sint. Ipsum aut corrupti deleniti autem aut qui odio. Nobis ea beatae fugit ut. Vel ex praesentium laudantium.",
    "demoLandingOrder": 1000,
    "publishedAt": "2019-10-09T00:21:33.439Z",
    "archivedAt": null,
    "createdAt": "2019-10-09T00:21:33.467Z",
    "assessmentResultsSummary": {
      "_id": "5d9d280deea25f27419d1126",
      "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": "5d9d280deea25f27419d112f",
      "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": "2019-10-08T17:21:33.662-07:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/assessments/:id/publish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5d9d280deea25f27419d1138/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBkZWVhMjVmMjc0MTlkMTEzOSIsImlkIjoiNWQ5ZDI4MGRlZWEyNWYyNzQxOWQxMTNhIiwic2VjcmV0IjoiTWQ1T0pnPT0ifQ.M3CBKLHljtjD24pRLEDyIIefmSUyPIurcSapcUk3LWQ
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d280deea25f27419d1138",
  "type": "Assessment",
  "data": {
    "id": "5d9d280deea25f27419d1138",
    "title": "Senior Django Developer #151",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5d9d280deea25f27419d1132",
    "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": "Nihil placeat veniam sequi illo eveniet. Delectus rerum ut placeat qui. Enim porro aut quibusdam nihil voluptatem dolores et.",
    "challengeItems": [],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Odio quasi commodi. Id quaerat ducimus cupiditate molestias excepturi. Distinctio quasi fugiat. Ipsum error ut quia exercitationem molestias et et.",
    "demoLandingOrder": 1000,
    "publishedAt": "2019-10-09T00:21:33.845Z",
    "archivedAt": null,
    "createdAt": "2019-10-09T00:21:33.818Z",
    "assessmentResultsSummary": {
      "_id": "5d9d280deea25f27419d113d"
    },
    "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": "5d9d280deea25f27419d113c",
      "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": "2019-10-08T17:21:33.873-07:00",
    "includes": []
  }
}

Un-publish

Endpoint

PUT /v1/assessments/:id/unpublish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5d9d280eeea25f27419d1156/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBlZWVhMjVmMjc0MTlkMTE1NyIsImlkIjoiNWQ5ZDI4MGVlZWEyNWYyNzQxOWQxMTU4Iiwic2VjcmV0IjoiNTQwL0FRPT0ifQ.igHcz5DP1ysSzTL-CS_R6WrQL-J-OMYcE9dzn1eUUls
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d280eeea25f27419d1156",
  "type": "Assessment",
  "data": {
    "id": "5d9d280eeea25f27419d1156",
    "title": "Junior Web Developer #153",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5d9d280eeea25f27419d1150",
    "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": "Ut pariatur aut mollitia. Necessitatibus est vero officia aut. Ut est eum. Est deleniti fugit at sit natus delectus quos.",
    "challengeItems": [
      {
        "id": "5d9d280eeea25f27419d115d",
        "challengeId": "5d9d280eeea25f27419d115a",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Sint ipsam voluptates. Ut doloribus aut. Non enim quibusdam assumenda ducimus est doloremque quo.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2019-10-09T00:21:34.254Z",
    "assessmentResultsSummary": {
      "_id": "5d9d280eeea25f27419d1162",
      "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": "5d9d280eeea25f27419d116b",
      "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": "2019-10-08T17:21:34.448-07:00",
    "includes": []
  }
}

Archive

Archives the assessment

Endpoint

PUT /v1/assessments/:id/archive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5d9d280eeea25f27419d1174/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBlZWVhMjVmMjc0MTlkMTE3NSIsImlkIjoiNWQ5ZDI4MGVlZWEyNWYyNzQxOWQxMTc2Iiwic2VjcmV0IjoiRUVmYmV3PT0ifQ.Py7F-r3vyBvc01DS5tmNjMk0-NcMgaJDu8hpyUg42P8
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d280eeea25f27419d1174",
  "type": "Assessment",
  "data": {
    "id": "5d9d280eeea25f27419d1174",
    "title": "Senior Angular Developer #154",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5d9d280eeea25f27419d116e",
    "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": "Ea ut sed dolores sit illum ipsum. Eos delectus rerum nemo non beatae dolor. Adipisci ipsum quasi odit voluptatem nostrum voluptas ab. Et et assumenda sed cupiditate vitae non dolores. Tempore iste vitae.",
    "challengeItems": [
      {
        "id": "5d9d280eeea25f27419d117b",
        "challengeId": "5d9d280eeea25f27419d1178",
        "position": 1,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Reiciendis rerum iste. Expedita repellendus harum. Voluptatem veniam delectus quo illum optio. Autem perferendis sapiente animi voluptatum.",
    "demoLandingOrder": 1000,
    "publishedAt": "2019-10-09T00:21:34.580Z",
    "archivedAt": "2019-10-09T00:21:34.784Z",
    "createdAt": "2019-10-09T00:21:34.610Z",
    "assessmentResultsSummary": {
      "_id": "5d9d280eeea25f27419d1180",
      "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": "5d9d280eeea25f27419d1189",
      "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": "2019-10-08T17:21:34.821-07:00",
    "includes": []
  }
}

Unarchive

Unarchives the assessment

Endpoint

PUT /v1/assessments/:id/unarchive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5d9d280feea25f27419d11af/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBlZWVhMjVmMjc0MTlkMTE5MyIsImlkIjoiNWQ5ZDI4MGVlZWEyNWYyNzQxOWQxMTk0Iiwic2VjcmV0IjoiYlN2SEJRPT0ifQ.02rkAn7ex5Khfg8FTd3sNscF14jSc_Rdlk3MJjIsOMk
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d280feea25f27419d11af",
  "type": "Assessment",
  "data": {
    "id": "5d9d280feea25f27419d11af",
    "title": "Mid-Level Mobile Engineer #156",
    "state": "draft",
    "teamId": "5d9d280feea25f27419d11a9",
    "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": "2019-10-08T17:21:35.247-07:00",
    "includes": []
  }
}

Recover

Recovers the assessment

Endpoint

PUT /v1/assessments/:id/recover

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5d9d280feea25f27419d11ed/recover

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyODBmZWVhMjVmMjc0MTlkMTFkOSIsImlkIjoiNWQ5ZDI4MGZlZWEyNWYyNzQxOWQxMWRhIiwic2VjcmV0Ijoic29aMCt3PT0ifQ.tk9vBQV8Q2tdaqjw7K-7MBdvZj0mXcLNXhdCqK9gDOs
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d280feea25f27419d11ed",
  "type": "Assessment",
  "data": {
    "id": "5d9d280feea25f27419d11ed",
    "title": "Mid-Level JavaScript Engineer #159",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5d9d280feea25f27419d11d2",
    "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": "Aperiam tempora impedit cumque esse vitae illum voluptatum. Est reiciendis harum laborum illo praesentium vero doloribus. Totam est eos rerum provident suscipit.",
    "challengeItems": [],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Excepturi inventore ipsa quasi nulla consequatur ut. Placeat eveniet odit adipisci dolorem repudiandae est. Expedita ratione debitis eum.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": "2019-10-09T00:21:35.930Z",
    "createdAt": "2019-10-09T00:21:35.936Z",
    "assessmentResultsSummary": {
      "_id": "5d9d280feea25f27419d11ef"
    },
    "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": "5d9d280feea25f27419d11ee",
      "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": "2019-10-08T17:21:35.981-07:00",
    "includes": []
  }
}

ChallengeCriterion

Delete

Endpoint

DELETE /v1/challenge_criterions/:id

Request

Route

DELETE /v1/challenge_criterions/5d9d28d7eea25f27419d14c6

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ3ZWVhMjVmMjc0MTlkMTRiYiIsImlkIjoiNWQ5ZDI4ZDdlZWEyNWYyNzQxOWQxNGJjIiwic2VjcmV0IjoicDh6VkhBPT0ifQ.s0GGQwpeM-GgFnGp60o8-8EbiMdsynM82yH0tNeSYKk
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ3ZWVhMjVmMjc0MTlkMTRlMiIsImlkIjoiNWQ5ZDI4ZDdlZWEyNWYyNzQxOWQxNGUzIiwic2VjcmV0IjoiS0ZuVnB3PT0ifQ.395QoiPkmBraYKhlY32cb6JGkY_q4RrM2wl1j7HKM-4

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "CodeChallenge",
  "data": [
    {
      "id": "5d9d28d7eea25f27419d14e1",
      "$type": "CodeChallenge",
      "teamId": "5d9d28d7eea25f27419d14db",
      "createdById": "5d9d28d7eea25f27419d14e3",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Async Enumerator #201",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Meta-programming"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2019-10-09T00:24:55.607Z",
      "createdAt": "2019-10-09T00:24:55.611Z",
      "updatedAt": "2019-10-09T00:24:55.611Z",
      "libraryAccess": null,
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5d9d28d7eea25f27419d14e5",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "team",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "maxScoredTags": [],
      "associatedTags": [],
      "criterionId": null,
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "yamlConfig": null,
      "risks": null,
      "languages": [
        {
          "id": "5d9d28d7eea25f27419d14e6",
          "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,
          "weightedTestCases": 1,
          "tagTestCases": null,
          "hiddenTestCases": 0,
          "exampleTestCases": "Test.expect(a == 1)",
          "setup": "var a = ",
          "testCases": "Test.expect(a == 1)",
          "preloaded": null,
          "solution": "var a = 1;",
          "validationHash": 0,
          "exampleValidationHash": 0
        }
      ]
    },
    {
      "id": "5d9d28d7eea25f27419d14ef",
      "$type": "CodeChallenge",
      "teamId": "5d9d28d7eea25f27419d14e9",
      "createdById": "5d9d28d7eea25f27419d14f0",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Node System #202",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Algorithms"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2019-10-09T00:24:55.685Z",
      "createdAt": "2019-10-09T00:24:55.689Z",
      "updatedAt": "2019-10-09T00:24:55.689Z",
      "libraryAccess": "limited",
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5d9d28d7eea25f27419d14f3",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "commons",
      "protected": true,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "maxScoredTags": [],
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "risks": null,
      "languages": [
        {
          "id": "5d9d28d7eea25f27419d14f4",
          "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,
          "weightedTestCases": 1,
          "tagTestCases": null,
          "hiddenTestCases": 0,
          "exampleTestCases": "Test.expect(a == 1)",
          "setup": "var a = ",
          "testCases": "ZghgFGYBtR4FeprkZsz+nPtAWqyZHlA5W2tHyif/Ge0=\n--oq3Ck2Nqm797dHfrxgo/xQ==--u"
        }
      ]
    },
    {
      "id": "5d9d28d7eea25f27419d14f8",
      "$type": "CodeChallenge",
      "teamId": "5d9d28d7eea25f27419d14e9",
      "createdById": "5d9d28d7eea25f27419d14f0",
      "lastUpdatedById": null,
      "copiedFromId": null,
      "title": "Insane Substring #204",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Logic"
      ],
      "labels": [
        "Templates"
      ],
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2019-10-09T00:24:55.714Z",
      "createdAt": "2019-10-09T00:24:55.719Z",
      "updatedAt": "2019-10-09T00:24:55.719Z",
      "libraryAccess": "limited",
      "timeLimitMin": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "template",
      "productTypes": {
        "_id": "5d9d28d7eea25f27419d14f9",
        "education": true,
        "recruitment": true
      },
      "tagsUpdatedAt": null,
      "collection": "commons",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "galleryImage": null,
      "maxScoredTags": [],
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "risks": null,
      "languages": [
        {
          "id": "5d9d28d7eea25f27419d14fa",
          "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,
          "weightedTestCases": 1,
          "tagTestCases": null,
          "hiddenTestCases": 0,
          "exampleTestCases": "Test.expect(a == 1)",
          "setup": "var a = ",
          "testCases": "Test.expect(a == 1)",
          "preloaded": null,
          "solution": "var a = 1;",
          "validationHash": 0,
          "exampleValidationHash": 0
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 3,
  "meta": {
    "timestamp": "2019-10-08T17:24:55.808-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/challenges/:id

Parameters

Name Description
id base16 ObjectId

Request

Route

GET /v1/challenges/5d9d28d8eea25f27419d1578

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ4ZWVhMjVmMjc0MTlkMTU3OSIsImlkIjoiNWQ5ZDI4ZDhlZWEyNWYyNzQxOWQxNTdhIiwic2VjcmV0IjoiM0pkaVFnPT0ifQ.FHoTA2ssizYTRG5oQ15qJhriOX_FDPOaDvUrD_6Aslk

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d28d8eea25f27419d1578",
  "type": "CodeChallenge",
  "data": {
    "id": "5d9d28d8eea25f27419d1578",
    "$type": "CodeChallenge",
    "teamId": "5d9d28d8eea25f27419d1572",
    "createdById": "5d9d28d8eea25f27419d157a",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Functional Generator #222",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2019-10-09T00:24:56.911Z",
    "createdAt": "2019-10-09T00:24:56.915Z",
    "updatedAt": "2019-10-09T00:24:56.915Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28d8eea25f27419d157c",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "risks": null,
    "languages": [
      {
        "id": "5d9d28d8eea25f27419d157d",
        "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,
        "weightedTestCases": 1,
        "tagTestCases": null,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var 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": "2019-10-08T17:24:56.961-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ5ZWVhMjVmMjc0MTlkMTU4NyIsImlkIjoiNWQ5ZDI4ZDllZWEyNWYyNzQxOWQxNTg4Iiwic2VjcmV0IjoiSWRNQkpBPT0ifQ.dT00uK29MuRrL9UorQwEFw09sUscG6GZzwq5r1fsWIc

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": "5d9d28d9eea25f27419d158c",
  "type": "CodeChallenge",
  "data": {
    "id": "5d9d28d9eea25f27419d158c",
    "$type": "CodeChallenge",
    "teamId": "5d9d28d9eea25f27419d1580",
    "createdById": "5d9d28d9eea25f27419d1588",
    "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": "2019-10-09T00:24:57.132Z",
    "createdAt": "2019-10-09T00:24:57.136Z",
    "updatedAt": "2019-10-09T00:24:57.136Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28d9eea25f27419d1583",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": false,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "risks": null,
    "languages": [
      {
        "id": "5d9d28d9eea25f27419d158e",
        "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,
        "weightedTestCases": 0,
        "tagTestCases": null,
        "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": "2019-10-08T17:24:57.167-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ5ZWVhMjVmMjc0MTlkMTU5OCIsImlkIjoiNWQ5ZDI4ZDllZWEyNWYyNzQxOWQxNTk5Iiwic2VjcmV0IjoiRk50U21nPT0ifQ.lqqu1UDaY3KQruF6DBSZbsLABfSxeDhpI6ykrU0ot-4

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": "5d9d28d9eea25f27419d15a4",
  "type": "QuizChallenge",
  "data": {
    "id": "5d9d28d9eea25f27419d15a4",
    "$type": "QuizChallenge",
    "teamId": "5d9d28d9eea25f27419d1591",
    "createdById": "5d9d28d9eea25f27419d1599",
    "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": "2019-10-09T00:24:57.352Z",
    "updatedAt": "2019-10-09T00:24:57.352Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28d9eea25f27419d1594",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "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": "2019-10-08T17:24:57.369-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/5d9d28d9eea25f27419d15ae

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ5ZWVhMjVmMjc0MTlkMTVhZiIsImlkIjoiNWQ5ZDI4ZDllZWEyNWYyNzQxOWQxNWIwIiwic2VjcmV0IjoiQk1UK0pRPT0ifQ.7C-JwnFw0ir3_TXbwJVmxYJMrnfcInsL5ifzJ3JKbS8

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": "5d9d28d9eea25f27419d15ae",
  "type": "CodeChallenge",
  "data": {
    "id": "5d9d28d9eea25f27419d15ae",
    "$type": "CodeChallenge",
    "teamId": "5d9d28d9eea25f27419d15a8",
    "createdById": "5d9d28d9eea25f27419d15b0",
    "lastUpdatedById": "5d9d28d9eea25f27419d15b0",
    "copiedFromId": null,
    "title": "Sequential Regex #225",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Fundamentals"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2019-10-09T00:24:57.497Z",
    "updatedAt": "2019-10-09T00:24:57.546Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28d9eea25f27419d15b2",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "risks": null,
    "languages": [
      {
        "id": "5d9d28d9eea25f27419d15b4",
        "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,
        "weightedTestCases": 0,
        "tagTestCases": null,
        "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": "2019-10-08T17:24:57.564-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/challenges/:id

Request

Route

DELETE /v1/challenges/5d9d28d9eea25f27419d15bd

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ5ZWVhMjVmMjc0MTlkMTViZSIsImlkIjoiNWQ5ZDI4ZDllZWEyNWYyNzQxOWQxNWJmIiwic2VjcmV0IjoiVzNCRk9RPT0ifQ.p9A7a8nO_PTjX2qm9wgxProU8jo6nXQXyn_SD9UXGdw
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/5d9d28d9eea25f27419d15cb/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ5ZWVhMjVmMjc0MTlkMTVjYyIsImlkIjoiNWQ5ZDI4ZDllZWEyNWYyNzQxOWQxNWNkIiwic2VjcmV0Ijoick9tSnFRPT0ifQ.T_VNmwUiiZanv1cNops9I06o7Bf0MonAFPJodv3Xub4
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d28d9eea25f27419d15cb",
  "type": "CodeChallenge",
  "data": {
    "id": "5d9d28d9eea25f27419d15cb",
    "$type": "CodeChallenge",
    "teamId": "5d9d28d9eea25f27419d15c5",
    "createdById": "5d9d28d9eea25f27419d15cd",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Polymorphic Puzzle #227",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2019-10-09T00:24:57.864Z",
    "updatedAt": "2019-10-09T00:24:57.895Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28d9eea25f27419d15cf",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "risks": null,
    "languages": [
      {
        "id": "5d9d28d9eea25f27419d15d0",
        "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,
        "weightedTestCases": 1,
        "tagTestCases": null,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var 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": "2019-10-08T17:24:57.915-07:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/challenges/:id/publish

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5d9d28d9eea25f27419d15d9/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGQ5ZWVhMjVmMjc0MTlkMTVkYSIsImlkIjoiNWQ5ZDI4ZGFlZWEyNWYyNzQxOWQxNWRiIiwic2VjcmV0IjoiM2FaNFl3PT0ifQ.quDkPptfEm_GgTcGxMDG7q20d5jBOItmzlo4G2TQM2w
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d28d9eea25f27419d15d9",
  "type": "CodeChallenge",
  "data": {
    "id": "5d9d28d9eea25f27419d15d9",
    "$type": "CodeChallenge",
    "teamId": "5d9d28d9eea25f27419d15d3",
    "createdById": "5d9d28daeea25f27419d15db",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Inverted Monad #228",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2019-10-09T00:24:58.058Z",
    "createdAt": "2019-10-09T00:24:58.029Z",
    "updatedAt": "2019-10-09T00:24:58.063Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28daeea25f27419d15dd",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "risks": null,
    "languages": [
      {
        "id": "5d9d28daeea25f27419d15de",
        "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,
        "weightedTestCases": 1,
        "tagTestCases": null,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var 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": "2019-10-08T17:24:58.084-07:00",
    "includes": []
  }
}

Archive

Endpoint

PUT /v1/challenges/:id/archive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5d9d28daeea25f27419d15e7/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGRhZWVhMjVmMjc0MTlkMTVlOCIsImlkIjoiNWQ5ZDI4ZGFlZWEyNWYyNzQxOWQxNWU5Iiwic2VjcmV0IjoiSXJVUFN3PT0ifQ.bxg6-PPSgWNsMl105EM4C1PWxtIZqc-Q08g3bQSFXVo
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d28daeea25f27419d15e7",
  "type": "CodeChallenge",
  "data": {
    "id": "5d9d28daeea25f27419d15e7",
    "$type": "CodeChallenge",
    "teamId": "5d9d28daeea25f27419d15e1",
    "createdById": "5d9d28daeea25f27419d15e9",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Balanced Monad #229",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "archived",
    "publishedAt": "2019-10-09T00:24:58.202Z",
    "createdAt": "2019-10-09T00:24:58.206Z",
    "updatedAt": "2019-10-09T00:24:58.242Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28daeea25f27419d15eb",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "risks": null,
    "languages": [
      {
        "id": "5d9d28daeea25f27419d15ec",
        "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,
        "weightedTestCases": 1,
        "tagTestCases": null,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var 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": "2019-10-08T17:24:58.263-07:00",
    "includes": []
  }
}

Un-archive

Endpoint

PUT /v1/challenges/:id/unarchive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5d9d28daeea25f27419d1605/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGRhZWVhMjVmMjc0MTlkMTYwNiIsImlkIjoiNWQ5ZDI4ZGFlZWEyNWYyNzQxOWQxNjA3Iiwic2VjcmV0Ijoia2RvR2RRPT0ifQ.IbhDz7T3lmpMGfbKqaGKv3isIwYwc1_AwNiR5y44CNg
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d28daeea25f27419d1605",
  "type": "CodeChallenge",
  "data": {
    "id": "5d9d28daeea25f27419d1605",
    "$type": "CodeChallenge",
    "teamId": "5d9d28daeea25f27419d15ff",
    "createdById": "5d9d28daeea25f27419d1607",
    "lastUpdatedById": null,
    "copiedFromId": null,
    "title": "Value Enumerator #231",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2019-10-09T00:24:58.605Z",
    "createdAt": "2019-10-09T00:24:58.576Z",
    "updatedAt": "2019-10-09T00:24:58.612Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28daeea25f27419d1609",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "risks": null,
    "languages": [
      {
        "id": "5d9d28daeea25f27419d160a",
        "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,
        "weightedTestCases": 1,
        "tagTestCases": null,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var 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": "2019-10-08T17:24:58.632-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/5d9d28dbeea25f27419d1692/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOGRiZWVhMjVmMjc0MTlkMTY5MyIsImlkIjoiNWQ5ZDI4ZGJlZWEyNWYyNzQxOWQxNjk0Iiwic2VjcmV0IjoiaVJqSFhBPT0ifQ.nWUGmGaeMM9uqBrMx87VMdITJ7vBebbjmNECEt0jYIc
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d28dbeea25f27419d1699",
  "type": "CodeChallenge",
  "data": {
    "id": "5d9d28dbeea25f27419d1699",
    "$type": "CodeChallenge",
    "teamId": "5d9d28dbeea25f27419d168c",
    "createdById": "5d9d28dbeea25f27419d1694",
    "lastUpdatedById": null,
    "copiedFromId": "5d9d28dbeea25f27419d1692",
    "title": "Polymorphic Substring #235",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Logic"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2019-10-09T00:24:59.812Z",
    "createdAt": "2019-10-09T00:24:59.774Z",
    "updatedAt": "2019-10-09T00:24:59.774Z",
    "libraryAccess": null,
    "timeLimitMin": null,
    "copiedFromLibrary": false,
    "copiedFromContentType": "normal",
    "contentType": "normal",
    "productTypes": {
      "_id": "5d9d28dbeea25f27419d169c",
      "education": true,
      "recruitment": true
    },
    "tagsUpdatedAt": null,
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": true,
    "galleryImage": null,
    "maxScoredTags": [],
    "associatedTags": [],
    "criterionId": null,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "risks": null,
    "languages": [
      {
        "id": "5d9d28dbeea25f27419d169b",
        "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,
        "weightedTestCases": 1,
        "tagTestCases": null,
        "hiddenTestCases": 0,
        "exampleTestCases": "Test.expect(a == 1)",
        "setup": "var a = ",
        "testCases": "Test.expect(a == 1)",
        "preloaded": null,
        "solution": "var 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": "2019-10-08T17:24:59.847-07:00",
    "includes": []
  }
}

LabelHistory

List

Endpoint

GET /v1/label_histories

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/label_histories?team_id=5d9d2900eea25f27419d198e

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTAwZWVhMjVmMjc0MTlkMTk5NSIsImlkIjoiNWQ5ZDI5MDBlZWEyNWYyNzQxOWQxOTk2Iiwic2VjcmV0IjoicU5qM2J3PT0ifQ.i-xhO1acXsgdbIys3oAJTQlr8Mn43uALyRSx68InMFo

Query Parameters

team_id=5d9d2900eea25f27419d198e

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "LabelHistory",
  "data": [
    {
      "id": "5d9d2900eea25f27419d1994",
      "name": "Test",
      "addedAt": "2019-10-09T00:25:36.857Z",
      "removedAt": null,
      "teamId": "5d9d2900eea25f27419d198e",
      "labeledId": "5d9d2900eea25f27419d198b",
      "labeledType": "TeamCandidate",
      "addedById": null,
      "removedById": null,
      "labeled": {
        "id": "5d9d2900eea25f27419d198b",
        "candidateId": "5d9d2900eea25f27419d198a",
        "teamId": "5d9d2900eea25f27419d198e",
        "state": "invited",
        "demoData": false,
        "prevState": null,
        "assessmentIds": [],
        "assessmentResultIds": [],
        "blinding": "blind_reviewers",
        "createdAt": "2019-10-09T00:25:36.840Z",
        "updatedAt": "2019-10-09T00:25:36.840Z",
        "decidedAt": null,
        "invitedAt": "2019-10-09T00:25:36.840Z",
        "interactSessions": 0,
        "stateUpdatedAt": "2019-10-09T00:25:36.840Z",
        "testTeamMember": false,
        "assignedTeamMemberIds": [],
        "labels": null,
        "archived": false,
        "firstName": "Joe",
        "lastName": "Smith463",
        "anonymousName": "Silver Coyote",
        "email": "[email protected]",
        "name": "Joe Smith463",
        "isBlinded": false,
        "stateLabel": "Invited",
        "angelId": null,
        "stateTransitions": [
          "idle",
          "invited",
          "started",
          "submitted",
          "risk_detected",
          "reviewed",
          "approved",
          "rejected",
          "archived"
        ],
        "risks": null,
        "assessmentsRecap": {
          "id": "5d9d2900eea25f27419d1998",
          "subjects": []
        }
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:25:36.926-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=5d9d2901eea25f27419d19a6

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTAwZWVhMjVmMjc0MTlkMTk5OSIsImlkIjoiNWQ5ZDI5MDBlZWEyNWYyNzQxOWQxOTlhIiwic2VjcmV0IjoiOTBaeDJnPT0ifQ.1kFQaBKu-huwP7kUTG6iQI154OJocRQlkNCLe20ggKY

Query Parameters

notable_id=5d9d2901eea25f27419d19a6

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Note",
  "data": [
    {
      "id": "5d9d2901eea25f27419d19b3",
      "body": "Odio nihil aperiam fugit quaerat.",
      "userId": "5d9d2901eea25f27419d19ab",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5d9d2901eea25f27419d19a6"
    },
    {
      "id": "5d9d2901eea25f27419d19b4",
      "body": "Sequi nam perferendis nisi inventore.",
      "userId": "5d9d2901eea25f27419d19b1",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5d9d2901eea25f27419d19a6"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 2,
  "meta": {
    "timestamp": "2019-10-08T17:25:37.189-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/5d9d2901eea25f27419d19ef

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTAxZWVhMjVmMjc0MTlkMTlkNSIsImlkIjoiNWQ5ZDI5MDFlZWEyNWYyNzQxOWQxOWQ2Iiwic2VjcmV0IjoiVlVuQWF3PT0ifQ.vCUesak3dCuEMXRkgQXnljuWEOaAPt1onxRsP4qR7w0

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2901eea25f27419d19ef",
  "type": "Note",
  "data": {
    "id": "5d9d2901eea25f27419d19ef",
    "body": "Illo hic sed consequatur nesciunt cumque deserunt non.",
    "userId": "5d9d2901eea25f27419d19e7",
    "createdAt": null,
    "updatedAt": null,
    "notableId": "5d9d2901eea25f27419d19e2"
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:37.724-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTAxZWVhMjVmMjc0MTlkMTlmMSIsImlkIjoiNWQ5ZDI5MDFlZWEyNWYyNzQxOWQxOWYyIiwic2VjcmV0IjoiWC9ua2l3PT0ifQ.68PAVdXBZIzyvYucpT0ufW5UCmdOf-2AODyNusx35mg

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2901eea25f27419d1a0d",
  "type": "Note",
  "data": {
    "id": "5d9d2901eea25f27419d1a0d",
    "body": "body",
    "userId": "5d9d2901eea25f27419d19f2",
    "createdAt": "2019-10-09T00:25:37.983Z",
    "updatedAt": "2019-10-09T00:25:37.983Z",
    "notableId": "5d9d2901eea25f27419d19fe"
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:37.987-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/notes/:id

Parameters

Name Description
data.foo required data.foo

Request

Route

PUT /v1/notes/5d9d2902eea25f27419d1a66

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTAyZWVhMjVmMjc0MTlkMWE0YyIsImlkIjoiNWQ5ZDI5MDJlZWEyNWYyNzQxOWQxYTRkIiwic2VjcmV0IjoiNWZhWUVnPT0ifQ.6PUDhzU4bkhnZnGKavrMQnM4mAzJtbnbDm1vWGpkkPM

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2902eea25f27419d1a66",
  "type": "Note",
  "data": {
    "id": "5d9d2902eea25f27419d1a66",
    "body": "foo",
    "userId": "5d9d2902eea25f27419d1a5e",
    "createdAt": null,
    "updatedAt": "2019-10-09T00:25:38.823Z",
    "notableId": "5d9d2902eea25f27419d1a59"
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:38.826-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/notes/:id

Request

Route

DELETE /v1/notes/5d9d2903eea25f27419d1a82

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTAyZWVhMjVmMjc0MTlkMWE2OCIsImlkIjoiNWQ5ZDI5MDJlZWEyNWYyNzQxOWQxYTY5Iiwic2VjcmV0IjoiR3F0MTZRPT0ifQ.5dMnciwkdpxOgsGmQ_ZFnNthZyHEGBDmM6XnWmg9mjw
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=5d9d2905eea25f27419d1b7d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA1ZWVhMjVmMjc0MTlkMWI3ZSIsImlkIjoiNWQ5ZDI5MDVlZWEyNWYyNzQxOWQxYjdmIiwic2VjcmV0IjoiWjVBUEZBPT0ifQ.cW25mOevU9fOQwNbbSyJDqlhFLKOCofrIH8y9jJX7M0

Query Parameters

challenge_id=5d9d2905eea25f27419d1b7d

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "QuizMultipleChoiceQuestion",
  "data": [
    {
      "id": "5d9d2905eea25f27419d1b82",
      "$type": "QuizMultipleChoiceQuestion",
      "prompt": "Minus veritatis quos nulla temporibus architecto. Nostrum earum amet distinctio dignissimos quis non. Nulla facere consequatur modi consequatur.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {},
      "weight": 1.0,
      "scoredTags": [],
      "choices": [
        "True",
        "False"
      ],
      "maxSelections": null,
      "answers": [
        0
      ]
    },
    {
      "id": "5d9d2905eea25f27419d1b83",
      "$type": "QuizTextQuestion",
      "prompt": "Natus maiores est illum non. Tempore iste quis. Harum deleniti culpa ut. Sapiente ab enim asperiores.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {},
      "weight": 1.0,
      "scoredTags": [],
      "minCharacters": 5,
      "maxCharacters": 200,
      "defaultValue": "",
      "matchers": null
    },
    {
      "id": "5d9d2905eea25f27419d1b84",
      "$type": "QuizWeightedChoiceQuestion",
      "prompt": "Excepturi beatae velit. Vel ad reprehenderit alias. Fuga odit tenetur praesentium. Animi quae magni. Vitae ea illo qui earum dolorum amet.",
      "position": null,
      "allOrNothing": false,
      "timeLimitSec": null,
      "timeLimitStartSec": null,
      "options": {
        "automax": true
      },
      "weight": 1.0,
      "scoredTags": [],
      "maxSelections": 5,
      "maxSum": 5.0,
      "weightedScoring": true,
      "choices": [
        {
          "label": "Ruby",
          "value": 1.0,
          "scoredTags": []
        },
        {
          "label": "Python",
          "value": 0.0,
          "scoredTags": []
        },
        {
          "label": "Php",
          "value": -1.0,
          "scoredTags": []
        },
        {
          "label": "JavaScript",
          "value": 2.0,
          "scoredTags": []
        },
        {
          "label": "TypeScript",
          "value": 2.0,
          "scoredTags": []
        }
      ]
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 3,
  "meta": {
    "timestamp": "2019-10-08T17:25:41.794-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/5d9d2905eea25f27419d1bac

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA1ZWVhMjVmMjc0MTlkMWJhOCIsImlkIjoiNWQ5ZDI5MDVlZWEyNWYyNzQxOWQxYmE5Iiwic2VjcmV0IjoiQWJNUEd3PT0ifQ.6jInt0kYhBPWggZv3NjhFBjuWL8KATCdqlQqlz0LidU

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2905eea25f27419d1bac",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5d9d2905eea25f27419d1bac",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "Quisquam praesentium quae ut id. Odio dignissimos nulla voluptatem voluptatum recusandae. Sapiente molestias ut in ut enim qui. Vel molestiae minima voluptatem tempore odio. Ut ut qui et labore sequi id magni.",
    "position": null,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "scoredTags": [],
    "choices": [
      "True",
      "False"
    ],
    "maxSelections": null,
    "answers": [
      0
    ]
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:41.946-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA2ZWVhMjVmMjc0MTlkMWJiZCIsImlkIjoiNWQ5ZDI5MDZlZWEyNWYyNzQxOWQxYmJlIiwic2VjcmV0IjoiMW95Z25nPT0ifQ.HCdxZOb57siZkd_0ZNgdmMWTYD99XtrNZdz_lMgqtLA

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2906eea25f27419d1bc9",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5d9d2906eea25f27419d1bc9",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "test multiple choice question",
    "position": 4,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "scoredTags": [],
    "choices": [
      "True",
      "False"
    ],
    "maxSelections": 1,
    "answers": [
      1
    ]
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:42.106-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/5d9d2906eea25f27419d1bd7

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA2ZWVhMjVmMjc0MTlkMWJkMyIsImlkIjoiNWQ5ZDI5MDZlZWEyNWYyNzQxOWQxYmQ0Iiwic2VjcmV0IjoibzNqMHRnPT0ifQ.-35WaQsu8Aq8LGMeHsiuAT1-8mDjNzzNUAqrctU79u0

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": "5d9d2906eea25f27419d1bd7",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5d9d2906eea25f27419d1bd7",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "abcd",
    "position": 3,
    "allOrNothing": false,
    "timeLimitSec": null,
    "timeLimitStartSec": null,
    "options": {},
    "weight": 1.0,
    "scoredTags": [],
    "choices": [
      "Red",
      "Yellow",
      "Green"
    ],
    "maxSelections": 1,
    "answers": [
      1,
      2
    ]
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:42.309-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/quiz_questions/:id

Request

Route

DELETE /v1/quiz_questions/5d9d2906eea25f27419d1bee

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA2ZWVhMjVmMjc0MTlkMWJlYSIsImlkIjoiNWQ5ZDI5MDZlZWEyNWYyNzQxOWQxYmViIiwic2VjcmV0IjoieUMyZ01RPT0ifQ.N7wswlKlekiZlRNzFIAoQWvjzd9gLbLnMo2hfKecFOo
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Review Qualities

List

Endpoint

GET /v1/review_qualities

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/review_qualities

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA4ZWVhMjVmMjc0MTlkMWNkMyIsImlkIjoiNWQ5ZDI5MDhlZWEyNWYyNzQxOWQxY2Q0Iiwic2VjcmV0IjoiT29ZWU93PT0ifQ.H6n2iPUSvPgapyyVMfCsp0Yh4SK7C1VhLCqMtzbQNxA

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "ReviewQuality",
  "data": [
    {
      "id": "5d9d2908eea25f27419d1cde",
      "teamId": "5d9d2908eea25f27419d1cd7",
      "active": true,
      "positive": "Levitation",
      "negative": "Enhanced Touch",
      "inLibrary": false
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:25:44.288-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/review_qualities/:id

Request

Route

GET /v1/review_qualities/5d9d2908eea25f27419d1cea

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA4ZWVhMjVmMjc0MTlkMWNkZiIsImlkIjoiNWQ5ZDI5MDhlZWEyNWYyNzQxOWQxY2UwIiwic2VjcmV0IjoiNCtENnZnPT0ifQ.ITfpZyVPJiTJ-FOmfvp-Cs7sEU00woTXRFIMlbyTJ3k

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2908eea25f27419d1cea",
  "type": "ReviewQuality",
  "data": {
    "id": "5d9d2908eea25f27419d1cea",
    "teamId": "5d9d2908eea25f27419d1ce3",
    "active": true,
    "positive": "Sub-Mariner",
    "negative": "Energy Blasts",
    "inLibrary": false
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:44.428-07:00",
    "includes": []
  }
}

Create

Endpoint

POST /v1/review_qualities

Parameters

Name Description
data.positive required a description of the positive side of this quality
data.negative required a description of the negative side of this quality
data.active default is true

Request

Route

POST /v1/review_qualities

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA4ZWVhMjVmMjc0MTlkMWNlYiIsImlkIjoiNWQ5ZDI5MDhlZWEyNWYyNzQxOWQxY2VjIiwic2VjcmV0IjoidDdxMCt3PT0ifQ.lQZfQE_DR7XQLw1lxLJ-rVAzsb755tZMxIDInMOO54Q

Body

{
  "data": {
    "team_id": "5d9d2908eea25f27419d1cef",
    "positive": "Great Implementation",
    "negative": "Poor Implementation"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2908eea25f27419d1cf6",
  "type": "ReviewQuality",
  "data": {
    "id": "5d9d2908eea25f27419d1cf6",
    "teamId": "5d9d2908eea25f27419d1cef",
    "active": true,
    "positive": "Great Implementation",
    "negative": "Poor Implementation",
    "inLibrary": false
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:44.565-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/review_qualities/:id

Parameters

Name Description
data.positive data.positive
data.negative data.negative

Request

Route

PUT /v1/review_qualities/5d9d2908eea25f27419d1d02

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA4ZWVhMjVmMjc0MTlkMWNmNyIsImlkIjoiNWQ5ZDI5MDhlZWEyNWYyNzQxOWQxY2Y4Iiwic2VjcmV0IjoiZkl6YXBRPT0ifQ.iu8NI3XoVU31nVQEUH7ZAzEMNI2g7S6uBEFAfZhiQwk

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2908eea25f27419d1d02",
  "type": "ReviewQuality",
  "data": {
    "id": "5d9d2908eea25f27419d1d02",
    "teamId": "5d9d2908eea25f27419d1cfb",
    "active": true,
    "positive": "positive",
    "negative": "Magnetokinesis",
    "inLibrary": false
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:44.709-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/review_qualities/:id

Request

Route

DELETE /v1/review_qualities/5d9d2908eea25f27419d1d0e

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTA4ZWVhMjVmMjc0MTlkMWQwMyIsImlkIjoiNWQ5ZDI5MDhlZWEyNWYyNzQxOWQxZDA0Iiwic2VjcmV0IjoibGwzQjBnPT0ifQ.u7h2vkuIqxQIjsMvhSIbeVwcU4rNr9_a9m1gLFhsjPE
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

SolutionBrief

List

Endpoint

GET /v1/solution_briefs

Request

Route

GET /v1/solution_briefs

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTBiZWVhMjVmMjc0MTlkMWRmNCIsImlkIjoiNWQ5ZDI5MGJlZWEyNWYyNzQxOWQxZGY1Iiwic2VjcmV0IjoianIwTHBBPT0ifQ.LVCQ8luDBP42DiyHB1uuPLRxfmKtJM8ManxTBXJewF4

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "SolutionBrief",
  "data": [
    {
      "id": "5d9d290beea25f27419d1df3",
      "createdAt": "2019-10-09T00:25:47.107Z",
      "updatedAt": "2019-10-09T00:25:47.131Z",
      "teamId": "5d9d290aeea25f27419d1dd4",
      "candidateId": "5d9d290aeea25f27419d1ddc",
      "teamCandidateId": "5d9d290aeea25f27419d1ddd",
      "assessmentResultId": "5d9d290beea25f27419d1dee",
      "challengeId": "5d9d290aeea25f27419d1dea",
      "sourcedFromId": null,
      "copiedFromId": null,
      "assessmentId": "5d9d290aeea25f27419d1de6",
      "solutionId": "5d9d290aeea25f27419d1dda",
      "solutionCreatedAt": "2019-10-09T00:24:46.921Z",
      "solutionUpdatedAt": "2019-10-09T00:25:47.091Z",
      "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,
      "lastSyncEnqueuedAt": null,
      "lastSyncedAt": "2019-10-09T00:25:48.125Z",
      "syncs": 1,
      "sortScore": null,
      "knownScore": null,
      "confidenceScore": null,
      "opinionScore": null,
      "knownObjectivesScore": null,
      "knownQualitiesScore": null,
      "signalBandsCount": 0,
      "signalRatingsCount": 0,
      "signalBands": {
        "signals_score": {},
        "strength": {},
        "strength_score": {},
        "tag_score": {}
      },
      "attempts": 1,
      "passedTestCases": 1,
      "hiddenPassedTestCases": 0,
      "weightedPassedTestCases": 1,
      "testCaseTagsCount": 0,
      "wallTime": 40,
      "testAttempts": 0,
      "totalTestCases": 1,
      "weightedTestCases": 1,
      "hiddenTestCases": 0,
      "solutionLength": 10,
      "firstTestCaseSolvedAt": "2019-10-09T00:25:46.921Z",
      "completedAt": "2019-10-09T00:25:46.921Z",
      "completedIn": null,
      "language": "javascript",
      "similarity": null,
      "fileCount": null,
      "reopenedCount": null,
      "foreignTestCasesCount": null,
      "completion": null,
      "answers": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:25:47.177-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTBiZWVhMjVmMjc0MTlkMWUzZCIsImlkIjoiNWQ5ZDI5MGJlZWEyNWYyNzQxOWQxZTNlIiwic2VjcmV0IjoiY3FmQVRnPT0ifQ.2Y224z8rjPAnK-SD6AnMN48F6D1AXKR3X4_yzl7I5dU

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "SolutionReview",
  "data": [
    {
      "id": "5d9d290beea25f27419d1e40",
      "reviewedById": "5d9d290beea25f27419d1e3e",
      "reviewedByStaff": null,
      "assessmentId": "5d9d290beea25f27419d1e30",
      "assessmentResultId": "5d9d290beea25f27419d1e38",
      "teamCandidateId": "5d9d290beea25f27419d1e39",
      "candidateId": "5d9d290beea25f27419d1e26",
      "challengeId": "5d9d290beea25f27419d1e34",
      "solutionId": "5d9d290beea25f27419d1e24",
      "rating": 3,
      "feedback": null,
      "assessmentResultReviewId": "5d9d290beea25f27419d1e41",
      "positiveQualityIds": [],
      "negativeQualityIds": [],
      "qualities": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:25:48.078-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solution_reviews/:id

Request

Route

GET /v1/solution_reviews/5d9d290ceea25f27419d1e69

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTBjZWVhMjVmMjc0MTlkMWU2NiIsImlkIjoiNWQ5ZDI5MGNlZWEyNWYyNzQxOWQxZTY3Iiwic2VjcmV0IjoiTTBSZlh3PT0ifQ.KqCxvePp4MrMXkQXRvYKWGTzBx2YbVhnoPG4_Ug-Zg0

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d290ceea25f27419d1e69",
  "type": "SolutionReview",
  "data": {
    "id": "5d9d290ceea25f27419d1e69",
    "reviewedById": "5d9d290ceea25f27419d1e67",
    "reviewedByStaff": null,
    "assessmentId": "5d9d290ceea25f27419d1e59",
    "assessmentResultId": "5d9d290ceea25f27419d1e61",
    "teamCandidateId": "5d9d290ceea25f27419d1e62",
    "candidateId": "5d9d290ceea25f27419d1e4f",
    "challengeId": "5d9d290ceea25f27419d1e5d",
    "solutionId": "5d9d290ceea25f27419d1e4d",
    "rating": 3,
    "feedback": null,
    "assessmentResultReviewId": "5d9d290ceea25f27419d1e6a",
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:48.621-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTBkZWVhMjVmMjc0MTlkMWU4ZiIsImlkIjoiNWQ5ZDI5MGRlZWEyNWYyNzQxOWQxZTkwIiwic2VjcmV0IjoiZWhGV3FRPT0ifQ.2Vcoqv8Qz5yd_RxRTBE47OkKDkhvdFtvH1H-ru4YGA8

Body

{
  "data": {
    "feedback": "",
    "solution_id": "5d9d290ceea25f27419d1e76",
    "assessment_result_review_id": "5d9d290deea25f27419d1e92"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d290deea25f27419d1e93",
  "type": "SolutionReview",
  "data": {
    "id": "5d9d290deea25f27419d1e93",
    "reviewedById": "5d9d290deea25f27419d1e90",
    "reviewedByStaff": false,
    "assessmentId": "5d9d290ceea25f27419d1e82",
    "assessmentResultId": "5d9d290ceea25f27419d1e8a",
    "teamCandidateId": "5d9d290ceea25f27419d1e8b",
    "candidateId": "5d9d290ceea25f27419d1e78",
    "challengeId": "5d9d290ceea25f27419d1e86",
    "solutionId": "5d9d290ceea25f27419d1e76",
    "rating": null,
    "feedback": "",
    "assessmentResultReviewId": "5d9d290deea25f27419d1e92",
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:49.098-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/solution_reviews/:id

Parameters

Name Description
data.feedback required data.feedback

Request

Route

PUT /v1/solution_reviews/5d9d290deea25f27419d1eb8

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTBkZWVhMjVmMjc0MTlkMWViNSIsImlkIjoiNWQ5ZDI5MGRlZWEyNWYyNzQxOWQxZWI2Iiwic2VjcmV0IjoiZXlZYldBPT0ifQ.K7ezCLxMF3hdWopSP0O9MfDl0TGvl_YzeRHxY8igFW0

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d290deea25f27419d1eb8",
  "type": "SolutionReview",
  "data": {
    "id": "5d9d290deea25f27419d1eb8",
    "reviewedById": "5d9d290deea25f27419d1eb6",
    "reviewedByStaff": false,
    "assessmentId": "5d9d290deea25f27419d1ea8",
    "assessmentResultId": "5d9d290deea25f27419d1eb0",
    "teamCandidateId": "5d9d290deea25f27419d1eb1",
    "candidateId": "5d9d290deea25f27419d1e9e",
    "challengeId": "5d9d290deea25f27419d1eac",
    "solutionId": "5d9d290deea25f27419d1e9c",
    "rating": 3,
    "feedback": "feedback",
    "assessmentResultReviewId": "5d9d290deea25f27419d1eb9",
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "qualities": []
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:49.588-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/solution_reviews/:id

Request

Route

DELETE /v1/solution_reviews/5d9d290deea25f27419d1ee1

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTBkZWVhMjVmMjc0MTlkMWVkZSIsImlkIjoiNWQ5ZDI5MGRlZWEyNWYyNzQxOWQxZWRmIiwic2VjcmV0IjoiUUZvZWJBPT0ifQ.XfhMV-bV06bASPPZT6UgFqo1P6Jz3IIv8o--0w7mJsU
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
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]=5d9d290eeea25f27419d1f15

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTBlZWVhMjVmMjc0MTlkMWYyMiIsImlkIjoiNWQ5ZDI5MGVlZWEyNWYyNzQxOWQxZjIzIiwic2VjcmV0IjoiMTFOak5RPT0ifQ.txAY6pijOYtG7gmFDAkuihXGrDRYFp_qSEKPYThxDso

Query Parameters

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "CodeSolution",
  "data": [
    {
      "id": "5d9d290eeea25f27419d1f1a",
      "$type": "CodeSolution",
      "estimatedTime": null,
      "createdAt": "2019-10-09T00:24:50.541Z",
      "challengeId": "5d9d290eeea25f27419d1f1b",
      "assessmentResultId": "5d9d290eeea25f27419d1f16",
      "assessmentId": "5d9d290eeea25f27419d1f0f",
      "candidateId": "5d9d290eeea25f27419d1f14",
      "teamCandidateId": "5d9d290eeea25f27419d1f15",
      "teamId": "5d9d290eeea25f27419d1f09",
      "clonedFromId": null,
      "lastHeartbeat": null,
      "accumulatedSeconds": 0,
      "candidateNotes": null,
      "language": "javascript",
      "firstTestCaseSolvedAt": "2019-10-09T00:25:50.542Z",
      "completedAt": "2019-10-09T00:25:50.542Z",
      "code": "var 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,
      "tags": null,
      "weighted": null,
      "specs": null,
      "assertions": null,
      "response": null,
      "testResponse": null,
      "successMode": "specs",
      "passedTestCases": 1,
      "weightedPassedTestCases": 1,
      "hiddenPassedTestCases": 0,
      "totalTestCases": 1,
      "weightedTestCases": 1,
      "hiddenTestCases": 0,
      "tagTestCases": null,
      "sampleTestCasesEnabled": true,
      "cursor": {},
      "revisionCount": 0,
      "score": 0.0
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:25:50.617-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solutions/:id

Request

Route

GET /v1/solutions/5d9d2910eea25f27419d1fee

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTEwZWVhMjVmMjc0MTlkMWZlZiIsImlkIjoiNWQ5ZDI5MTBlZWEyNWYyNzQxOWQxZmYwIiwic2VjcmV0IjoidTROVlBnPT0ifQ.doo1pCpY0-bJuKW9CHzKaiwIOI63xYKqZtmQ26nNfdg

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2910eea25f27419d1fee",
  "type": "CodeSolution",
  "data": {
    "id": "5d9d2910eea25f27419d1fee",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2019-10-09T00:24:52.475Z",
    "challengeId": "5d9d2910eea25f27419d1ffe",
    "assessmentResultId": "5d9d2910eea25f27419d2002",
    "assessmentId": "5d9d2910eea25f27419d1ffa",
    "candidateId": "5d9d2910eea25f27419d1ff0",
    "teamCandidateId": "5d9d2910eea25f27419d1ff1",
    "teamId": "5d9d2910eea25f27419d1fe8",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2019-10-09T00:25:52.476Z",
    "completedAt": "2019-10-09T00:25:52.476Z",
    "code": "var 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,
    "tags": null,
    "weighted": null,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 1,
    "weightedPassedTestCases": 1,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "weightedTestCases": 1,
    "hiddenTestCases": 0,
    "tagTestCases": null,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 0,
    "score": 100.0
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:52.687-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTEwZWVhMjVmMjc0MTlkMjAxOCIsImlkIjoiNWQ5ZDI5MTBlZWEyNWYyNzQxOWQyMDE5Iiwic2VjcmV0IjoieUlYdHF3PT0ifQ.6g03qIFQseFsdzIu4Ov8rFTgabC7t5UKBJooIsq1MgU

Body

{
  "data": {
    "$type": "CodeSolution",
    "assessment_result_id": "5d9d2910eea25f27419d2017",
    "challenge_id": "5d9d2910eea25f27419d2013",
    "language": "javascript"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2910eea25f27419d201e",
  "type": "CodeSolution",
  "data": {
    "id": "5d9d2910eea25f27419d201e",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2019-10-09T00:25:52.998Z",
    "challengeId": "5d9d2910eea25f27419d2013",
    "assessmentResultId": "5d9d2910eea25f27419d2017",
    "assessmentId": "5d9d2910eea25f27419d200f",
    "candidateId": "5d9d2910eea25f27419d2019",
    "teamCandidateId": "5d9d2910eea25f27419d201a",
    "teamId": "5d9d2910eea25f27419d2009",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": null,
    "completedAt": null,
    "code": "var a = ",
    "testCases": "Test.expect(a == 1)",
    "testFramework": "cw-2",
    "attempts": 0,
    "output": null,
    "wallTime": null,
    "firstTestCompletedIn": null,
    "completedIn": null,
    "tags": null,
    "weighted": null,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 0,
    "weightedPassedTestCases": 0,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "weightedTestCases": 1,
    "hiddenTestCases": 0,
    "tagTestCases": null,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 0,
    "score": 0.0
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:53.013-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/5d9d2911eea25f27419d2027

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTExZWVhMjVmMjc0MTlkMjAyOCIsImlkIjoiNWQ5ZDI5MTFlZWEyNWYyNzQxOWQyMDI5Iiwic2VjcmV0IjoiQ0lyM1BBPT0ifQ.CwB2bjUL0NLG76ru7sFTu2ABIcioenILiJlR6-qM6bA

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": "5d9d2911eea25f27419d2027",
  "type": "CodeSolution",
  "data": {
    "id": "5d9d2911eea25f27419d2027",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2019-10-09T00:24:53.164Z",
    "challengeId": "5d9d2911eea25f27419d2037",
    "assessmentResultId": "5d9d2911eea25f27419d203b",
    "assessmentId": "5d9d2911eea25f27419d2033",
    "candidateId": "5d9d2911eea25f27419d2029",
    "teamCandidateId": "5d9d2911eea25f27419d202a",
    "teamId": "5d9d2911eea25f27419d2021",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2019-10-09T00:25:53.165Z",
    "completedAt": "2019-10-09T00:25:53.165Z",
    "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,
    "tags": null,
    "weighted": null,
    "specs": null,
    "assertions": null,
    "response": null,
    "testResponse": null,
    "successMode": "specs",
    "passedTestCases": 1,
    "weightedPassedTestCases": 1,
    "hiddenPassedTestCases": 0,
    "totalTestCases": 1,
    "weightedTestCases": 1,
    "hiddenTestCases": 0,
    "tagTestCases": null,
    "sampleTestCasesEnabled": true,
    "cursor": {},
    "revisionCount": 2,
    "score": 100.0,
    "revisions": [
      {
        "id": "5d9d2911eea25f27419d2040",
        "createdAt": "2019-10-09T00:24:53.164Z",
        "number": 0,
        "message": null,
        "tag": null,
        "revisedAttributes": {
          "output": [
            {
              "t": "passed",
              "v": "Test Passed"
            }
          ],
          "wall_time": 40,
          "weighted": null,
          "specs": null,
          "assertions": null,
          "tags": null,
          "passed_test_cases": 1,
          "weighted_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": "2019-10-09T00:25:53.165Z",
          "completed_at": "2019-10-09T00:25:53.165Z",
          "reopened_count": 0,
          "cursor": {}
        }
      },
      {
        "id": "5d9d2911eea25f27419d2041",
        "createdAt": "2019-10-09T00:25:53.389Z",
        "number": 1,
        "message": null,
        "tag": "paste",
        "revisedAttributes": {
          "code": "var b = a = 1;"
        }
      }
    ]
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:53.414-07:00",
    "includes": [
      "revisions"
    ]
  }
}

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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTEyZWVhMjVmMjc0MTlkMjA4MiIsImlkIjoiNWQ5ZDI5MTJlZWEyNWYyNzQxOWQyMDgzIiwic2VjcmV0IjoiVEx2cDRRPT0ifQ.Z7OGIv5Ia8g8r5bOw7Of3IbwMCM5V8m1P8ICEol8YwI

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "TeamCandidate",
  "data": [
    {
      "id": "5d9d2911eea25f27419d2065",
      "candidateId": "5d9d2911eea25f27419d2064",
      "teamId": "5d9d2911eea25f27419d2068",
      "state": "started",
      "demoData": false,
      "prevState": null,
      "assessmentIds": [
        "5d9d2911eea25f27419d206e",
        "5d9d2912eea25f27419d207a"
      ],
      "assessmentResultIds": [
        "5d9d2912eea25f27419d2076",
        "5d9d2912eea25f27419d207f"
      ],
      "blinding": "blind_reviewers",
      "createdAt": "2019-10-09T00:25:53.922Z",
      "updatedAt": "2019-10-09T00:25:54.113Z",
      "decidedAt": null,
      "invitedAt": null,
      "interactSessions": 0,
      "stateUpdatedAt": "2019-10-09T00:25:53.922Z",
      "testTeamMember": false,
      "assignedTeamMemberIds": [],
      "labels": null,
      "archived": false,
      "firstName": "Joe",
      "lastName": "Smith628",
      "anonymousName": "Yellow Hare",
      "email": "[email protected]",
      "name": "Joe Smith628",
      "isBlinded": false,
      "stateLabel": "Assessment Started",
      "angelId": null,
      "stateTransitions": [
        "idle",
        "invited",
        "started",
        "submitted",
        "risk_detected",
        "reviewed",
        "approved",
        "rejected",
        "archived"
      ],
      "risks": null,
      "assessmentsRecap": {
        "id": "5d9d2912eea25f27419d2078",
        "subjects": [
          {
            "id": "5d9d2912eea25f27419d2079",
            "assessmentResultId": "5d9d2912eea25f27419d2076",
            "assessmentId": "5d9d2911eea25f27419d206e",
            "state": "started"
          },
          {
            "id": "5d9d2912eea25f27419d2081",
            "assessmentResultId": "5d9d2912eea25f27419d207f",
            "assessmentId": "5d9d2912eea25f27419d207a",
            "state": "started"
          }
        ]
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:25:54.174-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/5d9d2913eea25f27419d212d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTE0ZWVhMjVmMjc0MTlkMjE0YSIsImlkIjoiNWQ5ZDI5MTRlZWEyNWYyNzQxOWQyMTRiIiwic2VjcmV0IjoiTzRuL01BPT0ifQ.OYy_USFTDaM38FV7uoZ0rnbaUyaSSi7KeZDe9auC9Qk

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2913eea25f27419d212d",
  "type": "TeamCandidate",
  "data": {
    "id": "5d9d2913eea25f27419d212d",
    "candidateId": "5d9d2913eea25f27419d212c",
    "teamId": "5d9d2913eea25f27419d2130",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5d9d2914eea25f27419d2136",
      "5d9d2914eea25f27419d2142"
    ],
    "assessmentResultIds": [
      "5d9d2914eea25f27419d213e",
      "5d9d2914eea25f27419d2147"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2019-10-09T00:25:56.001Z",
    "updatedAt": "2019-10-09T00:25:56.198Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2019-10-09T00:25:56.001Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": null,
    "archived": false,
    "firstName": "Joe",
    "lastName": "Smith645",
    "anonymousName": "Beige Clam",
    "email": "[email protected]",
    "name": "Joe Smith645",
    "isBlinded": false,
    "stateLabel": "Assessment Started",
    "angelId": null,
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "risk_detected",
      "reviewed",
      "approved",
      "rejected",
      "archived"
    ],
    "risks": null,
    "assessmentsRecap": {
      "id": "5d9d2914eea25f27419d2140",
      "subjects": [
        {
          "id": "5d9d2914eea25f27419d2141",
          "assessmentResultId": "5d9d2914eea25f27419d213e",
          "assessmentId": "5d9d2914eea25f27419d2136",
          "state": "started"
        },
        {
          "id": "5d9d2914eea25f27419d2149",
          "assessmentResultId": "5d9d2914eea25f27419d2147",
          "assessmentId": "5d9d2914eea25f27419d2142",
          "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": "2019-10-08T17:25:56.251-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/5d9d2915eea25f27419d2187

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTE1ZWVhMjVmMjc0MTlkMjFhNCIsImlkIjoiNWQ5ZDI5MTVlZWEyNWYyNzQxOWQyMWE1Iiwic2VjcmV0IjoiV2xNa3lRPT0ifQ.FrbE6B1dvilN-9d5bMckSwkEcrHIUETAegM_M_7J0dI

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2915eea25f27419d2187",
  "type": "TeamCandidate",
  "data": {
    "id": "5d9d2915eea25f27419d2187",
    "candidateId": "5d9d2915eea25f27419d2186",
    "teamId": "5d9d2915eea25f27419d218a",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5d9d2915eea25f27419d2190",
      "5d9d2915eea25f27419d219c"
    ],
    "assessmentResultIds": [
      "5d9d2915eea25f27419d2198",
      "5d9d2915eea25f27419d21a1"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2019-10-09T00:25:57.094Z",
    "updatedAt": "2019-10-09T00:25:57.344Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2019-10-09T00:25:57.094Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": [],
    "archived": false,
    "firstName": "Test",
    "lastName": "Time",
    "anonymousName": "Lilac Koala",
    "email": "[email protected]",
    "name": "Test Time",
    "isBlinded": false,
    "stateLabel": "Assessment Started",
    "angelId": null,
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "risk_detected",
      "reviewed",
      "approved",
      "rejected",
      "archived"
    ],
    "risks": null,
    "assessmentsRecap": {
      "id": "5d9d2915eea25f27419d219a",
      "subjects": [
        {
          "id": "5d9d2915eea25f27419d219b",
          "assessmentResultId": "5d9d2915eea25f27419d2198",
          "assessmentId": "5d9d2915eea25f27419d2190",
          "state": "started"
        },
        {
          "id": "5d9d2915eea25f27419d21a3",
          "assessmentResultId": "5d9d2915eea25f27419d21a1",
          "assessmentId": "5d9d2915eea25f27419d219c",
          "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": "2019-10-08T17:25:57.418-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTE1ZWVhMjVmMjc0MTlkMjFjNiIsImlkIjoiNWQ5ZDI5MTVlZWEyNWYyNzQxOWQyMWM3Iiwic2VjcmV0IjoiaUJqb1RnPT0ifQ._PYmfk6AWhHQ99xJb8k1BMg4JLD-4DbGWR5EyKT3TPA

Body

{
  "ids": [
    "5d9d2915eea25f27419d21a9",
    "5d9d2915eea25f27419d21cb"
  ],
  "bulk_action": "archive",
  "data": {
    "add_labels": [
      "Bulk Archived"
    ]
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2915eea25f27419d21cc",
  "type": "TeamCandidateBulkEditOperation",
  "data": {
    "id": "5d9d2915eea25f27419d21cc",
    "action": "archive",
    "createdAt": "2019-10-09T00:25:57.824Z",
    "lastCompletionAt": null,
    "totalCount": 2,
    "completedCount": 0,
    "todoCount": 2,
    "completionPercentage": 0.0
  },
  "meta": {
    "timestamp": "2019-10-08T17:25:57.913-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/team_candidates/:id

Parameters

Name Description
id required base16 ObjectId

Request

Route

DELETE /v1/team_candidates/5d9d2919eea25f27419d230a

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTFhZWVhMjVmMjc0MTlkMjMyOCIsImlkIjoiNWQ5ZDI5MWFlZWEyNWYyNzQxOWQyMzI5Iiwic2VjcmV0IjoiOHJRWUVRPT0ifQ.bqv8SI0_dK51gmIirFXBHcYcnHm_R9EtnTgmYVxbC6k
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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTFhZWVhMjVmMjc0MTlkMjM3MyIsImlkIjoiNWQ5ZDI5MWFlZWEyNWYyNzQxOWQyMzc0Iiwic2VjcmV0Ijoib2U4Y2RnPT0ifQ.XzgKjpK3-JsMLx17zFiZ59Nov1iZS9G_9HRkThkDu5c

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "TeamMember",
  "data": [
    {
      "id": "5d9d291aeea25f27419d236b",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith709",
      "name": "Joe Smith709",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2019-10-09T00:26:02.763Z",
      "updatedAt": "2019-10-09T00:26:02.763Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_Yup06zLUAVi2e5L3z0pfGg",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "8rHkLy0gBJMEKQ.5d9d291aeea25f27419d236b",
      "teamId": "5d9d291aeea25f27419d235e",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2019-10-09T00:26:02.760Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5d9d291aeea25f27419d236c",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5d9d291aeea25f27419d2368",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith708",
      "name": "Joe Smith708",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2019-10-09T00:26:02.744Z",
      "updatedAt": "2019-10-09T00:26:02.744Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_8a6V7QCY3hxfztDYtRmCvw",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "mSA6ouAgBPbmyw.5d9d291aeea25f27419d2368",
      "teamId": "5d9d291aeea25f27419d235e",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2019-10-09T00:26:02.741Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5d9d291aeea25f27419d2369",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5d9d291aeea25f27419d2365",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith707",
      "name": "Joe Smith707",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2019-10-09T00:26:02.725Z",
      "updatedAt": "2019-10-09T00:26:02.725Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_pGbBrmLweFs2cr7tmgW3pg",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "4CSgaaeverwcmw.5d9d291aeea25f27419d2365",
      "teamId": "5d9d291aeea25f27419d235e",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2019-10-09T00:26:02.722Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5d9d291aeea25f27419d2366",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5d9d291aeea25f27419d235a",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith706",
      "name": "Joe Smith706",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2019-10-09T00:26:02.653Z",
      "updatedAt": "2019-10-09T00:26:02.653Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_hbOrsj6qO4tzhPJvPtCEXg",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "yfrgNgbbjSBdfQ.5d9d291aeea25f27419d235a",
      "teamId": "5d9d291aeea25f27419d2350",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2019-10-09T00:26:02.650Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5d9d291aeea25f27419d235b",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5d9d291aeea25f27419d2357",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith705",
      "name": "Joe Smith705",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2019-10-09T00:26:02.626Z",
      "updatedAt": "2019-10-09T00:26:02.626Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_f5pofMDrVe9OZYr5t60jOA",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "VuO6zRahyyvOQw.5d9d291aeea25f27419d2357",
      "teamId": "5d9d291aeea25f27419d2350",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2019-10-09T00:26:02.623Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5d9d291aeea25f27419d2358",
        "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": "2019-10-08T17:26:02.856-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/5d9d291beea25f27419d23ef?includes[]=team&includes[]=authored_challenges&includes[]=authored_assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTFiZWVhMjVmMjc0MTlkMjNmMSIsImlkIjoiNWQ5ZDI5MWJlZWEyNWYyNzQxOWQyM2YyIiwic2VjcmV0IjoiREZ3N0J3PT0ifQ.okXetCOkpAfiwQe1rRzh1tRCxbUED_LsTHMcqjmpJ-E

Query Parameters

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d291beea25f27419d23ef",
  "type": "TeamMember",
  "data": {
    "id": "5d9d291beea25f27419d23ef",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith734",
    "name": "Joe Smith734",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2019-10-09T00:26:03.862Z",
    "updatedAt": "2019-10-09T00:26:03.862Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_d6QsoWabYrF3CxAECJdLrg",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "nzKp78YjsYnb2w.5d9d291beea25f27419d23ef",
    "teamId": "5d9d291beea25f27419d23e8",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "angelApiKey": null,
    "team": {
      "id": "5d9d291beea25f27419d23e8",
      "name": "team303",
      "updatedAt": "2019-10-09T00:26:03.821Z",
      "highConcept": null,
      "website": null,
      "productTypes": {
        "_id": "5d9d291beea25f27419d23eb",
        "education": true,
        "recruitment": true
      },
      "customerId": "5d9d291beea25f27419d23e6",
      "hasDemoData": false,
      "buildingDemoData": false,
      "destroyingDemoData": false,
      "surveysDisabled": null,
      "defaultEnableExternalIde": true,
      "labs": {
        "externalIde": false,
        "angellistSourcing": false
      },
      "logoImg": {
        "id": "5d9d291beea25f27419d23ea",
        "fileId": "SPaLzg",
        "fileFormat": "jpg",
        "width": 500,
        "height": 500,
        "url": "//res.cloudinary.com/strive/image/upload/SPaLzg.jpg",
        "rawUrl": "https://s3-us-west-1.amazonaws.com/strive-uploads/SPaLzg.jpg",
        "size": null,
        "brightness": null,
        "background": null
      },
      "createdAt": "2019-10-09T00:26:03.821Z",
      "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": "5d9d291beea25f27419d23f3",
        "subdomain": null,
        "url": null,
        "jobStatuses": null,
        "jobs": null,
        "lastPollAt": null
      },
      "bambooConnected": false,
      "apiKey": null,
      "zapierApiKey": null,
      "greenhouseApiKey": null,
      "workableApiKey": null,
      "hasBlindReviewers": false,
      "msaSigned": false,
      "desiredFeatures": {
        "id": "5d9d291beea25f27419d23ed",
        "takeHome": true
      },
      "progressEvents": {
        "id": "5d9d291beea25f27419d23f4"
      },
      "salesLeadQuality": null,
      "salesLeadContacted": false,
      "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": "5d9d291beea25f27419d23ec",
        "utmSource": "qualified"
      }
    },
    "activatedAt": "2019-10-09T00:26:03.859Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5d9d291beea25f27419d23f0",
      "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": "2019-10-08T17:26:03.919-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTFiZWVhMjVmMjc0MTlkMjNmNSIsImlkIjoiNWQ5ZDI5MWJlZWEyNWYyNzQxOWQyM2Y2Iiwic2VjcmV0IjoiY2hyRWVnPT0ifQ.IV69mJv7PPOr2-8Z-IJwW3TtqM1Mco6XPX5L4kEXe3U

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d291ceea25f27419d2400",
  "type": "TeamMember",
  "data": {
    "id": "5d9d291ceea25f27419d2400",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith",
    "name": "Joe Smith",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2019-10-09T00:26:04.057Z",
    "updatedAt": "2019-10-09T00:26:04.057Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_KHoLFbf9RLeJPWokSN2HLQ",
    "hasPassword": false,
    "intercomUrl": null,
    "confirmationToken": "ZGs68DpToYYNLw.5d9d291ceea25f27419d2400",
    "teamId": "5d9d291ceea25f27419d23f9",
    "role": "owner",
    "state": "invited",
    "disabled": false,
    "angelApiKey": null,
    "activatedAt": "2019-10-09T00:26:04.057Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5d9d291ceea25f27419d2401",
      "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": "2019-10-08T17:26:04.065-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/5d9d291ceea25f27419d2405

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTFjZWVhMjVmMjc0MTlkMjQwMiIsImlkIjoiNWQ5ZDI5MWNlZWEyNWYyNzQxOWQyNDAzIiwic2VjcmV0IjoiSHMvUmtBPT0ifQ.cvtLaxc5M3pXqRXkqFVD2XV6yeraKzLo2LDk3Fq7_WY

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": "5d9d291ceea25f27419d2405",
  "type": "TeamMember",
  "data": {
    "id": "5d9d291ceea25f27419d2405",
    "$type": "TeamMember",
    "firstName": "Test",
    "lastName": "Time",
    "name": "Test Time",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2019-10-09T00:26:04.192Z",
    "updatedAt": "2019-10-09T00:26:04.230Z",
    "uiPrefs": {
      "theme": "dark"
    },
    "experiments": null,
    "envRoomId": "test_LTECOvJFDPj5GzKQ47zdOw",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "6mGU9UROG8QJKw.5d9d291ceea25f27419d2405",
    "teamId": "5d9d291ceea25f27419d2408",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "angelApiKey": null,
    "activatedAt": "2019-10-09T00:26:04.130Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5d9d291ceea25f27419d240e",
      "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": "2019-10-08T17:26:04.236-07:00",
    "includes": []
  }
}

WebhookSubscriptions

List

Endpoint

GET /v1/webhook_subscriptions

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/webhook_subscriptions

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTIzZWVhMjVmMjc0MTlkMjcwNCIsImlkIjoiNWQ5ZDI5MjNlZWEyNWYyNzQxOWQyNzA1Iiwic2VjcmV0IjoiR2FjWktBPT0ifQ.TuDdkq1YnbhGHLYxwDs5VTxPlbWZoFPZ_1rMdUv3e-o

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "WebhookSubscription",
  "data": [
    {
      "id": "5d9d2923eea25f27419d270f",
      "name": "Default",
      "url": "https://www.test.com/ejhim",
      "schema": "v1",
      "triggerOnAll": false,
      "eventTriggers": {
        "id": "5d9d2923eea25f27419d2710",
        "challengeCreated": true
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2019-10-08T17:26:11.431-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/webhook_subscriptions/:id

Request

Route

GET /v1/webhook_subscriptions/5d9d2923eea25f27419d271c

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTIzZWVhMjVmMjc0MTlkMjcxMSIsImlkIjoiNWQ5ZDI5MjNlZWEyNWYyNzQxOWQyNzEyIiwic2VjcmV0IjoiaXNrajNnPT0ifQ.HMgkVZJ8P5f5dnY2jJVh5__Wqyh_vlwSvAPeMsYhrq4

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2923eea25f27419d271c",
  "type": "WebhookSubscription",
  "data": {
    "id": "5d9d2923eea25f27419d271c",
    "name": "Default",
    "url": "https://www.test.com/hgter",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5d9d2923eea25f27419d271d",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2019-10-08T17:26:11.573-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.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTIzZWVhMjVmMjc0MTlkMjcxZSIsImlkIjoiNWQ5ZDI5MjNlZWEyNWYyNzQxOWQyNzFmIiwic2VjcmV0IjoiM3l1MEh3PT0ifQ.4utbUUKttUlKbw_PnCX1DEKdXZtebclRZghFadWRy2w

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": "5d9d2923eea25f27419d2729",
  "type": "WebhookSubscription",
  "data": {
    "id": "5d9d2923eea25f27419d2729",
    "name": "My Hook",
    "url": "https://www.test.com/d8d3fa",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5d9d2923eea25f27419d272a",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2019-10-08T17:26:11.728-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/5d9d2924eea25f27419d2745

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTIzZWVhMjVmMjc0MTlkMjczYSIsImlkIjoiNWQ5ZDI5MjNlZWEyNWYyNzQxOWQyNzNiIiwic2VjcmV0IjoiUTc0R3dnPT0ifQ.ck01wGNZujx3lEHrFasQEx1xmPDJ0OvCH__U_CuhAMs

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5d9d2924eea25f27419d2745",
  "type": "WebhookSubscription",
  "data": {
    "id": "5d9d2924eea25f27419d2745",
    "name": "My Hook",
    "url": "https://www.test.com/bkvat",
    "schema": "v1",
    "triggerOnAll": false,
    "eventTriggers": {
      "id": "5d9d2924eea25f27419d2746",
      "challengeCreated": true
    }
  },
  "meta": {
    "timestamp": "2019-10-08T17:26:12.110-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/webhook_subscriptions/:id

Request

Route

DELETE /v1/webhook_subscriptions/5d9d2924eea25f27419d2752

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjVkOWQyOTI0ZWVhMjVmMjc0MTlkMjc0NyIsImlkIjoiNWQ5ZDI5MjRlZWEyNWYyNzQxOWQyNzQ4Iiwic2VjcmV0IjoiaER0c1pnPT0ifQ.TdCGRBdHu1_QQzKcNhDyhUkmwWuOBlPnpVt_ep2vzA4
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/jdquf

Headers

Authorization: OQU47i6sqiGqaXLGZqEI+9Q35lSyZ+qJ
Content-Type: application/x-www-form-urlencoded

Query Parameters

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

Response

Simulated Response

Status

204