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

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM2ZWVhMjVmY2YzN2QyMjc5MiIsImlkIjoiNWJiM2JkYzZlZWEyNWZjZjM3ZDIyNzkzIiwic2VjcmV0IjoiOGh1N3lRPT0ifQ._8WpO2iPWNWWVWh4sGpX7VCjF3sxOEx1R7p9Pl0VpP4

Body

{
  "data": {
    "challenge_id": "5bb3bdc6eea25fcf37d22795"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdc6eea25fcf37d2279b",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5bb3bdc6eea25fcf37d2279b",
    "challengeId": "5bb3bdc6eea25fcf37d22795",
    "position": 1,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2018-10-02T11:49:42.907-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/5bb3bdc6eea25fcf37d227a4/challenge_items/5bb3bdc6eea25fcf37d227ab

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM2ZWVhMjVmY2YzN2QyMjdhNSIsImlkIjoiNWJiM2JkYzZlZWEyNWZjZjM3ZDIyN2E2Iiwic2VjcmV0IjoiZkhnUDJ3PT0ifQ.0_cUSpSPUNuyRo_RFKG4MSoKP0l_ssQTvjidm41yX-0

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdc6eea25fcf37d227ab",
  "type": "AssessmentChallengeItem",
  "data": {
    "id": "5bb3bdc6eea25fcf37d227ab",
    "challengeId": "5bb3bdc6eea25fcf37d227a8",
    "position": 2,
    "disabledLanguages": []
  },
  "meta": {
    "timestamp": "2018-10-02T11:49:43.021-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/5bb3bdc7eea25fcf37d227b8/challenge_items/5bb3bdc7eea25fcf37d227bf

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM3ZWVhMjVmY2YzN2QyMjdiOSIsImlkIjoiNWJiM2JkYzdlZWEyNWZjZjM3ZDIyN2JhIiwic2VjcmV0IjoiSnVjUktnPT0ifQ.LwqCFRFmWrXBFj4G97_WB_lUCj6LKwgVQ6JW3Lqb64M
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

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.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM3ZWVhMjVmY2YzN2QyMjdjOCIsImlkIjoiNWJiM2JkYzdlZWEyNWZjZjM3ZDIyN2M5Iiwic2VjcmV0IjoiZkxYY3NBPT0ifQ.EDlNzzDGchS9LKOZqSOm1rmLXfqgcnpEoSCkomhpK40

Query Parameters

{}=

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5bb3bdc7eea25fcf37d227dd",
      "state": "active",
      "teamCandidateId": "5bb3bdc7eea25fcf37d227e5",
      "assessmentId": "5bb3bdc7eea25fcf37d227de",
      "assessmentResultId": "5bb3bdc7eea25fcf37d227e9",
      "teamId": "5bb3bdc7eea25fcf37d227c2",
      "teamMemberId": "5bb3bdc7eea25fcf37d227e7",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "assessmentTitle": "Junior Ruby Engineer #65",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith56",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5bb3bdc7eea25fcf37d227de?activate=eVKgaxukuyoTyQ.5bb3bdc7eea25fcf37d227e4&email=loginidentity56%40example.com&invite=rd5VvWodYbBdmg",
      "invitePracticePath": "/assess/practice?activate=eVKgaxukuyoTyQ.5bb3bdc7eea25fcf37d227e4&email=loginidentity56%40example.com&invite=rd5VvWodYbBdmg&returnTo=%2Fassess%2F5bb3bdc7eea25fcf37d227de%3Factivate%3DeVKgaxukuyoTyQ.5bb3bdc7eea25fcf37d227e4%26email%3Dloginidentity56%2540example.com%26invite%3Drd5VvWodYbBdmg"
    },
    {
      "id": "5bb3bdc7eea25fcf37d227ed",
      "state": "active",
      "teamCandidateId": "5bb3bdc7eea25fcf37d227f5",
      "assessmentId": "5bb3bdc7eea25fcf37d227ee",
      "assessmentResultId": "5bb3bdc7eea25fcf37d227f9",
      "teamId": "5bb3bdc7eea25fcf37d227c2",
      "teamMemberId": "5bb3bdc7eea25fcf37d227f7",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "assessmentTitle": "Senior Angular Developer #66",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith58",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5bb3bdc7eea25fcf37d227ee?activate=xKUjdSd8cUCOUw.5bb3bdc7eea25fcf37d227f4&email=loginidentity58%40example.com&invite=sL7MKcCKEwQDPg",
      "invitePracticePath": "/assess/practice?activate=xKUjdSd8cUCOUw.5bb3bdc7eea25fcf37d227f4&email=loginidentity58%40example.com&invite=sL7MKcCKEwQDPg&returnTo=%2Fassess%2F5bb3bdc7eea25fcf37d227ee%3Factivate%3DxKUjdSd8cUCOUw.5bb3bdc7eea25fcf37d227f4%26email%3Dloginidentity58%2540example.com%26invite%3DsL7MKcCKEwQDPg"
    },
    {
      "id": "5bb3bdc7eea25fcf37d227fd",
      "state": "active",
      "teamCandidateId": "5bb3bdc7eea25fcf37d22805",
      "assessmentId": "5bb3bdc7eea25fcf37d227fe",
      "assessmentResultId": "5bb3bdc7eea25fcf37d22809",
      "teamId": "5bb3bdc7eea25fcf37d227c2",
      "teamMemberId": "5bb3bdc7eea25fcf37d22807",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "assessmentTitle": "Senior Web Developer #67",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "Joe Smith60",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5bb3bdc7eea25fcf37d227fe?activate=F8rbUm0Yr9Ztkg.5bb3bdc7eea25fcf37d22804&email=loginidentity60%40example.com&invite=VNCTbvpcTUq8AA",
      "invitePracticePath": "/assess/practice?activate=F8rbUm0Yr9Ztkg.5bb3bdc7eea25fcf37d22804&email=loginidentity60%40example.com&invite=VNCTbvpcTUq8AA&returnTo=%2Fassess%2F5bb3bdc7eea25fcf37d227fe%3Factivate%3DF8rbUm0Yr9Ztkg.5bb3bdc7eea25fcf37d22804%26email%3Dloginidentity60%2540example.com%26invite%3DVNCTbvpcTUq8AA"
    }
  ],
  "meta": {
    "timestamp": "2018-10-02T11:49:43.678-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
candidates required Array
assessment_id required base16 ObjectId

Request

Route

POST /v1/assessment_invitations/invite_candidates

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM3ZWVhMjVmY2YzN2QyMjgxNSIsImlkIjoiNWJiM2JkYzdlZWEyNWZjZjM3ZDIyODE2Iiwic2VjcmV0IjoiaDQ0WnpnPT0ifQ.iJThSZwdm2Cjejot8fr2UDLOOtZfF3TgXTsW5ZDBn2E

Body

{
  "data": {
    "candidates": [
      "[email protected]"
    ],
    "assessment_id": "5bb3bdc7eea25fcf37d22818"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5bb3bdc7eea25fcf37d22820",
      "state": "active",
      "teamCandidateId": "5bb3bdc7eea25fcf37d2281b",
      "assessmentId": "5bb3bdc7eea25fcf37d22818",
      "assessmentResultId": "5bb3bdc7eea25fcf37d2281c",
      "teamId": "5bb3bdc7eea25fcf37d2280f",
      "teamMemberId": "5bb3bdc7eea25fcf37d22816",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "assessmentTitle": "Mid-Level Web Engineer #68",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "",
      "candidateEmail": "[email protected]",
      "testTeamMember": false,
      "inviterRole": "owner",
      "invitePath": "/assess/5bb3bdc7eea25fcf37d22818?activate=8U4dFdTCauLrmQ.5bb3bdc7eea25fcf37d2281a&email=George%40place.com&invite=diTTJrzefY4HGQ",
      "invitePracticePath": "/assess/practice?activate=8U4dFdTCauLrmQ.5bb3bdc7eea25fcf37d2281a&email=George%40place.com&invite=diTTJrzefY4HGQ&returnTo=%2Fassess%2F5bb3bdc7eea25fcf37d22818%3Factivate%3D8U4dFdTCauLrmQ.5bb3bdc7eea25fcf37d2281a%26email%3DGeorge%2540place.com%26invite%3DdiTTJrzefY4HGQ"
    }
  ],
  "meta": {
    "timestamp": "2018-10-02T11:49:43.845-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM4ZWVhMjVmY2YzN2QyMjgzZiIsImlkIjoiNWJiM2JkYzhlZWEyNWZjZjM3ZDIyODQwIiwic2VjcmV0IjoiaEF4Qll3PT0ifQ.J15rYUpeFuvoXLntHrS8Xm1OhcdPECfYDtWlNZkNK9M

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentInvitation",
  "data": [
    {
      "id": "5bb3bdc8eea25fcf37d2284c",
      "state": "active",
      "teamCandidateId": "5bb3bdc8eea25fcf37d22847",
      "assessmentId": "5bb3bdc8eea25fcf37d22842",
      "assessmentResultId": "5bb3bdc8eea25fcf37d22848",
      "teamId": "5bb3bdc8eea25fcf37d22839",
      "teamMemberId": "5bb3bdc8eea25fcf37d22840",
      "sendEmailToCandidate": true,
      "sendEmailToInviter": false,
      "expiresAt": null,
      "reminderAt": null,
      "reminded": false,
      "invitedByAssessmentTitle": null,
      "invitedByWorkflowLabel": null,
      "assessmentTitle": "Senior Angular Engineer #70",
      "sendAttempts": 0,
      "openCount": null,
      "lastSent": null,
      "candidateName": "",
      "candidateEmail": "[email protected]",
      "testTeamMember": true,
      "inviterRole": "owner",
      "invitePath": "/assess/5bb3bdc8eea25fcf37d22842?activate=QGb42gHJGZ4L2A.5bb3bdc8eea25fcf37d22846&email=George%40place.com&invite=Q4cBWVgbrxX87w",
      "invitePracticePath": "/assess/practice?activate=QGb42gHJGZ4L2A.5bb3bdc8eea25fcf37d22846&email=George%40place.com&invite=Q4cBWVgbrxX87w&returnTo=%2Fassess%2F5bb3bdc8eea25fcf37d22842%3Factivate%3DQGb42gHJGZ4L2A.5bb3bdc8eea25fcf37d22846%26email%3DGeorge%2540place.com%26invite%3DQ4cBWVgbrxX87w"
    }
  ],
  "meta": {
    "timestamp": "2018-10-02T11:49:44.212-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM4ZWVhMjVmY2YzN2QyMjhiZCIsImlkIjoiNWJiM2JkYzhlZWEyNWZjZjM3ZDIyOGJlIiwic2VjcmV0IjoidUhTTGx3PT0ifQ.5olFc6ZJb1TWqDaGjLD3bRyXTBV-1cn5wExYIV5PAsM

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentResultReview",
  "data": [
    {
      "id": "5bb3bdc8eea25fcf37d228b9",
      "reviewedById": "5bb3bdc8eea25fcf37d228bb",
      "reviewedByStaff": null,
      "assessmentId": "5bb3bdc8eea25fcf37d228aa",
      "assessmentResultId": "5bb3bdc8eea25fcf37d228b2",
      "teamCandidateId": "5bb3bdc8eea25fcf37d228b5",
      "candidateId": "5bb3bdc8eea25fcf37d228b4",
      "rating": 5,
      "feedback": "great!",
      "state": "started"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2018-10-02T11:49:44.953-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/assessment_result_reviews/:id

Request

Route

GET /v1/assessment_result_reviews/5bb3bdc9eea25fcf37d228da

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM5ZWVhMjVmY2YzN2QyMjhkNyIsImlkIjoiNWJiM2JkYzllZWEyNWZjZjM3ZDIyOGQ4Iiwic2VjcmV0IjoicWt4Z2xnPT0ifQ.xdAmmnInckhgwZ-voaVNHg4BpGLD7jIDSm2raNrv1-Q

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdc9eea25fcf37d228da",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5bb3bdc9eea25fcf37d228da",
    "reviewedById": "5bb3bdc9eea25fcf37d228dc",
    "reviewedByStaff": null,
    "assessmentId": "5bb3bdc8eea25fcf37d228c8",
    "assessmentResultId": "5bb3bdc9eea25fcf37d228d0",
    "teamCandidateId": "5bb3bdc9eea25fcf37d228d3",
    "candidateId": "5bb3bdc9eea25fcf37d228d2",
    "rating": 5,
    "feedback": "great!",
    "state": "started"
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2018-10-02T11:49:45.131-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM5ZWVhMjVmY2YzN2QyMjhmNSIsImlkIjoiNWJiM2JkYzllZWEyNWZjZjM3ZDIyOGY2Iiwic2VjcmV0IjoiTEVxQklBPT0ifQ.It3R6yYpGOTs4_toxU5kyijv1RReD7BynE9EuEP5L84

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdc9eea25fcf37d228f8",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5bb3bdc9eea25fcf37d228f8",
    "reviewedById": "5bb3bdc9eea25fcf37d228f6",
    "reviewedByStaff": false,
    "assessmentId": "5bb3bdc9eea25fcf37d228e6",
    "assessmentResultId": "5bb3bdc9eea25fcf37d228ee",
    "teamCandidateId": "5bb3bdc9eea25fcf37d228f1",
    "candidateId": "5bb3bdc9eea25fcf37d228f0",
    "rating": null,
    "feedback": "super duper",
    "state": "started"
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2018-10-02T11:49:45.292-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/5bb3bdc9eea25fcf37d22913

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM5ZWVhMjVmY2YzN2QyMjkxMCIsImlkIjoiNWJiM2JkYzllZWEyNWZjZjM3ZDIyOTExIiwic2VjcmV0IjoibkdEd1JnPT0ifQ.VCLmSvKaE8y5JeO1nMEZ8mtIY0X1PyBOezGfVdy1j5k

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdc9eea25fcf37d22913",
  "type": "AssessmentResultReview",
  "data": {
    "id": "5bb3bdc9eea25fcf37d22913",
    "reviewedById": "5bb3bdc9eea25fcf37d22915",
    "reviewedByStaff": false,
    "assessmentId": "5bb3bdc9eea25fcf37d22901",
    "assessmentResultId": "5bb3bdc9eea25fcf37d22909",
    "teamCandidateId": "5bb3bdc9eea25fcf37d2290c",
    "candidateId": "5bb3bdc9eea25fcf37d2290b",
    "rating": 3,
    "feedback": "feedback",
    "state": "started"
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "started",
          "text": "Started"
        },
        {
          "value": "submitted",
          "text": "Submitted"
        }
      ]
    },
    "timestamp": "2018-10-02T11:49:45.505-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/assessment_result_reviews/:id

Request

Route

DELETE /v1/assessment_result_reviews/5bb3bdc9eea25fcf37d22931

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM5ZWVhMjVmY2YzN2QyMjkyZSIsImlkIjoiNWJiM2JkYzllZWEyNWZjZjM3ZDIyOTJmIiwic2VjcmV0IjoiUEJJaFZnPT0ifQ.PsoZxerH2uiiPSzXzu9ogCjA5Sqw83R3UfpRG0iPMRA
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

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.eyJpZGVudGl0eV9pZCI6IjViYjNiZGM5ZWVhMjVmY2YzN2QyMjk1ZiIsImlkIjoiNWJiM2JkYzllZWEyNWZjZjM3ZDIyOTYwIiwic2VjcmV0IjoiRWYvVXdBPT0ifQ.61Bx3Lth4DzAUvVGbOlFALSklF1RIi9vOLNRr7YMs6o

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "AssessmentResult",
  "data": [
    {
      "id": "5bb3bdc9eea25fcf37d22959",
      "assessmentId": "5bb3bdc9eea25fcf37d22954",
      "candidateId": "5bb3bdc9eea25fcf37d22936",
      "teamCandidateId": "5bb3bdc9eea25fcf37d2295a",
      "teamId": "5bb3bdc9eea25fcf37d22939",
      "state": "started",
      "createdAt": "2018-10-02T18:49:45.895Z",
      "updatedAt": "2018-10-02T18:49:45.895Z",
      "startedAt": "2018-10-02T18:49:45.895Z",
      "invitedAt": null,
      "submittedAt": null,
      "submittingAt": null,
      "openedAt": null,
      "originalOpenedAt": null,
      "originalStartedAt": null,
      "originalSubmittedAt": null,
      "candidateName": "Joe Smith96",
      "candidateEmail": "[email protected]",
      "candidatePhone": 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,
      "interviewerIds": [],
      "activeInterviewerIds": [],
      "abandoned": false,
      "workflowName": null,
      "isInteractSession": false,
      "challengeItems": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2018-10-02T11:49:45.961-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/5bb3bdcbeea25fcf37d22a33/report_url

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGNiZWVhMjVmY2YzN2QyMmEwZiIsImlkIjoiNWJiM2JkY2JlZWEyNWZjZjM3ZDIyYTEwIiwic2VjcmV0IjoiTlhIaVFnPT0ifQ.jDe1o91pcpW91LO90VwgSvo2fbKuQC6daTkdcjJxMR4

Response

Simulated Response

Status

200

Headers

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

Body

{
  "url": "https://localhost:9898/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjViYjNiZGNiZWVhMjVmY2YzN2QyMmEzMyIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWJiM2JkY2JlZWEyNWZjZjM3ZDIyYTEzIn0.rkn9S8fD5NKuL339IcRt9BitAs6c7UO6rjRZzQZgs_0",
  "pdf": "https://localhost:9898/pdf/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjViYjNiZGNiZWVhMjVmY2YzN2QyMmEzMyIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWJiM2JkY2JlZWEyNWZjZjM3ZDIyYTEzIn0.rkn9S8fD5NKuL339IcRt9BitAs6c7UO6rjRZzQZgs_0"
}

Get

Endpoint

GET /v1/assessment_results/:id/report_url

Parameters

Name Description
id base64 or base16 ObjectId

Request

Route

GET /v1/assessment_results/5bb3bdcbeea25fcf37d22a33/report_url

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGNiZWVhMjVmY2YzN2QyMmEwZiIsImlkIjoiNWJiM2JkY2JlZWEyNWZjZjM3ZDIyYTEwIiwic2VjcmV0IjoiTlhIaVFnPT0ifQ.jDe1o91pcpW91LO90VwgSvo2fbKuQC6daTkdcjJxMR4

Response

Simulated Response

Status

200

Headers

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

Body

{
  "url": "https://localhost:9898/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjViYjNiZGNiZWVhMjVmY2YzN2QyMmEzMyIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWJiM2JkY2JlZWEyNWZjZjM3ZDIyYTEzIn0.rkn9S8fD5NKuL339IcRt9BitAs6c7UO6rjRZzQZgs_0",
  "pdf": "https://localhost:9898/pdf/reports/eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJyZXBvcnQiOiJhc3Nlc3NtZW50X3Jlc3VsdCIsInJlcG9ydF9pZCI6IjViYjNiZGNiZWVhMjVmY2YzN2QyMmEzMyIsInRva2VuX3R5cGUiOiJyZXBvcnQiLCJ0ZWFtX2lkIjoiNWJiM2JkY2JlZWEyNWZjZjM3ZDIyYTEzIn0.rkn9S8fD5NKuL339IcRt9BitAs6c7UO6rjRZzQZgs_0"
}

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

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGNjZWVhMjVmY2YzN2QyMmIwNSIsImlkIjoiNWJiM2JkY2NlZWEyNWZjZjM3ZDIyYjA2Iiwic2VjcmV0IjoiMnhPZFBBPT0ifQ.gCnyh1d9YRGORp6PMuSENZBw_wegjmjUjOOVZd4hdxE
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdcceea25fcf37d22b0c",
  "type": "AssessmentResult",
  "data": {
    "id": "5bb3bdcceea25fcf37d22b0c",
    "assessmentId": "5bb3bdcceea25fcf37d22b04",
    "candidateId": "5bb3bdcceea25fcf37d22afb",
    "teamCandidateId": "5bb3bdcceea25fcf37d22b0d",
    "teamId": "5bb3bdcceea25fcf37d22afe",
    "state": "opened",
    "createdAt": "1970-01-01T02:51:59.999Z",
    "updatedAt": "2018-10-02T18:49:49.037Z",
    "startedAt": null,
    "invitedAt": null,
    "submittedAt": null,
    "submittingAt": "1970-01-01T02:16:59.999Z",
    "openedAt": "2018-10-02T18:49:49.031Z",
    "originalOpenedAt": null,
    "originalStartedAt": null,
    "originalSubmittedAt": "2018-10-02T18:49:48.996Z",
    "candidateName": "Joe Smith180",
    "candidateEmail": "[email protected]",
    "candidatePhone": null,
    "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": "5bb3bdcceea25fcf37d22b06",
    "activeTimedSolutionId": null,
    "isActiveInteractSession": false,
    "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": "2018-10-02T11:49:49.057-07:00",
    "includes": []
  }
}

Assessment Templates

List

Endpoint

GET /v1/assessment_templates

Request

Route

GET /v1/assessment_templates

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGNkZWVhMjVmY2YzN2QyMmJhMSIsImlkIjoiNWJiM2JkY2RlZWEyNWZjZjM3ZDIyYmEyIiwic2VjcmV0IjoiLytDR1dBPT0ifQ.gYTq8aqe0_lxu9qlkYYlv1VKbyI-bWAgSsoTH10awG8

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5bb3bdcdeea25fcf37d22b19",
      "title": "Junior Mobile Developer #90",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5bb3bdcdeea25fcf37d22b13",
      "inviteOnly": false,
      "softDeletedAt": null,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 12,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Sunt et harum quia inventore sint voluptates. Qui in maxime veniam dolorum. Omnis saepe vitae aut. In omnis nihil et.",
      "challengeItems": [
        {
          "id": "5bb3bdcdeea25fcf37d22b20",
          "challengeId": "5bb3bdcdeea25fcf37d22b1d",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b1d",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Node Methods #147",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.124Z",
            "updatedAt": "2018-10-02T18:49:49.124Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b1e",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b1f",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "DZ484v37Y+SoYQx9Cu0m7ZWOdtIofDfV1LjMOpoiQcw=\n--J6FGqQzkDb8959uHIuUjgQ==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b24",
          "challengeId": "5bb3bdcdeea25fcf37d22b21",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b21",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Fibonacci Regex #148",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.144Z",
            "updatedAt": "2018-10-02T18:49:49.144Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b22",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b23",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "gdWb4s2dvSci4QbPAbQDfyjgO5Nle+ewOvux6SaQzJo=\n--Ldfl+qvpUsj5suBbOoZaYA==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b28",
          "challengeId": "5bb3bdcdeea25fcf37d22b25",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b25",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Insane Problem #149",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.158Z",
            "updatedAt": "2018-10-02T18:49:49.158Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b26",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b27",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "Q6KyfwyGi5Fg12WjSDiDfvEIdiQseew5DeYbITyDECY=\n--1FnPhvtBK8/5dJVuqPMC9A==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b2c",
          "challengeId": "5bb3bdcdeea25fcf37d22b29",
          "position": 4,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b29",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Utility Enumerator #150",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.172Z",
            "updatedAt": "2018-10-02T18:49:49.172Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b2a",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b2b",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "TGNuGuZCLcqJaivhDY1O00R4f1R4+FA/fwjLJwufo3I=\n--5LtycjrHfeOl3OsYWsH0tg==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b30",
          "challengeId": "5bb3bdcdeea25fcf37d22b2d",
          "position": 5,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b2d",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Insane Handler #151",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.186Z",
            "updatedAt": "2018-10-02T18:49:49.186Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b2e",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b2f",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "WJyqUn0Niy2wtyweWPZRwSe9i+q+tX2GT0SZejreUtM=\n--z1ad3sYXUq2YZpRB8x+HXw==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b34",
          "challengeId": "5bb3bdcdeea25fcf37d22b31",
          "position": 6,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b31",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Insane Numbers #152",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.199Z",
            "updatedAt": "2018-10-02T18:49:49.199Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b32",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b33",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "TlsPl9W+Y/OEx0yhac0BYvJYMnne2Ntu7HoDTYs9jvw=\n--C4xaGn7U36j0riq/xWhb4Q==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Autem quisquam perspiciatis. Consequatur doloribus dolore in unde quia. Ipsa maiores voluptatem. Sint ratione molestiae labore dolore.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5bb3bdcdeea25fcf37d22b35",
      "title": "Mid-Level Front-End Engineer #91",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5bb3bdcdeea25fcf37d22b13",
      "inviteOnly": false,
      "softDeletedAt": null,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 12,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Sit quidem qui blanditiis harum similique. Nihil corrupti maxime sunt. Nam tempore rem delectus sunt nulla. Similique et qui inventore architecto et.",
      "challengeItems": [
        {
          "id": "5bb3bdcdeea25fcf37d22b39",
          "challengeId": "5bb3bdcdeea25fcf37d22b36",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b36",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Sane Encoding #153",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.220Z",
            "updatedAt": "2018-10-02T18:49:49.220Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b37",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b38",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "R5BpxqBc87QPUzgOZBDkeX0cghO6TeqRHrEHygdaauY=\n--bbfyf5QlMAwSS1GR3pHcWQ==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b3d",
          "challengeId": "5bb3bdcdeea25fcf37d22b3a",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b3a",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Crazy Sequence #154",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.241Z",
            "updatedAt": "2018-10-02T18:49:49.241Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b3b",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b3c",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "fb5hvLpwb+Y/59Xxc+PvFcLLLajTtQjVaoy7fKC/+NU=\n--lWZQBAjdzHvZN0HaEWrdvQ==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b41",
          "challengeId": "5bb3bdcdeea25fcf37d22b3e",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b3e",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Recursive Objects #155",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.256Z",
            "updatedAt": "2018-10-02T18:49:49.256Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b3f",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b40",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "NKigEZi26/AReZnOzmZhB4poz/4VCXNtW0e2aDieh1k=\n--1Ip8+7YfcdqBTroUBQ1wZw==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b45",
          "challengeId": "5bb3bdcdeea25fcf37d22b42",
          "position": 4,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b42",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Node Monad #156",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.269Z",
            "updatedAt": "2018-10-02T18:49:49.269Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b43",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b44",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "eHHBSbVSHHLHQVSRA9LdHlBD1jvHxtc4/qEf51xmvp8=\n--u8KGVYNRwCLKxcPtFyoe+g==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b49",
          "challengeId": "5bb3bdcdeea25fcf37d22b46",
          "position": 5,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b46",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Email Game #157",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.285Z",
            "updatedAt": "2018-10-02T18:49:49.285Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b47",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b48",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "CyCPq/QfXyYoslA4S4DBZqeovuEEXDWFGz+L0/P/TXI=\n--fhcDE4NzKMrMCU51GDx58A==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b4d",
          "challengeId": "5bb3bdcdeea25fcf37d22b4a",
          "position": 6,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b4a",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Sane Sorting #158",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.300Z",
            "updatedAt": "2018-10-02T18:49:49.300Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b4b",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b4c",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "rDO0a04tu9c2fp6o+x7Y5o3dL0l90zhTTVePRkEMFFE=\n--wkUMUcBiCY6YDP/EcYlOpA==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Ea et quasi culpa voluptatem. Quae commodi quia. In nemo nostrum.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5bb3bdcdeea25fcf37d22b4e",
      "title": "Mid-Level DevOps Engineer #92",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5bb3bdcdeea25fcf37d22b13",
      "inviteOnly": false,
      "softDeletedAt": null,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 12,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Ratione omnis ea consequatur quia quibusdam velit. Dolorem laborum quae. Ad autem velit totam voluptatibus id itaque. Eveniet et unde voluptatem nihil perspiciatis. Doloribus similique reprehenderit commodi inventore illum.",
      "challengeItems": [
        {
          "id": "5bb3bdcdeea25fcf37d22b52",
          "challengeId": "5bb3bdcdeea25fcf37d22b4f",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b4f",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Insane Substring #159",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.323Z",
            "updatedAt": "2018-10-02T18:49:49.323Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b50",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b51",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "Ra82zsEgNHN0+W39Cz+tcwyIurtbBw1Ta8L3KFaVRrY=\n--l+6iSGj6ROTxm09k8TujOA==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b56",
          "challengeId": "5bb3bdcdeea25fcf37d22b53",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b53",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Chain Game #160",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.343Z",
            "updatedAt": "2018-10-02T18:49:49.343Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b54",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b55",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "yqDa7BLYWkYBIrWSptKH8QtGxDioii4qPcGjQVkdw6o=\n--8Dx39gDrqYss2YbhsU0Bdw==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b5a",
          "challengeId": "5bb3bdcdeea25fcf37d22b57",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b57",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Password Puzzle #161",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.357Z",
            "updatedAt": "2018-10-02T18:49:49.357Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b58",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b59",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "37X9W1d2FVCxUHh5SJe0HRVxbwf8Y5mUu9uQIMFLmFY=\n--LKM2a/x3ogCNQEC6FLmJ0A==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b5e",
          "challengeId": "5bb3bdcdeea25fcf37d22b5b",
          "position": 4,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b5b",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Chain Calculator #162",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.371Z",
            "updatedAt": "2018-10-02T18:49:49.371Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b5c",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b5d",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "HLtf7ON4rQk3xkUypKy5yD7FYliLjhit4W8AalSZKTI=\n--y0Zxr9iHgvBubr1jeLZAsw==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b62",
          "challengeId": "5bb3bdcdeea25fcf37d22b5f",
          "position": 5,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b5f",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Inverted Puzzle #163",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.386Z",
            "updatedAt": "2018-10-02T18:49:49.386Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b60",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b61",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "YXloRIUuzEYr3xRH5xMM5kMS5rTblWebvLmsJdRJwLQ=\n--rD1hwXSZ/+tqohFN8Tt6lA==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b66",
          "challengeId": "5bb3bdcdeea25fcf37d22b63",
          "position": 6,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b63",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Hash Sequence #164",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.400Z",
            "updatedAt": "2018-10-02T18:49:49.400Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b64",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b65",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "CdIM/Osan7VYitSmIS+59M/SA/IoRQPRkz+7vqtYbiI=\n--9U3thT0snm5QU8tvqfHx8w==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Non qui nihil. Omnis eum maxime officia eum quis. Est ut omnis rem iusto. Commodi magni fuga.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5bb3bdcdeea25fcf37d22b67",
      "title": "Mid-Level Rails Developer #93",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5bb3bdcdeea25fcf37d22b13",
      "inviteOnly": false,
      "softDeletedAt": null,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 12,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Eos et aperiam. Officiis ipsum laboriosam ex aut alias. Quas qui et porro.",
      "challengeItems": [
        {
          "id": "5bb3bdcdeea25fcf37d22b6b",
          "challengeId": "5bb3bdcdeea25fcf37d22b68",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b68",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Utility Objects #165",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.426Z",
            "updatedAt": "2018-10-02T18:49:49.426Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b69",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b6a",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "k8Yj2XAQQ2pp2CMW4Wu29tnm9oPLqkl9Y7ceN+bm1us=\n--BCbACDKLlGO3Vz2ui+M5Ag==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b6f",
          "challengeId": "5bb3bdcdeea25fcf37d22b6c",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b6c",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Hash Strings #166",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.449Z",
            "updatedAt": "2018-10-02T18:49:49.449Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b6d",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b6e",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "v7jl99IyMBnzSjY73mpnkZVjQgLkMqsqKmliug4yNpQ=\n--F30M8sfP4Dc9ySXyXEhobQ==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b73",
          "challengeId": "5bb3bdcdeea25fcf37d22b70",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b70",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Repeated System #167",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.466Z",
            "updatedAt": "2018-10-02T18:49:49.466Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b71",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b72",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "m9g07OdArw3NKBhG+qlVB8aT2zoA4cfjTeHrng2Go4c=\n--eACj+um0dz0Rpyv3CrDIjg==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b77",
          "challengeId": "5bb3bdcdeea25fcf37d22b74",
          "position": 4,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b74",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Heavy Search #168",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.484Z",
            "updatedAt": "2018-10-02T18:49:49.484Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b75",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b76",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "/V+oSRhn9CSfuk6hloB2d67PzZefqgnca9yOFZfZXgE=\n--+hKlLShHxD6gklHfUS4gMA==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b7b",
          "challengeId": "5bb3bdcdeea25fcf37d22b78",
          "position": 5,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b78",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Small Methods #169",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.527Z",
            "updatedAt": "2018-10-02T18:49:49.527Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b79",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b7a",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "+rXiinIEt6VWjjM921u/NptUyR9jFtvTIsXQvdNjWsk=\n--2FUF9BFXr/v1gAmY5qGnrw==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b7f",
          "challengeId": "5bb3bdcdeea25fcf37d22b7c",
          "position": 6,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b7c",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Insane Items #170",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.543Z",
            "updatedAt": "2018-10-02T18:49:49.543Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b7d",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b7e",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "pMeaISxTAUZWehVpF8y2f1TXtkeNRfvWHtbvOaE8c9M=\n--+BKF6qAFzNjb5iu9dvFl9Q==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Dolorem quia optio ut et inventore. Maxime vero cupiditate commodi qui aliquid pariatur. Quia aspernatur blanditiis consequatur. Voluptate illum quidem.",
      "demoLandingOrder": 1000
    },
    {
      "id": "5bb3bdcdeea25fcf37d22b80",
      "title": "Junior DevOps Developer #94",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5bb3bdcdeea25fcf37d22b13",
      "inviteOnly": false,
      "softDeletedAt": null,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 12,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "isTemplate": true,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Facilis harum illo et. Voluptas aliquam neque. Dolorem omnis beatae occaecati porro. Repellat quo consequatur vitae cum officiis iste dolorum.",
      "challengeItems": [
        {
          "id": "5bb3bdcdeea25fcf37d22b84",
          "challengeId": "5bb3bdcdeea25fcf37d22b81",
          "position": 1,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b81",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Binding Substring #171",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.567Z",
            "updatedAt": "2018-10-02T18:49:49.567Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b82",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b83",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "Q4/xg6A2PEq4JqZ6rVa/fl/XjFdReudXeNAdJnkHZ4M=\n--hQFkcetuPIBxzZi0Im8RLA==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b88",
          "challengeId": "5bb3bdcdeea25fcf37d22b85",
          "position": 2,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b85",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Functional Items #172",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Logic"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.587Z",
            "updatedAt": "2018-10-02T18:49:49.587Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b86",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b87",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "wDJgj/7LDN/P9ClkmXS0UQyioYKfMObrhJIGxPD7BSk=\n--+xr857t+Re4E0t7ZETffSw==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b8c",
          "challengeId": "5bb3bdcdeea25fcf37d22b89",
          "position": 3,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b89",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Date Strings #173",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.601Z",
            "updatedAt": "2018-10-02T18:49:49.601Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b8a",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b8b",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "tb84x8/TFkWngmRYXXPNoYq4wODcEJsn04SYW+QMeMY=\n--gXUfg49WH8tTXX4jg4xRBg==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b90",
          "challengeId": "5bb3bdcdeea25fcf37d22b8d",
          "position": 4,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b8d",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Inverted Array #174",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Fundamentals"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.616Z",
            "updatedAt": "2018-10-02T18:49:49.616Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b8e",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b8f",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "A0NcxKA9EZiBRxS5dW5+moH86L3+BvogmuA+Ugix7WY=\n--n6PD9ehObGopp8h378BEGA==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b94",
          "challengeId": "5bb3bdcdeea25fcf37d22b91",
          "position": 5,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b91",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Value Numbers #175",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Algorithms"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.631Z",
            "updatedAt": "2018-10-02T18:49:49.631Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b92",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b93",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "oY68SGyxKYPTCEN0oXScpvMqI8TbRjgxrW/GknexNag=\n--rMn1oZWycolKR+k+zdgE2g==--u"
              }
            ]
          }
        },
        {
          "id": "5bb3bdcdeea25fcf37d22b98",
          "challengeId": "5bb3bdcdeea25fcf37d22b95",
          "position": 6,
          "disabledLanguages": [],
          "challenge": {
            "id": "5bb3bdcdeea25fcf37d22b95",
            "$type": "CodeChallenge",
            "teamId": "5bb3bdcdeea25fcf37d22b13",
            "createdById": "5bb3bdcdeea25fcf37d22b1b",
            "copiedFromId": null,
            "title": "Balanced Methods #176",
            "instructions": "Complete the solution",
            "difficulty": 1,
            "summary": null,
            "purpose": null,
            "topics": [
              "Meta-programming"
            ],
            "labels": null,
            "estimatedTime": 2,
            "state": "draft",
            "publishedAt": null,
            "createdAt": "2018-10-02T18:49:49.644Z",
            "updatedAt": "2018-10-02T18:49:49.644Z",
            "libraryAccess": "limited",
            "copiedFromLibrary": null,
            "copiedFromContentType": null,
            "contentType": "normal",
            "productTypes": {
              "_id": "5bb3bdcdeea25fcf37d22b96",
              "education": true,
              "recruitment": true
            },
            "collection": "commons",
            "protected": true,
            "requiresUpgrade": false,
            "majorVersion": 1,
            "minorVersion": 0,
            "patchVersion": 0,
            "linkedStatus": false,
            "defaultLanguage": null,
            "enforceAllTestsOnPublish": true,
            "sampleTestCasesEnabled": true,
            "enabledServices": [],
            "successMode": "specs",
            "similarityMode": "full",
            "similarityWeight": 1.0,
            "languages": [
              {
                "id": "5bb3bdcdeea25fcf37d22b97",
                "name": "javascript",
                "exampleWallTime": null,
                "testFramework": "cw-2",
                "languageVersion": "8.x",
                "languageVersionName": "Node 8.1.3",
                "challengeReferenceIds": [],
                "generated": null,
                "availableTestFrameworks": [
                  "cw-2",
                  "mocha_bdd",
                  "mocha_tdd",
                  "karma_bdd",
                  "karma_tdd"
                ],
                "totalTestCases": 1,
                "weightedTestCases": 1,
                "tagTestCases": null,
                "hiddenTestCases": 0,
                "exampleTestCases": "Test.expect(a == 1)",
                "setup": "var a = ",
                "testCases": "2xj2u7QO21gsomAsg0DAM3LS7QdIMfteyjjgqPknMWk=\n--ioA2M8Y86tZwH2XjhDPfXA==--u"
              }
            ]
          }
        }
      ],
      "activeAssessmentResultsCount": 0,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Itaque optio voluptate. Animi eius voluptatem amet optio dolorum. Qui sunt provident modi nesciunt. Voluptas quam ab accusamus fugit perspiciatis quae. Incidunt occaecati reprehenderit labore nostrum accusamus nihil repellendus.",
      "demoLandingOrder": 1000
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 5,
  "meta": {
    "timestamp": "2018-10-02T11:49:50.166-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/5bb3bdcfeea25fcf37d22c65/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGNmZWVhMjVmY2YzN2QyMmNlZCIsImlkIjoiNWJiM2JkY2ZlZWEyNWZjZjM3ZDIyY2VlIiwic2VjcmV0IjoiTHhyMUFRPT0ifQ.5BGLBxarovinE-GQ2l6iK-LWpAsHxqv7h4NwVmo1IRk
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": "5bb3bdcfeea25fcf37d22d02",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdcfeea25fcf37d22d02",
    "title": "Assessment Title",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5bb3bdcfeea25fcf37d22ce7",
    "inviteOnly": true,
    "softDeletedAt": null,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": "5bb3bdcfeea25fcf37d22c65",
    "showSolutionsToCandidates": true,
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Quia ut est corporis. Aliquam voluptatem ipsum ratione nostrum. Itaque sed dolor amet odit perspiciatis vero. Ea sed asperiores iste repellendus ipsam quia. Ab deserunt at beatae ipsam.",
    "challengeItems": [
      {
        "id": "5bb3bdd0eea25fcf37d22d15",
        "challengeId": "5bb3bdcfeea25fcf37d22d04",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd0eea25fcf37d22d16",
        "challengeId": "5bb3bdd0eea25fcf37d22d07",
        "position": 2,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd0eea25fcf37d22d17",
        "challengeId": "5bb3bdd0eea25fcf37d22d0a",
        "position": 3,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd0eea25fcf37d22d18",
        "challengeId": "5bb3bdd0eea25fcf37d22d0d",
        "position": 4,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd0eea25fcf37d22d19",
        "challengeId": "5bb3bdd0eea25fcf37d22d10",
        "position": 5,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd0eea25fcf37d22d1a",
        "challengeId": "5bb3bdd0eea25fcf37d22d13",
        "position": 6,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Et maiores molestias reprehenderit sequi architecto. Amet mollitia ex hic sit in pariatur. Id numquam sint veritatis tenetur soluta nisi eum. Nobis reiciendis voluptas vitae nemo natus. Accusantium nobis alias voluptatem aspernatur sed aut quasi.",
    "demoLandingOrder": 1000,
    "publishedAt": "2018-10-02T18:49:52.114Z",
    "archivedAt": null,
    "createdAt": "2018-10-02T18:49:52.112Z",
    "assessmentResultsSummary": {
      "_id": "5bb3bdd0eea25fcf37d22d1b"
    },
    "labels": null,
    "notificationScheme": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": []
  },
  "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:52.138-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZGQwZWVhMjVmY2YzN2QyMmQ4ZSIsImlkIjoiNWJiM2JkZDBlZWEyNWZjZjM3ZDIyZDhmIiwic2VjcmV0IjoiRTY5TmVRPT0ifQ.0cpu9n8JVKiJunK9GLEK3Wi4gJvAlmmvW36N4mNT69Q

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Assessment",
  "data": [
    {
      "id": "5bb3bdd0eea25fcf37d22d75",
      "title": "Senior Full-Stack Engineer #110",
      "state": "published",
      "defaultLanguage": null,
      "defaultInviteMessage": null,
      "teamId": "5bb3bdd0eea25fcf37d22d6f",
      "inviteOnly": false,
      "softDeletedAt": null,
      "enforcedTimeLimit": null,
      "manualEstimatedTime": null,
      "suggestedEstimatedTime": 4,
      "copiedFromId": null,
      "showSolutionsToCandidates": true,
      "isTemplate": false,
      "isPractice": false,
      "isDemo": false,
      "galleryImage": null,
      "summary": "Quis similique alias nostrum in asperiores illo. Nisi nemo est. Nobis non illum. Sunt ut voluptatem. Laudantium est natus quis aut consectetur.",
      "challengeItems": [
        {
          "id": "5bb3bdd0eea25fcf37d22d7c",
          "challengeId": "5bb3bdd0eea25fcf37d22d79",
          "position": 1,
          "disabledLanguages": []
        },
        {
          "id": "5bb3bdd0eea25fcf37d22d80",
          "challengeId": "5bb3bdd0eea25fcf37d22d7d",
          "position": 2,
          "disabledLanguages": []
        }
      ],
      "activeAssessmentResultsCount": 2,
      "liveAssessmentResultsCount": 0,
      "activeInvitationsCount": 0,
      "purpose": "Et cumque veritatis illum dolores. Mollitia aut reprehenderit sed. Odit atque ut fugiat voluptas perferendis. Velit libero porro ratione nihil. Accusantium suscipit tempora aut soluta necessitatibus illo veritatis.",
      "demoLandingOrder": 1000,
      "publishedAt": "2018-10-02T18:49:52.721Z",
      "archivedAt": null,
      "createdAt": "2018-10-02T18:49:52.737Z",
      "assessmentResultsSummary": {
        "_id": "5bb3bdd0eea25fcf37d22d85",
        "all": 2,
        "started": 2
      },
      "labels": null,
      "notificationScheme": null,
      "assignmentTeamMemberIds": [],
      "redirectUrl": null,
      "webhookUrl": null,
      "submissionMessage": null,
      "assignmentLabels": null,
      "assignmentRole": null,
      "workflowPaths": []
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2018-10-02T11:49:52.904-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/5bb3bdd0eea25fcf37d22d99

Headers

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdd0eea25fcf37d22d99",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdd0eea25fcf37d22d99",
    "title": "Junior Back-End Engineer #111",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5bb3bdd0eea25fcf37d22d93",
    "inviteOnly": false,
    "softDeletedAt": null,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 4,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Ex doloremque voluptatem culpa quod explicabo. Quasi odit nam delectus. Aspernatur eius temporibus deserunt sed nobis molestiae.",
    "challengeItems": [
      {
        "id": "5bb3bdd0eea25fcf37d22da0",
        "challengeId": "5bb3bdd0eea25fcf37d22d9d",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd1eea25fcf37d22da4",
        "challengeId": "5bb3bdd0eea25fcf37d22da1",
        "position": 2,
        "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:53.129-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZGQxZWVhMjVmY2YzN2QyMmRlMCIsImlkIjoiNWJiM2JkZDFlZWEyNWZjZjM3ZDIyZGUxIiwic2VjcmV0IjoiaVVaeURBPT0ifQ.H6fJE0YG_BZ0F9Vhg0guQTHHTXibX4osmV5KCohlnOc
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": "5bb3bdd1eea25fcf37d22df8",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdd1eea25fcf37d22df8",
    "title": "Angular Developer",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5bb3bdd1eea25fcf37d22dd9",
    "inviteOnly": true,
    "softDeletedAt": null,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "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": "2018-10-02T18:49:53.635Z",
    "assessmentResultsSummary": {
      "_id": "5bb3bdd1eea25fcf37d22df9"
    },
    "labels": null,
    "notificationScheme": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": []
  },
  "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:53.651-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

Request

Route

PUT /v1/assessments/5bb3bdd1eea25fcf37d22e02

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGQxZWVhMjVmY2YzN2QyMmUwMyIsImlkIjoiNWJiM2JkZDFlZWEyNWZjZjM3ZDIyZTA0Iiwic2VjcmV0IjoiQmVrWTFnPT0ifQ.nJqligFJIWHddprwhpyaTvOyNWQc7eWBd4UsARdzAZY
Content-Type: application/x-www-form-urlencoded

Body

data[summary]=Junior+to+mid-level

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdd1eea25fcf37d22e02",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdd1eea25fcf37d22e02",
    "title": "Mid-Level Angular Engineer #114",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5bb3bdd1eea25fcf37d22dfc",
    "inviteOnly": false,
    "softDeletedAt": null,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 4,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Junior to mid-level",
    "challengeItems": [
      {
        "id": "5bb3bdd1eea25fcf37d22e09",
        "challengeId": "5bb3bdd1eea25fcf37d22e06",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd1eea25fcf37d22e0d",
        "challengeId": "5bb3bdd1eea25fcf37d22e0a",
        "position": 2,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Neque in provident earum. Voluptatem sint corporis dicta officiis saepe aut. Numquam sit expedita. Dolorum rem ut sed quo quasi. Possimus officia et ut.",
    "demoLandingOrder": 1000,
    "publishedAt": "2018-10-02T18:49:53.716Z",
    "archivedAt": null,
    "createdAt": "2018-10-02T18:49:53.732Z",
    "assessmentResultsSummary": {
      "_id": "5bb3bdd1eea25fcf37d22e12",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": []
  },
  "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:53.910-07:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/assessments/:id/publish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5bb3bdd1eea25fcf37d22e23/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGQxZWVhMjVmY2YzN2QyMmUyNCIsImlkIjoiNWJiM2JkZDFlZWEyNWZjZjM3ZDIyZTI1Iiwic2VjcmV0IjoiVDVZN01BPT0ifQ.Od-kOQag_ptt-USCj7vK30lnw4oMym3KkIAjj4C02Tw
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdd1eea25fcf37d22e23",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdd1eea25fcf37d22e23",
    "title": "Junior Ruby Engineer #115",
    "state": "published",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5bb3bdd1eea25fcf37d22e1d",
    "inviteOnly": false,
    "softDeletedAt": null,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Sint velit corrupti. A sunt quisquam et magni consectetur. Cupiditate corrupti molestiae maxime asperiores sapiente rerum.",
    "challengeItems": [],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Quibusdam aut sequi quia ratione. Placeat distinctio quibusdam dolorem nesciunt qui. Sit numquam facilis neque consequatur et mollitia ut. Nihil dolorem qui est ipsa asperiores. Quibusdam voluptatem doloremque.",
    "demoLandingOrder": 1000,
    "publishedAt": "2018-10-02T18:49:53.990Z",
    "archivedAt": null,
    "createdAt": "2018-10-02T18:49:53.978Z",
    "assessmentResultsSummary": {
      "_id": "5bb3bdd2eea25fcf37d22e27"
    },
    "labels": null,
    "notificationScheme": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": []
  },
  "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:54.009-07:00",
    "includes": []
  }
}

Un-publish

Endpoint

PUT /v1/assessments/:id/unpublish

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5bb3bdd2eea25fcf37d22e3f/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGQyZWVhMjVmY2YzN2QyMmU0MCIsImlkIjoiNWJiM2JkZDJlZWEyNWZjZjM3ZDIyZTQxIiwic2VjcmV0IjoiZ2dPR2x3PT0ifQ.mvjYHMOePXZnd9LWmbZATvAD0X8tECEf1PQD5nMpqEg
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdd2eea25fcf37d22e3f",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdd2eea25fcf37d22e3f",
    "title": "Mid-Level Big-Data Developer #117",
    "state": "draft",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5bb3bdd2eea25fcf37d22e39",
    "inviteOnly": false,
    "softDeletedAt": null,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 4,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Corporis praesentium explicabo fuga perferendis laudantium et quod. Consequatur enim earum ea suscipit. Dolores quam repellat autem unde distinctio. Corrupti beatae asperiores dolores ut ad nesciunt blanditiis. Dolore iste sed qui magnam error.",
    "challengeItems": [
      {
        "id": "5bb3bdd2eea25fcf37d22e46",
        "challengeId": "5bb3bdd2eea25fcf37d22e43",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd2eea25fcf37d22e4a",
        "challengeId": "5bb3bdd2eea25fcf37d22e47",
        "position": 2,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Nobis ea delectus odit. Sint ipsum rem. Officia fugiat magni dolore sed ut autem. Est ut nihil soluta architecto. Nam non ut quas unde error.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": null,
    "createdAt": "2018-10-02T18:49:54.191Z",
    "assessmentResultsSummary": {
      "_id": "5bb3bdd2eea25fcf37d22e4f",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": []
  },
  "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:54.344-07:00",
    "includes": []
  }
}

Archive

Archives the assessment

Endpoint

PUT /v1/assessments/:id/archive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5bb3bdd2eea25fcf37d22e60/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGQyZWVhMjVmY2YzN2QyMmU2MSIsImlkIjoiNWJiM2JkZDJlZWEyNWZjZjM3ZDIyZTYyIiwic2VjcmV0IjoiRGF2YUV3PT0ifQ.IXHQc8MO1A0jffXWtd-tF8HezA_7bLdvTrQgcSWHP60
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdd2eea25fcf37d22e60",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdd2eea25fcf37d22e60",
    "title": "Senior Database Developer #118",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5bb3bdd2eea25fcf37d22e5a",
    "inviteOnly": false,
    "softDeletedAt": null,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 4,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Quia atque dolore laborum eaque natus molestiae. Dolorem soluta aut nam dicta. Magni quod natus. Doloremque asperiores et veritatis magni. Sunt pariatur et tenetur.",
    "challengeItems": [
      {
        "id": "5bb3bdd2eea25fcf37d22e67",
        "challengeId": "5bb3bdd2eea25fcf37d22e64",
        "position": 1,
        "disabledLanguages": []
      },
      {
        "id": "5bb3bdd2eea25fcf37d22e6b",
        "challengeId": "5bb3bdd2eea25fcf37d22e68",
        "position": 2,
        "disabledLanguages": []
      }
    ],
    "activeAssessmentResultsCount": 2,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Consequatur quia ipsam enim qui beatae rerum accusamus. Unde voluptas laboriosam aut voluptatem quia eos. Dolor sint praesentium optio quis. Doloremque nihil omnis porro dolor. Et laborum dolores.",
    "demoLandingOrder": 1000,
    "publishedAt": "2018-10-02T18:49:54.411Z",
    "archivedAt": "2018-10-02T18:49:54.551Z",
    "createdAt": "2018-10-02T18:49:54.427Z",
    "assessmentResultsSummary": {
      "_id": "5bb3bdd2eea25fcf37d22e70",
      "all": 2,
      "started": 2
    },
    "labels": null,
    "notificationScheme": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": []
  },
  "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:54.571-07:00",
    "includes": []
  }
}

Unarchive

Unarchives the assessment

Endpoint

PUT /v1/assessments/:id/unarchive

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5bb3bdd2eea25fcf37d22ea2/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGQyZWVhMjVmY2YzN2QyMmU4MiIsImlkIjoiNWJiM2JkZDJlZWEyNWZjZjM3ZDIyZTgzIiwic2VjcmV0IjoibDNvc1BBPT0ifQ.zDPItwNLsxk9q9iD9ICL7Sq_SAH9vlFWVshqZQMIaVI
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdd2eea25fcf37d22ea2",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdd2eea25fcf37d22ea2",
    "title": "Senior Django Engineer #120",
    "state": "draft",
    "teamId": "5bb3bdd2eea25fcf37d22e9c",
    "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:54.836-07:00",
    "includes": []
  }
}

Recover

Recovers the assessment

Endpoint

PUT /v1/assessments/:id/recover

Parameters

Name Description
id base16 ObjectId

Request

Route

PUT /v1/assessments/5bb3bdd3eea25fcf37d22ee8/recover

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZGQzZWVhMjVmY2YzN2QyMmVkMCIsImlkIjoiNWJiM2JkZDNlZWEyNWZjZjM3ZDIyZWQxIiwic2VjcmV0IjoiQm5zVVd3PT0ifQ.y-_38RlFNrJ75Q8XOKpNOOoZemdDGaQJfhqPOn1FB18
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3bdd3eea25fcf37d22ee8",
  "type": "Assessment",
  "data": {
    "id": "5bb3bdd3eea25fcf37d22ee8",
    "title": "Junior Database Developer #123",
    "state": "archived",
    "defaultLanguage": null,
    "defaultInviteMessage": null,
    "teamId": "5bb3bdd3eea25fcf37d22ec9",
    "inviteOnly": false,
    "softDeletedAt": null,
    "enforcedTimeLimit": null,
    "manualEstimatedTime": null,
    "suggestedEstimatedTime": 0,
    "copiedFromId": null,
    "showSolutionsToCandidates": true,
    "isTemplate": false,
    "isPractice": false,
    "isDemo": false,
    "galleryImage": null,
    "summary": "Reiciendis alias quia est. Quia enim pariatur in sint necessitatibus. Cum ut blanditiis explicabo. Omnis aut soluta autem laborum. Est ut vero labore nihil consequuntur sunt.",
    "challengeItems": [],
    "activeAssessmentResultsCount": 0,
    "liveAssessmentResultsCount": 0,
    "activeInvitationsCount": 0,
    "purpose": "Perspiciatis aut quia velit consequatur delectus similique occaecati. Est reiciendis atque. Cum cumque ut eaque et repellendus.",
    "demoLandingOrder": 1000,
    "publishedAt": null,
    "archivedAt": "2018-10-02T18:49:55.302Z",
    "createdAt": "2018-10-02T18:49:55.307Z",
    "assessmentResultsSummary": {
      "_id": "5bb3bdd3eea25fcf37d22ee9"
    },
    "labels": null,
    "notificationScheme": null,
    "assignmentTeamMemberIds": [],
    "redirectUrl": null,
    "webhookUrl": null,
    "submissionMessage": null,
    "assignmentLabels": null,
    "assignmentRole": null,
    "workflowPaths": []
  },
  "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_restricted",
          "text": "All Team Reviewers"
        },
        {
          "value": "all_premium",
          "text": "All Team Managers"
        },
        {
          "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"
        }
      ],
      "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": "2018-10-02T11:49:55.337-07:00",
    "includes": []
  }
}

Challenges

List

Returns all global and team challenges

Endpoint

GET /v1/challenges

Parameters

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

Request

Route

GET /v1/challenges

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTI5ZWVhMjVmY2YzN2QyMzBlNCIsImlkIjoiNWJiM2JlMjllZWEyNWZjZjM3ZDIzMGU1Iiwic2VjcmV0IjoiazVHaWVBPT0ifQ.4OPdUXS8wkAVyCwiALotk61-YhFKUagfdfGFQdH2vc4

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "CodeChallenge",
  "data": [
    {
      "id": "5bb3be29eea25fcf37d230e3",
      "$type": "CodeChallenge",
      "teamId": "5bb3be29eea25fcf37d230dd",
      "createdById": "5bb3be29eea25fcf37d230e5",
      "copiedFromId": null,
      "title": "Chain Helper #259",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Fundamentals"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2018-10-02T18:51:21.594Z",
      "createdAt": "2018-10-02T18:51:21.600Z",
      "updatedAt": "2018-10-02T18:51:21.600Z",
      "libraryAccess": null,
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5bb3be29eea25fcf37d230e7",
        "education": true,
        "recruitment": true
      },
      "collection": "team",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "yamlConfig": null,
      "languages": [
        {
          "id": "5bb3be29eea25fcf37d230e8",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "8.x",
          "languageVersionName": "Node 8.1.3",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd"
          ],
          "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": "5bb3be29eea25fcf37d230e9",
      "$type": "CodeChallenge",
      "teamId": "5bb3bdcfeea25fcf37d22c5f",
      "createdById": "5bb3be29eea25fcf37d230eb",
      "copiedFromId": null,
      "title": "Repeated Enumerator #260",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Logic"
      ],
      "labels": null,
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2018-10-02T18:51:21.617Z",
      "createdAt": "2018-10-02T18:51:21.622Z",
      "updatedAt": "2018-10-02T18:51:21.622Z",
      "libraryAccess": "limited",
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "normal",
      "productTypes": {
        "_id": "5bb3be29eea25fcf37d230ec",
        "education": true,
        "recruitment": true
      },
      "collection": "commons",
      "protected": true,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "languages": [
        {
          "id": "5bb3be29eea25fcf37d230ed",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "8.x",
          "languageVersionName": "Node 8.1.3",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd"
          ],
          "totalTestCases": 1,
          "weightedTestCases": 1,
          "tagTestCases": null,
          "hiddenTestCases": 0,
          "exampleTestCases": "Test.expect(a == 1)",
          "setup": "var a = ",
          "testCases": "XhYxgv1gJuYvBsqE0QzExTiJKmGQfdQyqGe/ZJde6g8=\n--u4fynBnGRUWL3i73xgceGg==--u"
        }
      ]
    },
    {
      "id": "5bb3be29eea25fcf37d230f3",
      "$type": "CodeChallenge",
      "teamId": "5bb3bdcfeea25fcf37d22c5f",
      "createdById": "5bb3be29eea25fcf37d230f5",
      "copiedFromId": null,
      "title": "Repeated Substring #262",
      "instructions": "Complete the solution",
      "difficulty": 1,
      "summary": null,
      "purpose": null,
      "topics": [
        "Algorithms"
      ],
      "labels": [
        "Templates"
      ],
      "estimatedTime": 2,
      "state": "published",
      "publishedAt": "2018-10-02T18:51:21.658Z",
      "createdAt": "2018-10-02T18:51:21.662Z",
      "updatedAt": "2018-10-02T18:51:21.662Z",
      "libraryAccess": "limited",
      "copiedFromLibrary": null,
      "copiedFromContentType": null,
      "contentType": "template",
      "productTypes": {
        "_id": "5bb3be29eea25fcf37d230f6",
        "education": true,
        "recruitment": true
      },
      "collection": "commons",
      "protected": false,
      "requiresUpgrade": false,
      "majorVersion": 1,
      "minorVersion": 0,
      "patchVersion": 0,
      "linkedStatus": false,
      "defaultLanguage": null,
      "enforceAllTestsOnPublish": true,
      "sampleTestCasesEnabled": true,
      "enabledServices": [],
      "successMode": "specs",
      "similarityMode": "full",
      "similarityWeight": 1.0,
      "languages": [
        {
          "id": "5bb3be29eea25fcf37d230f7",
          "name": "javascript",
          "exampleWallTime": null,
          "testFramework": "cw-2",
          "languageVersion": "8.x",
          "languageVersionName": "Node 8.1.3",
          "challengeReferenceIds": [],
          "generated": null,
          "availableTestFrameworks": [
            "cw-2",
            "mocha_bdd",
            "mocha_tdd",
            "karma_bdd",
            "karma_tdd"
          ],
          "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": "2018-10-02T11:51:21.751-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/challenges/:id

Parameters

Name Description
id base16 ObjectId

Request

Route

GET /v1/challenges/5bb3be2aeea25fcf37d23170

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJhZWVhMjVmY2YzN2QyMzE3MSIsImlkIjoiNWJiM2JlMmFlZWEyNWZjZjM3ZDIzMTcyIiwic2VjcmV0IjoiMkRyMC9RPT0ifQ.UMIFkznRQ0zR8lPmIr8LISQRprIDIJlOiZbByEEie-o

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2aeea25fcf37d23170",
  "type": "CodeChallenge",
  "data": {
    "id": "5bb3be2aeea25fcf37d23170",
    "$type": "CodeChallenge",
    "teamId": "5bb3be2aeea25fcf37d2316a",
    "createdById": "5bb3be2aeea25fcf37d23172",
    "copiedFromId": null,
    "title": "Fibonacci Parser #280",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2018-10-02T18:51:22.364Z",
    "createdAt": "2018-10-02T18:51:22.370Z",
    "updatedAt": "2018-10-02T18:51:22.370Z",
    "libraryAccess": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2aeea25fcf37d23174",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5bb3be2aeea25fcf37d23175",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "8.x",
        "languageVersionName": "Node 8.1.3",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd"
        ],
        "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"
          }
        ]
      }
    },
    "timestamp": "2018-10-02T11:51:22.402-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJhZWVhMjVmY2YzN2QyMzE3ZiIsImlkIjoiNWJiM2JlMmFlZWEyNWZjZjM3ZDIzMTgwIiwic2VjcmV0IjoiallVLzlBPT0ifQ.NBO_675jHbpLgO7yQTXlsCugNe4eaaXbZ6-gxhZzlWI

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": "5bb3be2aeea25fcf37d23184",
  "type": "CodeChallenge",
  "data": {
    "id": "5bb3be2aeea25fcf37d23184",
    "$type": "CodeChallenge",
    "teamId": "5bb3be2aeea25fcf37d23178",
    "createdById": "5bb3be2aeea25fcf37d23180",
    "copiedFromId": null,
    "title": "test challenge",
    "instructions": "Do some work",
    "difficulty": null,
    "summary": null,
    "purpose": "abc",
    "topics": null,
    "labels": null,
    "estimatedTime": null,
    "state": "published",
    "publishedAt": "2018-10-02T18:51:22.539Z",
    "createdAt": "2018-10-02T18:51:22.544Z",
    "updatedAt": "2018-10-02T18:51:22.544Z",
    "libraryAccess": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2aeea25fcf37d2317b",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": false,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5bb3be2aeea25fcf37d23186",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "8.x",
        "languageVersionName": "Node 8.1.3",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd"
        ],
        "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"
          }
        ]
      }
    },
    "timestamp": "2018-10-02T11:51:22.558-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJhZWVhMjVmY2YzN2QyMzE5MCIsImlkIjoiNWJiM2JlMmFlZWEyNWZjZjM3ZDIzMTkxIiwic2VjcmV0IjoiSUFUUDFRPT0ifQ.YWt1JiVjpihMXYQrEu9t8ktlNcLwXHAH4BEw3_WXZiA

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": "5bb3be2aeea25fcf37d23196",
  "type": "QuizChallenge",
  "data": {
    "id": "5bb3be2aeea25fcf37d23196",
    "$type": "QuizChallenge",
    "teamId": "5bb3be2aeea25fcf37d23189",
    "createdById": "5bb3be2aeea25fcf37d23191",
    "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": "2018-10-02T18:51:22.653Z",
    "updatedAt": "2018-10-02T18:51:22.653Z",
    "libraryAccess": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2aeea25fcf37d2318c",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": null,
    "minorVersion": null,
    "patchVersion": null,
    "linkedStatus": false,
    "questions": []
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:22.662-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/5bb3be2aeea25fcf37d231a0

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJhZWVhMjVmY2YzN2QyMzFhMSIsImlkIjoiNWJiM2JlMmFlZWEyNWZjZjM3ZDIzMWEyIiwic2VjcmV0IjoiWVNJYUZRPT0ifQ.2Y2SbZoB1oXzUBnBjWsFHREqTkFnIlWayNtrOoLrjPE

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2aeea25fcf37d231a0",
  "type": "CodeChallenge",
  "data": {
    "id": "5bb3be2aeea25fcf37d231a0",
    "$type": "CodeChallenge",
    "teamId": "5bb3be2aeea25fcf37d2319a",
    "createdById": "5bb3be2aeea25fcf37d231a2",
    "copiedFromId": null,
    "title": "Chain Items #283",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2018-10-02T18:51:22.729Z",
    "updatedAt": "2018-10-02T18:51:22.729Z",
    "libraryAccess": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2aeea25fcf37d231a4",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5bb3be2aeea25fcf37d231a6",
        "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"
          }
        ]
      }
    },
    "timestamp": "2018-10-02T11:51:22.770-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/challenges/:id

