Publications API

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

List publications on a resume

Get a candidate’s publications listed on their resume

GET /candidates/:candidate_id/resume/publications

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": "33dbc578-d2cf-4892-bece-f6e7b5c2c477",
    "description": "Office Relationships at Dunder Miflin",
    "source": "The New York Times",
    "date": "2013-01-01"
  }
]

Get a single publication

GET /candidates/:candidate_id/resume/publications/:publication_id

Response

Status: 200 OK
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "33dbc578-d2cf-4892-bece-f6e7b5c2c477",
  "description": "Office Relationships at Dunder Miflin",
  "source": "The New York Times",
  "date": "2013-01-01"
}

Create an publication

Create a new publication.

POST /candidates/:candidate_id/resume/publications

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/publications/2894c358-f2d0-4a3f-952f-5afdb8dd81aa
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "33dbc578-d2cf-4892-bece-f6e7b5c2c477",
  "description": "Office Relationships at Dunder Miflin",
  "source": "The New York Times",
  "date": "2013-01-01"
}

Update an publication

Update the provided publication.

PATCH /candidates/:candidate_id/resume/publications/:publication_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": "33dbc578-d2cf-4892-bece-f6e7b5c2c477",
  "description": "Office Relationships at Dunder Miflin",
  "source": "The New York Times",
  "date": "2013-01-01"
}

Delete an publication

Delete the provided publication.

DELETE /candidates/:candidate_id/resume/publications/:publication_id

Response

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