Candidate Interview v1.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

This is the API for pairing and coding assessments in our Interview Process.

Base URLs:

• https://candidate.commonroom.builders

• http://127.0.0.1:8080

Email: Common Room, Inc Web: Common Room, Inc

Authentication

• oAuth2 authentication.

Once you have your access token, pass it in the Authorization header in the format of {type} {token} - for example, a token foo with type bearer would be bearer foo.

- Flow: implicit

Default

Health Check Endpoint

Code samples

GET https://candidate.commonroom.builders/healthz HTTP/1.1
Host: candidate.commonroom.builders

# You can also use wget
curl -X GET https://candidate.commonroom.builders/healthz

fetch('https://candidate.commonroom.builders/healthz',
{
  method: 'GET'

})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests

r = requests.get('https://candidate.commonroom.builders/healthz')

print(r.json())

GET /healthz

Responses

Create an Authentication Token

Code samples

POST https://candidate.commonroom.builders/auth/token HTTP/1.1
Host: candidate.commonroom.builders
Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X POST https://candidate.commonroom.builders/auth/token \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

const inputBody = '{
  "grant_type": "refresh_token",
  "refresh_token": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://candidate.commonroom.builders/auth/token',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://candidate.commonroom.builders/auth/token', headers = headers)

print(r.json())

POST /auth/token

OAuth2 Token endpoint allowing for refresh and other token exchange mechanisms.

Body parameter

{
  "grant_type": "refresh_token",
  "refresh_token": "string"
}

grant_type: refresh_token
refresh_token: string

Parameters

Enumerated Values

Example responses

200 Response

{
  "access_token": "string",
  "refresh_token": "string",
  "token_type": "Bearer",
  "expires_in": 0,
  "refresh_expires_in": 0
}

Responses

Response Schema

Status Code 200

Enumerated Values

Response Headers

Instructions

Code samples

GET https://candidate.commonroom.builders/instructions HTTP/1.1
Host: candidate.commonroom.builders
Accept: text/plain

# You can also use wget
curl -X GET https://candidate.commonroom.builders/instructions \
  -H 'Accept: text/plain' \
  -H 'Authorization: Bearer {access-token}'

const headers = {
  'Accept':'text/plain',
  'Authorization':'Bearer {access-token}'
};

fetch('https://candidate.commonroom.builders/instructions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'text/plain',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://candidate.commonroom.builders/instructions', headers = headers)

print(r.json())

GET /instructions

Retrieves the Instructions for a candidate, dependent on the API token specified.

Example responses

Responses

Response Schema

Quotes

Code samples

GET https://candidate.commonroom.builders/quotes HTTP/1.1
Host: candidate.commonroom.builders
Accept: application/json
Accept: string
Last-Event-ID: string

# You can also use wget
curl -X GET https://candidate.commonroom.builders/quotes \
  -H 'Accept: application/json' \
  -H 'Accept: string' \
  -H 'Last-Event-ID: string' \
  -H 'Authorization: Bearer {access-token}'

const headers = {
  'Accept':'application/json',
  'Accept':'string',
  'Last-Event-ID':'string',
  'Authorization':'Bearer {access-token}'
};

fetch('https://candidate.commonroom.builders/quotes',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Accept': 'string',
  'Last-Event-ID': 'string',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://candidate.commonroom.builders/quotes', headers = headers)

print(r.json())

GET /quotes

Gets famous quotes from the server.

Pagination information can be found in the response's Link headers.

May also be a server-sent events stream when requested via the Accept header.

Parameters

Example responses

200 Response

[
  {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAV",
    "created": "2020-04-10T04:34:16Z",
    "text": "Hello World",
    "author": "This Very API!",
    "uri": "http://example.com/"
  },
  {
    "id": "01ARZ3NDEKTSV4RRFFQ69G5FAA",
    "created": "2020-04-10T04:34:16Z",
    "text": "Hello Earth",
    "author": "This Very API!",
    "uri": "http://example.com/"
  }
]

Responses

Response Schema

Status Code 200

Response Headers

Get All Analysis

Code samples

GET https://candidate.commonroom.builders/quotes/analysis HTTP/1.1
Host: candidate.commonroom.builders
Accept: application/json

# You can also use wget
curl -X GET https://candidate.commonroom.builders/quotes/analysis \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://candidate.commonroom.builders/quotes/analysis',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://candidate.commonroom.builders/quotes/analysis', headers = headers)

print(r.json())

GET /quotes/analysis

Example responses

200 Response

[
  {
    "description": "string",
    "link": "string",
    "submitted": "string",
    "example": null
  }
]

Responses

Response Schema

Status Code 200

Publish an Analysis by Type

Code samples

PUT https://candidate.commonroom.builders/quotes/analysis/{type} HTTP/1.1
Host: candidate.commonroom.builders
Content-Type: application/json
Accept: application/json

# You can also use wget
curl -X PUT https://candidate.commonroom.builders/quotes/analysis/{type} \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'
};

fetch('https://candidate.commonroom.builders/quotes/analysis/{type}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('https://candidate.commonroom.builders/quotes/analysis/{type}', headers = headers)

print(r.json())

PUT /quotes/analysis/{type}

Body parameter

null

Parameters

Example responses

400 Response

{
  "message": "string"
}

Responses

Schemas

Error

{
  "message": "string"
}

Error

Properties

Quote

{
  "id": "string",
  "created": "2022-06-08T15:35:35Z",
  "text": "string",
  "author": "string",
  "uri": "http://example.com"
}

Quote

Properties

Analysis

{
  "description": "string",
  "link": "string",
  "submitted": "string",
  "example": null
}

Analysis

Properties