Request

Route

DELETE /v1/challenges/5bb3be2aeea25fcf37d231af

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJhZWVhMjVmY2YzN2QyMzFiMCIsImlkIjoiNWJiM2JlMmFlZWEyNWZjZjM3ZDIzMWIxIiwic2VjcmV0IjoianptZjNRPT0ifQ.2SaLX0NnsXCDdzQd-w-_xtqMTcJ2nJxE9Hp0tSRj5kg
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

Un-Publish

Endpoint

PUT /v1/challenges/:id/unpublish

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5bb3be2aeea25fcf37d231bd/unpublish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJhZWVhMjVmY2YzN2QyMzFiZSIsImlkIjoiNWJiM2JlMmFlZWEyNWZjZjM3ZDIzMWJmIiwic2VjcmV0IjoiWTBBeDN3PT0ifQ.gYWJJw6A_g22K0zBpUzsi9VRVWL8Xa0adg4PW5N4ZZc
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2aeea25fcf37d231bd",
  "type": "CodeChallenge",
  "data": {
    "id": "5bb3be2aeea25fcf37d231bd",
    "$type": "CodeChallenge",
    "teamId": "5bb3be2aeea25fcf37d231b7",
    "createdById": "5bb3be2aeea25fcf37d231bf",
    "copiedFromId": null,
    "title": "Actor Class #285",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Algorithms"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "draft",
    "publishedAt": null,
    "createdAt": "2018-10-02T18:51:22.922Z",
    "updatedAt": "2018-10-02T18:51:22.940Z",
    "libraryAccess": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2aeea25fcf37d231c1",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5bb3be2aeea25fcf37d231c2",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "8.x",
        "languageVersionName": "Node 8.1.3",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd"
        ],
        "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"
          }
        ]
      }
    },
    "timestamp": "2018-10-02T11:51:22.954-07:00",
    "includes": []
  }
}

