Languages API

These endpoints are only available to counselors and candidates, candidates can only view/edit items in their own resume

List languages on a resume

Get a candidate’s languages listed on their resume

GET /candidates/:candidate_id/resume/languages

Response

Status: 200 OK
Link: <https://tapability.org/api/v1/resource?page=2>; rel="next",
      <https://tapability.org/api/v1/resource?page=5>; rel="last"
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
[
  {
    "id": "f8c78d5c-f206-41bc-aca3-bd1b4882b4df",
    "name": "Spanish",
    "fluency": "Conversational",
    "read": true,
    "write": false,
    "speak": false
  }
]

Get a single language

GET /candidates/:candidate_id/resume/languages/:language_id

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "f8c78d5c-f206-41bc-aca3-bd1b4882b4df",
  "name": "Spanish",
  "fluency": "Conversational",
  "read": true,
  "write": false,
  "speak": false
}

Create an language

Create a new language.

POST /candidates/:candidate_id/resume/languages

Input

name
Required string
fluency
Required string
read
Optional boolean
write
Optional boolean
speak
Optional boolean 
{
  "name": "Spanish",
  "fluency": "Conversational",
  "read": true
}

Response

Status: 201 Created
Location: https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7/resume/languages/f8c78d5c-f206-41bc-aca3-bd1b4882b4df
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "f8c78d5c-f206-41bc-aca3-bd1b4882b4df",
  "name": "Spanish",
  "fluency": "Conversational",
  "read": true,
  "write": false,
  "speak": false
}

Update an language

Update the provided language.

PATCH /candidates/:candidate_id/resume/languages/:language_id

Input

name
Required string
fluency
Required string
read
Optional boolean
write
Optional boolean
speak
Optional boolean 
{
  "name": "Spanish",
  "fluency": "Conversational",
  "read": true
}

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "f8c78d5c-f206-41bc-aca3-bd1b4882b4df",
  "name": "Spanish",
  "fluency": "Conversational",
  "read": true,
  "write": false,
  "speak": false
}

Delete an language

Delete the provided language.

DELETE /candidates/:candidate_id/resume/languages/:language_id

Response

Status: 204 No Content
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999