Security Clearances API

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

List clearances on a resume

Get a candidate’s clearances listed on their resume

GET /candidates/:candidate_id/resume/clearances

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": "f2478635-dec5-4ebf-ada4-454ade6a6d3b",
    "description": "Top Secret",
    "source": "National Security Agency",
    "start_date": "2011-01-01",
    "end_date": "2013-12-31"
  }
]

Get a single clearance

GET /candidates/:candidate_id/resume/clearances/:clearance_id

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "f2478635-dec5-4ebf-ada4-454ade6a6d3b",
  "description": "Top Secret",
  "source": "National Security Agency",
  "start_date": "2011-01-01",
  "end_date": "2013-12-31"
}

Create an clearance

Create a new clearance.

POST /candidates/:candidate_id/resume/clearances

Input

description
Required string
source
Required string
start_date
Required string - Date this clearance took effect
end_date
Required string - Date this clearance expires
{
  "description": "Top Secret",
  "source": "National Security Agency",
  "start_date": "2011-01-01",
  "end_date": "2013-12-31"
}

Response

Status: 201 Created
Location: https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7/resume/clearances/2894c358-f2d0-4a3f-952f-5afdb8dd81aa
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "f2478635-dec5-4ebf-ada4-454ade6a6d3b",
  "description": "Top Secret",
  "source": "National Security Agency",
  "start_date": "2011-01-01",
  "end_date": "2013-12-31"
}

Update an clearance

Update the provided clearance.

PATCH /candidates/:candidate_id/resume/clearances/:clearance_id

Input

description
Required string
source
Required string
start_date
Required string - Date this clearance took effect
end_date
Required string - Date this clearance expires
{
  "description": "Top Secret",
  "source": "National Security Agency",
  "start_date": "2011-01-01",
  "end_date": "2013-12-31"
}

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "f2478635-dec5-4ebf-ada4-454ade6a6d3b",
  "description": "Top Secret",
  "source": "National Security Agency",
  "start_date": "2011-01-01",
  "end_date": "2013-12-31"
}

Delete an clearance

Delete the provided clearance.

DELETE /candidates/:candidate_id/resume/clearances/:clearance_id

Response

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