Publish

Endpoint

PUT /v1/challenges/:id/publish

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5bb3be2aeea25fcf37d231cb/publish

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJhZWVhMjVmY2YzN2QyMzFjYyIsImlkIjoiNWJiM2JlMmJlZWEyNWZjZjM3ZDIzMWNkIiwic2VjcmV0IjoiYmtiMzVRPT0ifQ.SySOksZZWTFmQmHx3TbT-F0fqTH2A-DO1bFSmsA5dkA
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2aeea25fcf37d231cb",
  "type": "CodeChallenge",
  "data": {
    "id": "5bb3be2aeea25fcf37d231cb",
    "$type": "CodeChallenge",
    "teamId": "5bb3be2aeea25fcf37d231c5",
    "createdById": "5bb3be2beea25fcf37d231cd",
    "copiedFromId": null,
    "title": "Repeated Helper #286",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2018-10-02T18:51:23.027Z",
    "createdAt": "2018-10-02T18:51:23.014Z",
    "updatedAt": "2018-10-02T18:51:23.031Z",
    "libraryAccess": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2beea25fcf37d231cf",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5bb3be2beea25fcf37d231d0",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "8.x",
        "languageVersionName": "Node 8.1.3",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd"
        ],
        "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"
          }
        ]
      }
    },
    "timestamp": "2018-10-02T11:51:23.045-07:00",
    "includes": []
  }
}

