Awards API

• List awards on a resume
• Get a single award
• Create an award
• Update an award
• Delete an award

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

List awards on a resume

Get a candidate’s awards listed on their resume

GET /candidates/:candidate_id/resume/awards

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": "2894c358-f2d0-4a3f-952f-5afdb8dd81aa",
    "description": "Emmy - Best Actor",
    "source": "Academy of Television Arts and Sciences",
    "date": "2012-09-23"
  }
]

Get a single award

GET /candidates/:candidate_id/resume/awards/:award_id

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999

{
  "id": "2894c358-f2d0-4a3f-952f-5afdb8dd81aa",
  "description": "Emmy - Best Actor",
  "source": "Academy of Television Arts and Sciences",
  "date": "2012-09-23"
}

Create an award

Create a new award.

POST /candidates/:candidate_id/resume/awards

Input

description

Required string

source

Required string

date

Optional string

{
  "description": "Emmy - Best Actor",
  "source": "Academy of Television Arts and Sciences",
  "date": "2012-09-23"
}

Response

Status: 201 Created
Location: https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7/resume/awards/2894c358-f2d0-4a3f-952f-5afdb8dd81aa
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999

{
  "id": "2894c358-f2d0-4a3f-952f-5afdb8dd81aa",
  "description": "Emmy - Best Actor",
  "source": "Academy of Television Arts and Sciences",
  "date": "2012-09-23"
}

Update an award

Update the provided award.

PATCH /candidates/:candidate_id/resume/awards/:award_id

Input

description

Required string

source

Required string

date

Optional string

{
  "description": "Emmy - Best Actor",
  "source": "Academy of Television Arts and Sciences",
  "date": "2012-09-23"
}

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999

{
  "id": "2894c358-f2d0-4a3f-952f-5afdb8dd81aa",
  "description": "Emmy - Best Actor",
  "source": "Academy of Television Arts and Sciences",
  "date": "2012-09-23"
}

Delete an award

Delete the provided award.

DELETE /candidates/:candidate_id/resume/awards/:award_id

Response

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