Archive

Endpoint

PUT /v1/challenges/:id/archive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5bb3be2beea25fcf37d231d9/archive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJiZWVhMjVmY2YzN2QyMzFkYSIsImlkIjoiNWJiM2JlMmJlZWEyNWZjZjM3ZDIzMWRiIiwic2VjcmV0IjoiQ1RSMGJRPT0ifQ.Um7L5GQUPRwK1Htg1jVMrmyCD3-7I3LfpFpHjntz3xY
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2beea25fcf37d231d9",
  "type": "CodeChallenge",
  "data": {
    "id": "5bb3be2beea25fcf37d231d9",
    "$type": "CodeChallenge",
    "teamId": "5bb3be2beea25fcf37d231d3",
    "createdById": "5bb3be2beea25fcf37d231db",
    "copiedFromId": null,
    "title": "Insane Events #287",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Meta-programming"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "archived",
    "publishedAt": "2018-10-02T18:51:23.101Z",
    "createdAt": "2018-10-02T18:51:23.106Z",
    "updatedAt": "2018-10-02T18:51:23.122Z",
    "libraryAccess": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2beea25fcf37d231dd",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5bb3be2beea25fcf37d231de",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "8.x",
        "languageVersionName": "Node 8.1.3",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd"
        ],
        "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"
          }
        ]
      }
    },
    "timestamp": "2018-10-02T11:51:23.136-07:00",
    "includes": []
  }
}

Un-archive

Endpoint

PUT /v1/challenges/:id/unarchive

Parameters

Name Description
id required base16 ObjectId

Request

Route

PUT /v1/challenges/5bb3be2beea25fcf37d231f7/unarchive

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJiZWVhMjVmY2YzN2QyMzFmOCIsImlkIjoiNWJiM2JlMmJlZWEyNWZjZjM3ZDIzMWY5Iiwic2VjcmV0IjoiS3hyRDBRPT0ifQ.nzXpzN50o-XOXARfAcx4FkLdFdT7R40GAVJIZObd2S0
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2beea25fcf37d231f7",
  "type": "CodeChallenge",
  "data": {
    "id": "5bb3be2beea25fcf37d231f7",
    "$type": "CodeChallenge",
    "teamId": "5bb3be2beea25fcf37d231f1",
    "createdById": "5bb3be2beea25fcf37d231f9",
    "copiedFromId": null,
    "title": "Password Problem #289",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Logic"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2018-10-02T18:51:23.318Z",
    "createdAt": "2018-10-02T18:51:23.303Z",
    "updatedAt": "2018-10-02T18:51:23.322Z",
    "libraryAccess": null,
    "copiedFromLibrary": null,
    "copiedFromContentType": null,
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2beea25fcf37d231fb",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": false,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5bb3be2beea25fcf37d231fc",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "8.x",
        "languageVersionName": "Node 8.1.3",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd"
        ],
        "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"
          }
        ]
      }
    },
    "timestamp": "2018-10-02T11:51:23.337-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/5bb3be2ceea25fcf37d2327f/import

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJjZWVhMjVmY2YzN2QyMzI4MCIsImlkIjoiNWJiM2JlMmNlZWEyNWZjZjM3ZDIzMjgxIiwic2VjcmV0IjoiU1l4dkhRPT0ifQ.Lf_JtN781ylGmOFegu0LsukDH8OuPP80X6EEVAilmT4
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2ceea25fcf37d23286",
  "type": "CodeChallenge",
  "data": {
    "id": "5bb3be2ceea25fcf37d23286",
    "$type": "CodeChallenge",
    "teamId": "5bb3be2ceea25fcf37d23279",
    "createdById": "5bb3be2ceea25fcf37d23281",
    "copiedFromId": "5bb3be2ceea25fcf37d2327f",
    "title": "Large Class #293 (copy #1)",
    "instructions": "Complete the solution",
    "difficulty": 1,
    "summary": null,
    "purpose": null,
    "topics": [
      "Logic"
    ],
    "labels": null,
    "estimatedTime": 2,
    "state": "published",
    "publishedAt": "2018-10-02T18:51:24.065Z",
    "createdAt": "2018-10-02T18:51:24.040Z",
    "updatedAt": "2018-10-02T18:51:24.040Z",
    "libraryAccess": null,
    "copiedFromLibrary": false,
    "copiedFromContentType": "normal",
    "contentType": "normal",
    "productTypes": {
      "_id": "5bb3be2ceea25fcf37d23289",
      "education": true,
      "recruitment": true
    },
    "collection": "team",
    "protected": false,
    "requiresUpgrade": false,
    "majorVersion": 1,
    "minorVersion": 0,
    "patchVersion": 0,
    "linkedStatus": true,
    "defaultLanguage": null,
    "enforceAllTestsOnPublish": true,
    "sampleTestCasesEnabled": true,
    "enabledServices": [],
    "successMode": "specs",
    "similarityMode": "full",
    "similarityWeight": 1.0,
    "yamlConfig": null,
    "languages": [
      {
        "id": "5bb3be2ceea25fcf37d23288",
        "name": "javascript",
        "exampleWallTime": null,
        "testFramework": "cw-2",
        "languageVersion": "8.x",
        "languageVersionName": "Node 8.1.3",
        "challengeReferenceIds": [],
        "generated": null,
        "availableTestFrameworks": [
          "cw-2",
          "mocha_bdd",
          "mocha_tdd",
          "karma_bdd",
          "karma_tdd"
        ],
        "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"
          }
        ]
      }
    },
    "timestamp": "2018-10-02T11:51:24.083-07:00",
    "includes": []
  }
}

Codecasters

Get

Returns a codecaster account

Endpoint

GET /v1/codecasters/:id

Request

Route

GET /v1/codecasters/5bb3be2eeea25fcf37d23439

Headers

Authorization: 9fULDXi5GT+8416dojtRNJxo+sc9uG7G

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2eeea25fcf37d23439",
  "type": "Codecaster",
  "data": {
    "id": "5bb3be2eeea25fcf37d23439",
    "$type": "Codecaster",
    "firstName": "Joe",
    "lastName": "Smith405",
    "name": "Joe Smith405",
    "email": "[email protected]",
    "profileImg": null
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "active",
          "text": "Active"
        },
        {
          "value": "inactive",
          "text": "Inactive"
        }
      ]
    },
    "timestamp": "2018-10-02T11:51:26.837-07:00",
    "includes": []
  }
}

Update

Updates the codecaster

Endpoint

PUT /v1/codecasters/:id

Request

Route

PUT /v1/codecasters/5bb3be2eeea25fcf37d23445

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTJlZWVhMjVmY2YzN2QyMzQ0NCIsImlkIjoiNWJiM2JlMmVlZWEyNWZjZjM3ZDIzNDQ1Iiwic2VjcmV0IjoiNHpOQlJnPT0ifQ.mJO8A3StOhsan4AHT7MwqPE3MxxKYLOu4HAuzeS_hzc
Content-Type: application/x-www-form-urlencoded

Body

data[first_name]=Charles&data[last_name]=Darwin

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be2eeea25fcf37d23445",
  "type": "Codecaster",
  "data": {
    "id": "5bb3be2eeea25fcf37d23445",
    "$type": "Codecaster",
    "firstName": "Charles",
    "lastName": "Darwin",
    "name": "Charles Darwin",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2018-10-02T18:51:26.855Z",
    "updatedAt": "2018-10-02T18:51:26.874Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_cVgxNymaHFpnhryGBDP9Uw",
    "hasPassword": true,
    "unseenProductReleases": 0
  },
  "meta": {
    "enums": {
      "state": [
        {
          "value": "invited",
          "text": "Invited"
        },
        {
          "value": "active",
          "text": "Active"
        },
        {
          "value": "inactive",
          "text": "Inactive"
        }
      ]
    },
    "timestamp": "2018-10-02T11:51:26.880-07:00",
    "includes": []
  }
}

Note

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=5bb3be31eea25fcf37d235d8

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTMxZWVhMjVmY2YzN2QyMzVjYiIsImlkIjoiNWJiM2JlMzFlZWEyNWZjZjM3ZDIzNWNjIiwic2VjcmV0IjoiWEtTTGdRPT0ifQ.oe7oQ9RA7tC5e40-1MUdPNjhTT5jFrkpWBjnr2fBksQ

Query Parameters

notable_id=5bb3be31eea25fcf37d235d8

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "Note",
  "data": [
    {
      "id": "5bb3be31eea25fcf37d235e5",
      "body": "Voluptas ut dolore ducimus quis est vel aperiam et.",
      "userId": "5bb3be31eea25fcf37d235dd",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5bb3be31eea25fcf37d235d8"
    },
    {
      "id": "5bb3be31eea25fcf37d235e6",
      "body": "Modi facere vitae optio quaerat dicta dolorum.",
      "userId": "5bb3be31eea25fcf37d235e3",
      "createdAt": null,
      "updatedAt": null,
      "notableId": "5bb3be31eea25fcf37d235d8"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 2,
  "meta": {
    "timestamp": "2018-10-02T11:51:29.780-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/5bb3be31eea25fcf37d23601

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTMxZWVhMjVmY2YzN2QyMzVlNyIsImlkIjoiNWJiM2JlMzFlZWEyNWZjZjM3ZDIzNWU4Iiwic2VjcmV0IjoiUENsV1N3PT0ifQ.k1BsaJQ43XPQ8Zk_g0hktOWs85n7xlobvASgFDLtmHI

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be31eea25fcf37d23601",
  "type": "Note",
  "data": {
    "id": "5bb3be31eea25fcf37d23601",
    "body": "Ad totam voluptatibus ipsa sit unde voluptas.",
    "userId": "5bb3be31eea25fcf37d235f9",
    "createdAt": null,
    "updatedAt": null,
    "notableId": "5bb3be31eea25fcf37d235f4"
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:29.936-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTMxZWVhMjVmY2YzN2QyMzYwMyIsImlkIjoiNWJiM2JlMzFlZWEyNWZjZjM3ZDIzNjA0Iiwic2VjcmV0Ijoibk1XUnNRPT0ifQ.J9KpRfdsTDpU5zfwLYVNHDh4PSlE7Sb_M5z34JD7pZI

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be32eea25fcf37d2361f",
  "type": "Note",
  "data": {
    "id": "5bb3be32eea25fcf37d2361f",
    "body": "body",
    "userId": "5bb3be31eea25fcf37d23604",
    "createdAt": "2018-10-02T18:51:30.089Z",
    "updatedAt": "2018-10-02T18:51:30.089Z",
    "notableId": "5bb3be32eea25fcf37d23610"
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:30.091-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/notes/:id

Parameters

Name Description
data.foo required data.foo

Request

Route

PUT /v1/notes/5bb3be32eea25fcf37d2363a

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTMyZWVhMjVmY2YzN2QyMzYyMCIsImlkIjoiNWJiM2JlMzJlZWEyNWZjZjM3ZDIzNjIxIiwic2VjcmV0Ijoid1NEU29RPT0ifQ.KDBoMX52mMhfy8xmO7UXAvX1bPRIamOZQH19VrY3tMo

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be32eea25fcf37d2363a",
  "type": "Note",
  "data": {
    "id": "5bb3be32eea25fcf37d2363a",
    "body": "foo",
    "userId": "5bb3be32eea25fcf37d23632",
    "createdAt": null,
    "updatedAt": "2018-10-02T18:51:30.258Z",
    "notableId": "5bb3be32eea25fcf37d2362d"
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:30.260-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/notes/:id

Request

Route

DELETE /v1/notes/5bb3be32eea25fcf37d23656

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTMyZWVhMjVmY2YzN2QyMzYzYyIsImlkIjoiNWJiM2JlMzJlZWEyNWZjZjM3ZDIzNjNkIiwic2VjcmV0IjoidUgzTWdnPT0ifQ.NtGF2RCep91sM4mJNcSr5GPoy6fyATjy8eTFrSMtWdE
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

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=5bb3be33eea25fcf37d23723

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTMzZWVhMjVmY2YzN2QyMzcyNCIsImlkIjoiNWJiM2JlMzNlZWEyNWZjZjM3ZDIzNzI1Iiwic2VjcmV0IjoieUFrM05RPT0ifQ.gqYMpGUtMXFCyPdQwYPtGmR3X81_S6m2ghDXH_NTwBk

Query Parameters

challenge_id=5bb3be33eea25fcf37d23723

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "QuizMultipleChoiceQuestion",
  "data": [
    {
      "id": "5bb3be33eea25fcf37d23728",
      "$type": "QuizMultipleChoiceQuestion",
      "prompt": "Et non quas ut occaecati optio. Asperiores ex qui est aut. Magni et ut. Cum minima commodi. Provident tempora ipsam saepe error maiores et modi.",
      "position": null,
      "options": {},
      "weight": 1.0,
      "allOrNothing": false,
      "categories": null,
      "choices": [
        "True",
        "False"
      ],
      "sorted": null,
      "maxSelections": null,
      "answers": [
        0
      ]
    },
    {
      "id": "5bb3be33eea25fcf37d23729",
      "$type": "QuizTextQuestion",
      "prompt": "Enim in corporis debitis. Libero voluptatem eos sint iusto ipsum minus cupiditate. Velit minima laudantium.",
      "position": null,
      "options": {},
      "weight": 1.0,
      "allOrNothing": false,
      "categories": null,
      "minCharacters": 5,
      "maxCharacters": 200,
      "matchers": null
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 2,
  "meta": {
    "timestamp": "2018-10-02T11:51:31.806-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/5bb3be33eea25fcf37d23746

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTMzZWVhMjVmY2YzN2QyMzc0MiIsImlkIjoiNWJiM2JlMzNlZWEyNWZjZjM3ZDIzNzQzIiwic2VjcmV0IjoiclhTcGZnPT0ifQ.E6VcjBLA3ooFQ49QrFnayktk2sHqZhLGpn7XFBwTyQo

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be33eea25fcf37d23746",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5bb3be33eea25fcf37d23746",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "Nesciunt nobis ducimus. Minus voluptatem accusamus consequuntur rerum dolor impedit reprehenderit. Dolor asperiores earum quia quia non eum.",
    "position": null,
    "options": {},
    "weight": 1.0,
    "allOrNothing": false,
    "categories": null,
    "choices": [
      "True",
      "False"
    ],
    "sorted": null,
    "maxSelections": null,
    "answers": [
      0
    ]
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:31.887-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.answers A QuizMulitipleChoiceQuestion only field
data.choices A QuizMulitipleChoiceQuestion only field
data.max_selections A QuizMulitipleChoiceQuestion only field
data.sorted A QuizMulitipleChoiceQuestion 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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTMzZWVhMjVmY2YzN2QyMzc1MSIsImlkIjoiNWJiM2JlMzNlZWEyNWZjZjM3ZDIzNzUyIiwic2VjcmV0Ijoid2dxRXNBPT0ifQ.pzZo0pQrVU5ci3rVbDH-C7a6hjPgLusZLgIabjOC958

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be33eea25fcf37d23757",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5bb3be33eea25fcf37d23757",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "test multiple choice question",
    "position": 3,
    "options": {},
    "weight": 1.0,
    "allOrNothing": false,
    "categories": null,
    "choices": [
      "True",
      "False"
    ],
    "sorted": null,
    "maxSelections": 1,
    "answers": [
      1
    ]
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:31.971-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 QuizMulitipleChoiceQuestion only field
data.choices A QuizMulitipleChoiceQuestion only field
data.max_selections A QuizMulitipleChoiceQuestion only field
data.sorted A QuizMulitipleChoiceQuestion 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/5bb3be34eea25fcf37d23765

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM0ZWVhMjVmY2YzN2QyMzc2MSIsImlkIjoiNWJiM2JlMzRlZWEyNWZjZjM3ZDIzNzYyIiwic2VjcmV0IjoiUjNQNkJBPT0ifQ.PAGuCaOLgCPyhtcebbXRkVZwHk1g1c_VDetQMe_jc44

Body

{
  "data": {
    "prompt": "abcd"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be34eea25fcf37d23765",
  "type": "QuizMultipleChoiceQuestion",
  "data": {
    "id": "5bb3be34eea25fcf37d23765",
    "$type": "QuizMultipleChoiceQuestion",
    "prompt": "abcd",
    "position": 2,
    "options": {},
    "weight": 1.0,
    "allOrNothing": false,
    "categories": null,
    "choices": [
      "True",
      "False"
    ],
    "sorted": null,
    "maxSelections": 1,
    "answers": [
      0
    ]
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:32.086-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/quiz_questions/:id

Request

Route

DELETE /v1/quiz_questions/5bb3be34eea25fcf37d23774

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM0ZWVhMjVmY2YzN2QyMzc3MCIsImlkIjoiNWJiM2JlMzRlZWEyNWZjZjM3ZDIzNzcxIiwic2VjcmV0IjoiSVJrNUtBPT0ifQ.cLrsd6VNCg6eyeywUzL0ImeB2uoiEtVmdTZMyOrSO6g
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

Review Qualities

List

Endpoint

GET /v1/review_qualities

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/review_qualities

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM0ZWVhMjVmY2YzN2QyMzdkMCIsImlkIjoiNWJiM2JlMzRlZWEyNWZjZjM3ZDIzN2QxIiwic2VjcmV0IjoiVjV4MXF3PT0ifQ.Uf0mh40ehJ4u6_mHNc6fRXu2SeD7CRhzfQMPTzJ7Wz8

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "ReviewQuality",
  "data": [
    {
      "id": "5bb3be34eea25fcf37d237db",
      "teamId": "5bb3be34eea25fcf37d237d4",
      "active": true,
      "positive": "Danger Sense",
      "negative": "Sonar",
      "inLibrary": false
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2018-10-02T11:51:32.709-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/review_qualities/:id

Request

Route

GET /v1/review_qualities/5bb3be34eea25fcf37d237e7

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM0ZWVhMjVmY2YzN2QyMzdkYyIsImlkIjoiNWJiM2JlMzRlZWEyNWZjZjM3ZDIzN2RkIiwic2VjcmV0Ijoibk13YkdRPT0ifQ.1QhMthl583kgiPRt9rnjbflyBDuE_ml4TzHk99lws6Q

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be34eea25fcf37d237e7",
  "type": "ReviewQuality",
  "data": {
    "id": "5bb3be34eea25fcf37d237e7",
    "teamId": "5bb3be34eea25fcf37d237e0",
    "active": true,
    "positive": "Intuitive aptitude",
    "negative": "Enhanced Hearing",
    "inLibrary": false
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:32.776-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM0ZWVhMjVmY2YzN2QyMzdlOCIsImlkIjoiNWJiM2JlMzRlZWEyNWZjZjM3ZDIzN2U5Iiwic2VjcmV0IjoiL0JyVXpBPT0ifQ.npQYIWoyQqqgJ1rhxZEiqS1Kk8lQhi2nLmV53I6YwOM

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be34eea25fcf37d237f3",
  "type": "ReviewQuality",
  "data": {
    "id": "5bb3be34eea25fcf37d237f3",
    "teamId": "5bb3be34eea25fcf37d237ec",
    "active": true,
    "positive": "Great Implementation",
    "negative": "Poor Implementation",
    "inLibrary": false
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:32.839-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/5bb3be34eea25fcf37d237ff

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM0ZWVhMjVmY2YzN2QyMzdmNCIsImlkIjoiNWJiM2JlMzRlZWEyNWZjZjM3ZDIzN2Y1Iiwic2VjcmV0IjoidlAxTDhBPT0ifQ.oKhiGiX9Q7ORr66exI2gnVA3Neb_ElMZsnBNcy0wh0Q

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be34eea25fcf37d237ff",
  "type": "ReviewQuality",
  "data": {
    "id": "5bb3be34eea25fcf37d237ff",
    "teamId": "5bb3be34eea25fcf37d237f8",
    "active": true,
    "positive": "positive",
    "negative": "Projection",
    "inLibrary": false
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:32.908-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/review_qualities/:id

Request

Route

DELETE /v1/review_qualities/5bb3be34eea25fcf37d2380b

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM0ZWVhMjVmY2YzN2QyMzgwMCIsImlkIjoiNWJiM2JlMzRlZWEyNWZjZjM3ZDIzODAxIiwic2VjcmV0IjoiNEgxa2pnPT0ifQ.7pqJivo5HhGHKflC1MqBknhU5Qqsto5zSpFqUtX9o4Y
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

Solution Reviews

List

Endpoint

GET /v1/solution_reviews

Parameters

Name Description
includes Valid values are:

Request

Route

GET /v1/solution_reviews

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM2ZWVhMjVmY2YzN2QyMzhlZiIsImlkIjoiNWJiM2JlMzZlZWEyNWZjZjM3ZDIzOGYwIiwic2VjcmV0IjoiY1NPRS9RPT0ifQ.1cWv0j8w1NeZfNArI_Z1hFydZO4sYT7MtW12FiA8_9U

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "SolutionReview",
  "data": [
    {
      "id": "5bb3be36eea25fcf37d2390d",
      "reviewedById": "5bb3be36eea25fcf37d238f0",
      "reviewedByStaff": null,
      "assessmentId": "5bb3be36eea25fcf37d238e2",
      "assessmentResultId": "5bb3be36eea25fcf37d238ea",
      "teamCandidateId": "5bb3be36eea25fcf37d238eb",
      "candidateId": "5bb3be36eea25fcf37d238d8",
      "challengeId": "5bb3be36eea25fcf37d238e6",
      "solutionId": "5bb3be36eea25fcf37d238d6",
      "rating": 3,
      "feedback": null,
      "positiveQualityIds": [],
      "negativeQualityIds": [],
      "assessmentResultReviewId": "5bb3be36eea25fcf37d23909"
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2018-10-02T11:51:34.482-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solution_reviews/:id

Request

Route

GET /v1/solution_reviews/5bb3be36eea25fcf37d2394d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM2ZWVhMjVmY2YzN2QyMzkyZiIsImlkIjoiNWJiM2JlMzZlZWEyNWZjZjM3ZDIzOTMwIiwic2VjcmV0Ijoiek85V2p3PT0ifQ.p5ZYNPQ196wncZjZ-WN7SlyrfpoxgnXcyNVTu5j8k54

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be36eea25fcf37d2394d",
  "type": "SolutionReview",
  "data": {
    "id": "5bb3be36eea25fcf37d2394d",
    "reviewedById": "5bb3be36eea25fcf37d23930",
    "reviewedByStaff": null,
    "assessmentId": "5bb3be36eea25fcf37d23922",
    "assessmentResultId": "5bb3be36eea25fcf37d2392a",
    "teamCandidateId": "5bb3be36eea25fcf37d2392b",
    "candidateId": "5bb3be36eea25fcf37d23918",
    "challengeId": "5bb3be36eea25fcf37d23926",
    "solutionId": "5bb3be36eea25fcf37d23916",
    "rating": 3,
    "feedback": null,
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "assessmentResultReviewId": "5bb3be36eea25fcf37d23949"
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:34.847-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM3ZWVhMjVmY2YzN2QyMzk2ZiIsImlkIjoiNWJiM2JlMzdlZWEyNWZjZjM3ZDIzOTcwIiwic2VjcmV0IjoiM3cwdm9nPT0ifQ.ysktAq6yyN4U68a5-0GsTZq_mpClhKov1G94Bd1QP1M

Body

{
  "data": {
    "feedback": "",
    "solution_id": "5bb3be36eea25fcf37d23956",
    "assessment_result_review_id": "5bb3be37eea25fcf37d23972"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be37eea25fcf37d23973",
  "type": "SolutionReview",
  "data": {
    "id": "5bb3be37eea25fcf37d23973",
    "reviewedById": "5bb3be37eea25fcf37d23970",
    "reviewedByStaff": false,
    "assessmentId": "5bb3be36eea25fcf37d23962",
    "assessmentResultId": "5bb3be37eea25fcf37d2396a",
    "teamCandidateId": "5bb3be37eea25fcf37d2396b",
    "candidateId": "5bb3be36eea25fcf37d23958",
    "challengeId": "5bb3be36eea25fcf37d23966",
    "solutionId": "5bb3be36eea25fcf37d23956",
    "rating": null,
    "feedback": "",
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "assessmentResultReviewId": "5bb3be37eea25fcf37d23972"
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:35.115-07:00",
    "includes": []
  }
}

Update

Endpoint

PUT /v1/solution_reviews/:id

Parameters

Name Description
data.feedback required data.feedback

Request

Route

PUT /v1/solution_reviews/5bb3be37eea25fcf37d239b3

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM3ZWVhMjVmY2YzN2QyMzk5NSIsImlkIjoiNWJiM2JlMzdlZWEyNWZjZjM3ZDIzOTk2Iiwic2VjcmV0IjoiWmNTVURBPT0ifQ.yyTSs-aQhFbziqbR6DB10xDzZ0kmMHuV7XJbdc_ttr4

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be37eea25fcf37d239b3",
  "type": "SolutionReview",
  "data": {
    "id": "5bb3be37eea25fcf37d239b3",
    "reviewedById": "5bb3be37eea25fcf37d23996",
    "reviewedByStaff": false,
    "assessmentId": "5bb3be37eea25fcf37d23988",
    "assessmentResultId": "5bb3be37eea25fcf37d23990",
    "teamCandidateId": "5bb3be37eea25fcf37d23991",
    "candidateId": "5bb3be37eea25fcf37d2397e",
    "challengeId": "5bb3be37eea25fcf37d2398c",
    "solutionId": "5bb3be37eea25fcf37d2397c",
    "rating": 3,
    "feedback": "feedback",
    "positiveQualityIds": [],
    "negativeQualityIds": [],
    "assessmentResultReviewId": "5bb3be37eea25fcf37d239af"
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:35.548-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/solution_reviews/:id

Request

Route

DELETE /v1/solution_reviews/5bb3be37eea25fcf37d239f3

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM3ZWVhMjVmY2YzN2QyMzlkNSIsImlkIjoiNWJiM2JlMzdlZWEyNWZjZjM3ZDIzOWQ2Iiwic2VjcmV0IjoiUHRnZlVBPT0ifQ.mwI9A13q6uJ0WEArSmcRPSoLFzSfF1lm-E-HWjMRwr0
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

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]=5bb3be38eea25fcf37d23a23

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM4ZWVhMjVmY2YzN2QyM2EzMCIsImlkIjoiNWJiM2JlMzhlZWEyNWZjZjM3ZDIzYTMxIiwic2VjcmV0IjoiRXJoZHlRPT0ifQ.ZhG5XOdHsNrG2DfYvLZdu_5X8rRS1v1nDe9MFn4ll34

Query Parameters

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "CodeSolution",
  "data": [
    {
      "id": "5bb3be38eea25fcf37d23a28",
      "$type": "CodeSolution",
      "estimatedTime": null,
      "createdAt": "2018-10-02T18:50:36.208Z",
      "challengeId": "5bb3be38eea25fcf37d23a29",
      "assessmentResultId": "5bb3be38eea25fcf37d23a24",
      "assessmentId": "5bb3be38eea25fcf37d23a1d",
      "candidateId": "5bb3be38eea25fcf37d23a22",
      "teamCandidateId": "5bb3be38eea25fcf37d23a23",
      "teamId": "5bb3be38eea25fcf37d23a17",
      "clonedFromId": null,
      "lastHeartbeat": null,
      "accumulatedSeconds": 0,
      "candidateNotes": null,
      "language": "javascript",
      "firstTestCaseSolvedAt": "2018-10-02T18:51:36.208Z",
      "completedAt": "2018-10-02T18:51:36.208Z",
      "code": "var a = 1;",
      "testCases": "Test.assertEquals(a, 1)",
      "testFramework": "cw-2",
      "attempts": 1,
      "output": [
        {
          "t": "passed",
          "v": "Test Passed"
        }
      ],
      "wallTime": 40,
      "firstTestCompletedIn": 60.0,
      "completedIn": 60.0,
      "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,
      "revisionCount": 0,
      "score": 0.0
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2018-10-02T11:51:36.270-07:00",
    "includes": []
  }
}

Get

Endpoint

GET /v1/solutions/:id

Request

Route

GET /v1/solutions/5bb3be39eea25fcf37d23afc

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM5ZWVhMjVmY2YzN2QyM2FmZCIsImlkIjoiNWJiM2JlMzllZWEyNWZjZjM3ZDIzYWZlIiwic2VjcmV0IjoiOTFUYlZRPT0ifQ.xtkpuTVFAAL0fCa_sq6TSDpSSx6FoiluqHkr4LI25IM

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be39eea25fcf37d23afc",
  "type": "CodeSolution",
  "data": {
    "id": "5bb3be39eea25fcf37d23afc",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2018-10-02T18:50:37.416Z",
    "challengeId": "5bb3be39eea25fcf37d23b0c",
    "assessmentResultId": "5bb3be39eea25fcf37d23b10",
    "assessmentId": "5bb3be39eea25fcf37d23b08",
    "candidateId": "5bb3be39eea25fcf37d23afe",
    "teamCandidateId": "5bb3be39eea25fcf37d23aff",
    "teamId": "5bb3be39eea25fcf37d23af6",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2018-10-02T18:51:37.416Z",
    "completedAt": "2018-10-02T18:51:37.416Z",
    "code": "var a = 1;",
    "testCases": "Test.assertEquals(a, 1)",
    "testFramework": "cw-2",
    "attempts": 1,
    "output": [
      {
        "t": "passed",
        "v": "Test Passed"
      }
    ],
    "wallTime": 40,
    "firstTestCompletedIn": 60.0,
    "completedIn": 60.0,
    "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,
    "revisionCount": 0,
    "score": 100.0
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:37.538-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM5ZWVhMjVmY2YzN2QyM2IyYSIsImlkIjoiNWJiM2JlMzllZWEyNWZjZjM3ZDIzYjJiIiwic2VjcmV0IjoiWFN0UjNBPT0ifQ.goiYRakv40TpZEcVPW5NY4MGGcrKHwGVw9f8pWCRMYA

Body

{
  "data": {
    "$type": "CodeSolution",
    "assessment_result_id": "5bb3be39eea25fcf37d23b29",
    "challenge_id": "5bb3be39eea25fcf37d23b21",
    "language": "javascript"
  }
}

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be39eea25fcf37d23b30",
  "type": "CodeSolution",
  "data": {
    "id": "5bb3be39eea25fcf37d23b30",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2018-10-02T18:51:37.697Z",
    "challengeId": "5bb3be39eea25fcf37d23b21",
    "assessmentResultId": "5bb3be39eea25fcf37d23b29",
    "assessmentId": "5bb3be39eea25fcf37d23b1d",
    "candidateId": "5bb3be39eea25fcf37d23b2b",
    "teamCandidateId": "5bb3be39eea25fcf37d23b2c",
    "teamId": "5bb3be39eea25fcf37d23b17",
    "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,
    "revisionCount": 0,
    "score": 0.0
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:37.702-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/5bb3be39eea25fcf37d23b39

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTM5ZWVhMjVmY2YzN2QyM2IzYSIsImlkIjoiNWJiM2JlMzllZWEyNWZjZjM3ZDIzYjNiIiwic2VjcmV0IjoiV00vWEdBPT0ifQ.7VE5rokPcFHKp652Ca9E_UDc9egx0sy3P0qLJMHMcuo

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": "5bb3be39eea25fcf37d23b39",
  "type": "CodeSolution",
  "data": {
    "id": "5bb3be39eea25fcf37d23b39",
    "$type": "CodeSolution",
    "estimatedTime": null,
    "createdAt": "2018-10-02T18:50:37.768Z",
    "challengeId": "5bb3be39eea25fcf37d23b49",
    "assessmentResultId": "5bb3be39eea25fcf37d23b4d",
    "assessmentId": "5bb3be39eea25fcf37d23b45",
    "candidateId": "5bb3be39eea25fcf37d23b3b",
    "teamCandidateId": "5bb3be39eea25fcf37d23b3c",
    "teamId": "5bb3be39eea25fcf37d23b33",
    "clonedFromId": null,
    "lastHeartbeat": null,
    "accumulatedSeconds": 0,
    "candidateNotes": null,
    "language": "javascript",
    "firstTestCaseSolvedAt": "2018-10-02T18:51:37.768Z",
    "completedAt": "2018-10-02T18:51:37.768Z",
    "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.0,
    "completedIn": 60.0,
    "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,
    "revisionCount": 2,
    "score": 100.0,
    "revisions": [
      {
        "id": "5bb3be39eea25fcf37d23b52",
        "createdAt": "2018-10-02T18:50:37.768Z",
        "number": 0,
        "message": null,
        "tag": null,
        "revisedAttributes": {
          "code": "var a = 1;",
          "test_cases": "Test.assertEquals(a, 1)",
          "output": [
            {
              "t": "passed",
              "v": "Test Passed"
            }
          ],
          "wall_time": 40,
          "language": "javascript",
          "weighted": null,
          "specs": null,
          "assertions": null,
          "tags": null,
          "passed_test_cases": 1,
          "weighted_passed_test_cases": 1,
          "attempts": 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,
          "first_test_case_solved_at": "2018-10-02T18:51:37.768Z",
          "completed_at": "2018-10-02T18:51:37.768Z",
          "reopened_count": 0
        }
      },
      {
        "id": "5bb3be39eea25fcf37d23b53",
        "createdAt": "2018-10-02T18:51:37.893Z",
        "number": 1,
        "message": null,
        "tag": "paste",
        "revisedAttributes": {
          "code": "var b = a = 1;"
        }
      }
    ]
  },
  "meta": {
    "timestamp": "2018-10-02T11:51:37.904-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTNhZWVhMjVmY2YzN2QyM2I5NCIsImlkIjoiNWJiM2JlM2FlZWEyNWZjZjM3ZDIzYjk1Iiwic2VjcmV0IjoibXlJWjJBPT0ifQ.2IGjc0-Yt6p8FPnCXZJkN3tZwbM_CIleibAhM9ocybE

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "TeamCandidate",
  "data": [
    {
      "id": "5bb3be3aeea25fcf37d23b77",
      "candidateId": "5bb3be3aeea25fcf37d23b76",
      "angelId": null,
      "teamId": "5bb3be3aeea25fcf37d23b7a",
      "state": "started",
      "demoData": false,
      "prevState": null,
      "assessmentIds": [
        "5bb3be3aeea25fcf37d23b80",
        "5bb3be3aeea25fcf37d23b8c"
      ],
      "assessmentResultIds": [
        "5bb3be3aeea25fcf37d23b88",
        "5bb3be3aeea25fcf37d23b91"
      ],
      "blinding": "blind_reviewers",
      "createdAt": "2018-10-02T18:51:38.230Z",
      "updatedAt": "2018-10-02T18:51:38.347Z",
      "decidedAt": null,
      "invitedAt": null,
      "interactSessions": 0,
      "stateUpdatedAt": "2018-10-02T18:51:38.230Z",
      "testTeamMember": false,
      "assignedTeamMemberIds": [],
      "labels": null,
      "archived": false,
      "firstName": "Joe",
      "lastName": "Smith559",
      "anonymousName": "Indigo Dove",
      "email": "loginidentity5[email protected]",
      "name": "Joe Smith559",
      "isBlinded": false,
      "stateTransitions": [
        "idle",
        "invited",
        "started",
        "submitted",
        "approved",
        "rejected",
        "archived"
      ],
      "stateLabel": "Assessment Started",
      "assessmentsRecap": {
        "id": "5bb3be3aeea25fcf37d23b8a",
        "subjects": [
          {
            "id": "5bb3be3aeea25fcf37d23b8b",
            "assessmentResultId": "5bb3be3aeea25fcf37d23b88",
            "assessmentId": "5bb3be3aeea25fcf37d23b80",
            "state": "started"
          },
          {
            "id": "5bb3be3aeea25fcf37d23b93",
            "assessmentResultId": "5bb3be3aeea25fcf37d23b91",
            "assessmentId": "5bb3be3aeea25fcf37d23b8c",
            "state": "started"
          }
        ]
      }
    }
  ],
  "currentPage": 1,
  "totalPages": 1,
  "totalCount": 1,
  "meta": {
    "timestamp": "2018-10-02T11:51:38.399-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/5bb3be3beea25fcf37d23c3d

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTNiZWVhMjVmY2YzN2QyM2M1YSIsImlkIjoiNWJiM2JlM2JlZWEyNWZjZjM3ZDIzYzViIiwic2VjcmV0IjoiaUoyY0ZBPT0ifQ.sbUYq5mXnd-Ca2PZ8LmPt-lAvXuM67eQ8L0MiIJXQ48

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be3beea25fcf37d23c3d",
  "type": "TeamCandidate",
  "data": {
    "id": "5bb3be3beea25fcf37d23c3d",
    "candidateId": "5bb3be3beea25fcf37d23c3c",
    "angelId": null,
    "teamId": "5bb3be3beea25fcf37d23c40",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5bb3be3beea25fcf37d23c46",
      "5bb3be3beea25fcf37d23c52"
    ],
    "assessmentResultIds": [
      "5bb3be3beea25fcf37d23c4e",
      "5bb3be3beea25fcf37d23c57"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2018-10-02T18:51:39.528Z",
    "updatedAt": "2018-10-02T18:51:39.647Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2018-10-02T18:51:39.528Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": null,
    "archived": false,
    "firstName": "Joe",
    "lastName": "Smith576",
    "anonymousName": "Beige Hare",
    "email": "[email protected]",
    "name": "Joe Smith576",
    "isBlinded": false,
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "approved",
      "rejected",
      "archived"
    ],
    "stateLabel": "Assessment Started",
    "assessmentsRecap": {
      "id": "5bb3be3beea25fcf37d23c50",
      "subjects": [
        {
          "id": "5bb3be3beea25fcf37d23c51",
          "assessmentResultId": "5bb3be3beea25fcf37d23c4e",
          "assessmentId": "5bb3be3beea25fcf37d23c46",
          "state": "started"
        },
        {
          "id": "5bb3be3beea25fcf37d23c59",
          "assessmentResultId": "5bb3be3beea25fcf37d23c57",
          "assessmentId": "5bb3be3beea25fcf37d23c52",
          "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": "approved",
          "text": "Approved"
        },
        {
          "value": "rejected",
          "text": "Rejected"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ]
    },
    "timestamp": "2018-10-02T11:51:39.687-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/5bb3be3ceea25fcf37d23c94

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTNjZWVhMjVmY2YzN2QyM2NiMSIsImlkIjoiNWJiM2JlM2NlZWEyNWZjZjM3ZDIzY2IyIiwic2VjcmV0IjoiNkFyT1BnPT0ifQ.U-TSoL7fWk-ij-X6ROwKsclMXqbnvhHiG9okFaszvxE

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be3ceea25fcf37d23c94",
  "type": "TeamCandidate",
  "data": {
    "id": "5bb3be3ceea25fcf37d23c94",
    "candidateId": "5bb3be3ceea25fcf37d23c93",
    "angelId": null,
    "teamId": "5bb3be3ceea25fcf37d23c97",
    "state": "started",
    "demoData": false,
    "prevState": null,
    "assessmentIds": [
      "5bb3be3ceea25fcf37d23c9d",
      "5bb3be3ceea25fcf37d23ca9"
    ],
    "assessmentResultIds": [
      "5bb3be3ceea25fcf37d23ca5",
      "5bb3be3ceea25fcf37d23cae"
    ],
    "blinding": "blind_reviewers",
    "createdAt": "2018-10-02T18:51:40.202Z",
    "updatedAt": "2018-10-02T18:51:40.350Z",
    "decidedAt": null,
    "invitedAt": null,
    "interactSessions": 0,
    "stateUpdatedAt": "2018-10-02T18:51:40.201Z",
    "testTeamMember": false,
    "assignedTeamMemberIds": [],
    "labels": null,
    "archived": false,
    "firstName": "Test",
    "lastName": "Time",
    "anonymousName": "Coral Muskox",
    "email": "[email protected]",
    "name": "Test Time",
    "isBlinded": false,
    "stateTransitions": [
      "idle",
      "invited",
      "started",
      "submitted",
      "approved",
      "rejected",
      "archived"
    ],
    "stateLabel": "Assessment Started",
    "assessmentsRecap": {
      "id": "5bb3be3ceea25fcf37d23ca7",
      "subjects": [
        {
          "id": "5bb3be3ceea25fcf37d23ca8",
          "assessmentResultId": "5bb3be3ceea25fcf37d23ca5",
          "assessmentId": "5bb3be3ceea25fcf37d23c9d",
          "state": "started"
        },
        {
          "id": "5bb3be3ceea25fcf37d23cb0",
          "assessmentResultId": "5bb3be3ceea25fcf37d23cae",
          "assessmentId": "5bb3be3ceea25fcf37d23ca9",
          "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": "approved",
          "text": "Approved"
        },
        {
          "value": "rejected",
          "text": "Rejected"
        },
        {
          "value": "archived",
          "text": "Archived"
        }
      ]
    },
    "timestamp": "2018-10-02T11:51:40.414-07:00",
    "includes": []
  }
}

Delete

Endpoint

DELETE /v1/team_candidates/:id

Parameters

Name Description
id required base16 ObjectId

Request

Route

DELETE /v1/team_candidates/5bb3be3eeea25fcf37d23df1

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTNlZWVhMjVmY2YzN2QyM2UwZiIsImlkIjoiNWJiM2JlM2VlZWEyNWZjZjM3ZDIzZTEwIiwic2VjcmV0IjoiRTVQbThRPT0ifQ._7eyP6D3d9UJSr35o0ZAismP2Bdp-V_EdbZhs9KBrlk
Content-Type: application/x-www-form-urlencoded

Response

Simulated Response

Status

204

Headers

Team Members

List

Returns all non-staff members for admins

Endpoint

GET /v1/team_members

Request

Route

GET /v1/team_members

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTNmZWVhMjVmY2YzN2QyM2U1YSIsImlkIjoiNWJiM2JlM2ZlZWEyNWZjZjM3ZDIzZTViIiwic2VjcmV0IjoiZ0dlQm9BPT0ifQ.QHbyEmBNGQ5KmvYcvZ_zBpK3nP0z7615syXijgHOBSk

Response

Simulated Response

Status

200

Headers

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

Body

{
  "type": "TeamMember",
  "data": [
    {
      "id": "5bb3be3feea25fcf37d23e52",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith636",
      "name": "Joe Smith636",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2018-10-02T18:51:43.380Z",
      "updatedAt": "2018-10-02T18:51:43.380Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_bj70AyLbVZ4ivBcn4JNdQg",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "yFz9t5RSkWftJw.5bb3be3feea25fcf37d23e52",
      "teamId": "5bb3be3feea25fcf37d23e45",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2018-10-02T18:51:43.376Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5bb3be3feea25fcf37d23e53",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5bb3be3feea25fcf37d23e4f",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith635",
      "name": "Joe Smith635",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2018-10-02T18:51:43.365Z",
      "updatedAt": "2018-10-02T18:51:43.365Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_Ss4kytMbre0mQ0YP7sicBw",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "fkf80wb8janT3Q.5bb3be3feea25fcf37d23e4f",
      "teamId": "5bb3be3feea25fcf37d23e45",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2018-10-02T18:51:43.361Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5bb3be3feea25fcf37d23e50",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5bb3be3feea25fcf37d23e4c",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith634",
      "name": "Joe Smith634",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2018-10-02T18:51:43.350Z",
      "updatedAt": "2018-10-02T18:51:43.350Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_X8jWp9FpQBSb0Co6ozmHqQ",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "QvOtqnADe2ZQNw.5bb3be3feea25fcf37d23e4c",
      "teamId": "5bb3be3feea25fcf37d23e45",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2018-10-02T18:51:43.346Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5bb3be3feea25fcf37d23e4d",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5bb3be3feea25fcf37d23e41",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith633",
      "name": "Joe Smith633",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2018-10-02T18:51:43.304Z",
      "updatedAt": "2018-10-02T18:51:43.304Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_VpMiwq6N5Cuw6X8h8prFTQ",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "SYRiGdg4T2SnGQ.5bb3be3feea25fcf37d23e41",
      "teamId": "5bb3be3feea25fcf37d23e37",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2018-10-02T18:51:43.301Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5bb3be3feea25fcf37d23e42",
        "assessmentStarted": true,
        "assessmentSubmitted": true,
        "assessmentResultReviewSubmitted": true,
        "candidateApproved": true,
        "candidateRejected": true,
        "noteAdded": true
      },
      "phone": null,
      "title": null,
      "initialUser": false
    },
    {
      "id": "5bb3be3feea25fcf37d23e3e",
      "$type": "TeamMember",
      "firstName": "Joe",
      "lastName": "Smith632",
      "name": "Joe Smith632",
      "email": "[email protected]",
      "profileImg": null,
      "createdAt": "2018-10-02T18:51:43.289Z",
      "updatedAt": "2018-10-02T18:51:43.289Z",
      "uiPrefs": null,
      "experiments": null,
      "envRoomId": "test_TpzqwcKH3kCc0jQU7AOipQ",
      "hasPassword": true,
      "intercomUrl": null,
      "confirmationToken": "p5OEp2K97nPZ6A.5bb3be3feea25fcf37d23e3e",
      "teamId": "5bb3be3feea25fcf37d23e37",
      "role": "owner",
      "state": "active",
      "disabled": false,
      "angelApiKey": null,
      "activatedAt": "2018-10-02T18:51:43.286Z",
      "deactivatedAt": null,
      "notifications": {
        "id": "5bb3be3feea25fcf37d23e3f",
        "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": "2018-10-02T11:51:43.460-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/5bb3be40eea25fcf37d23ed6?includes[]=team&includes[]=authored_challenges&includes[]=authored_assessments

Headers

Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTQwZWVhMjVmY2YzN2QyM2VkOCIsImlkIjoiNWJiM2JlNDBlZWEyNWZjZjM3ZDIzZWQ5Iiwic2VjcmV0IjoiYktqMkxnPT0ifQ.1jnZn_V3yN2VdhNW9NIp14b0Q84Sae0XzV2aUrjxI2o

Query Parameters

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be40eea25fcf37d23ed6",
  "type": "TeamMember",
  "data": {
    "id": "5bb3be40eea25fcf37d23ed6",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith661",
    "name": "Joe Smith661",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2018-10-02T18:51:44.152Z",
    "updatedAt": "2018-10-02T18:51:44.152Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_nK8rtSxLQ56N9rUdbNr3aA",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "yc98bbYwzekpMQ.5bb3be40eea25fcf37d23ed6",
    "teamId": "5bb3be40eea25fcf37d23ecf",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "angelApiKey": null,
    "team": {
      "id": "5bb3be40eea25fcf37d23ecf",
      "name": "team242",
      "updatedAt": "2018-10-02T18:51:44.136Z",
      "highConcept": null,
      "website": null,
      "productTypes": {
        "_id": "5bb3be40eea25fcf37d23ed2",
        "education": true,
        "recruitment": true
      },
      "customerId": "5bb3be40eea25fcf37d23ecd",
      "hasDemoData": false,
      "buildingDemoData": false,
      "destroyingDemoData": false,
      "surveysDisabled": null,
      "labs": {
        "codeSimilarity": false,
        "angellistSourcing": false
      },
      "logoImg": {
        "id": "5bb3be40eea25fcf37d23ed1",
        "fileId": "aDbsZA",
        "fileFormat": "jpg",
        "width": 500,
        "height": 500,
        "url": "//res.cloudinary.com/strive/image/upload/aDbsZA.jpg",
        "rawUrl": "https://s3-us-west-1.amazonaws.com/strive-uploads/aDbsZA.jpg",
        "size": null,
        "brightness": null,
        "background": null
      },
      "createdAt": "2018-10-02T18:51:44.136Z",
      "state": "inactive",
      "assessmentsEnabled": true,
      "publishedAssessmentCount": 0,
      "assessmentResultCount": 0,
      "growthSpeed": "high_growth",
      "companySize": null,
      "engineeringTeamSize": null,
      "referenceInfo": null,
      "webhookUrl": "http://www.qualified.io/",
      "sendAllWebhookEvents": false,
      "notificationScheme": "by_assignee",
      "setupAssessmentId": null,
      "setupComplete": false,
      "desiredLanguages": null,
      "showReviewsToReviewers": false,
      "unblindAfterDecision": false,
      "apiKey": null,
      "greenhouseApiKey": null,
      "workableApiKey": null,
      "hasBlindReviewers": false,
      "msaSigned": false,
      "webhookEvents": {
        "id": "5bb3be40eea25fcf37d23eda"
      },
      "desiredFeatures": {
        "id": "5bb3be40eea25fcf37d23ed4",
        "takeHome": true
      },
      "progressEvents": {
        "id": "5bb3be40eea25fcf37d23edb"
      },
      "salesLeadQuality": null,
      "salesLeadContacted": false,
      "nameWasGenerated": false,
      "teamMemberRoleCounts": {
        "owner": 1
      },
      "desiredIntegration": null,
      "desiredIntegrationIsCurrent": null,
      "evaluatedCandidatesMonthly": null,
      "evaluatedCandidatesYearly": null,
      "msaSignedAt": null,
      "msaSignedById": null,
      "utmTracking": {
        "id": "5bb3be40eea25fcf37d23ed3",
        "utmSource": "qualified"
      }
    },
    "activatedAt": "2018-10-02T18:51:44.148Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5bb3be40eea25fcf37d23ed7",
      "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": "Equal Opportunity 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": "2018-10-02T11:51:44.199-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.eyJpZGVudGl0eV9pZCI6IjViYjNiZTQwZWVhMjVmY2YzN2QyM2VkYyIsImlkIjoiNWJiM2JlNDBlZWEyNWZjZjM3ZDIzZWRkIiwic2VjcmV0IjoieWUrcGhnPT0ifQ.5nmpsO4C97d5ukIJcvOwGhSzG81uiLpf6quVFlf9POA

Body

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

Response

Simulated Response

Status

200

Headers

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

Body

{
  "id": "5bb3be40eea25fcf37d23ee7",
  "type": "TeamMember",
  "data": {
    "id": "5bb3be40eea25fcf37d23ee7",
    "$type": "TeamMember",
    "firstName": "Joe",
    "lastName": "Smith",
    "name": "Joe Smith",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2018-10-02T18:51:44.279Z",
    "updatedAt": "2018-10-02T18:51:44.279Z",
    "uiPrefs": null,
    "experiments": null,
    "envRoomId": "test_8GzLThb4DJQDPwF7pWsYfA",
    "hasPassword": false,
    "intercomUrl": null,
    "confirmationToken": "bkD5sbnbzsbSsg.5bb3be40eea25fcf37d23ee7",
    "teamId": "5bb3be40eea25fcf37d23ee0",
    "role": "owner",
    "state": "invited",
    "disabled": false,
    "angelApiKey": null,
    "activatedAt": "2018-10-02T18:51:44.280Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5bb3be40eea25fcf37d23ee8",
      "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": "Equal Opportunity 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": "2018-10-02T11:51:44.305-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/5bb3be40eea25fcf37d23eed

Headers

Content-Type: application/json
Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpZGVudGl0eV9pZCI6IjViYjNiZTQwZWVhMjVmY2YzN2QyM2VlYSIsImlkIjoiNWJiM2JlNDBlZWEyNWZjZjM3ZDIzZWViIiwic2VjcmV0IjoiY1JPbUZRPT0ifQ.-uUy3dRaoO8ikYQwVAzFasx_S1n8vVaZZH1AIU6bYPA

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": "5bb3be40eea25fcf37d23eed",
  "type": "TeamMember",
  "data": {
    "id": "5bb3be40eea25fcf37d23eed",
    "$type": "TeamMember",
    "firstName": "Test",
    "lastName": "Time",
    "name": "Test Time",
    "email": "[email protected]",
    "profileImg": null,
    "createdAt": "2018-10-02T18:51:44.374Z",
    "updatedAt": "2018-10-02T18:51:44.406Z",
    "uiPrefs": {
      "theme": "dark"
    },
    "experiments": null,
    "envRoomId": "test_dbBrSJUbfyva5Ufnh2qnyQ",
    "hasPassword": true,
    "intercomUrl": null,
    "confirmationToken": "bp74jkQnpVOAog.5bb3be40eea25fcf37d23eed",
    "teamId": "5bb3be40eea25fcf37d23ef0",
    "role": "owner",
    "state": "active",
    "disabled": false,
    "angelApiKey": null,
    "activatedAt": "2018-10-02T18:51:44.337Z",
    "deactivatedAt": null,
    "notifications": {
      "id": "5bb3be40eea25fcf37d23ef6",
      "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": "Equal Opportunity 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": "2018-10-02T11:51:44.413-07:00",
    "includes": []
  }
}