Locations API

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

Many of the endpoints below require a US state as input. States must precisely match one from the following list. Specifying an invalid state will result in a 422 Unprocessable Entity response.

[
  "Alabama",
  "Alaska",
  "Arizona",
  "Arkansas",
  "California",
  "Colorado",
  "Connecticut",
  "Delaware",
  "District of Columbia",
  "Florida",
  "Georgia",
  "Guam",
  "Hawaii",
  "Idaho",
  "Illinois",
  "Indiana",
  "Iowa",
  "Kansas",
  "Kentucky",
  "Louisiana",
  "Maine",
  "Maryland",
  "Massachusetts",
  "Michigan",
  "Minnesota",
  "Mississippi",
  "Missouri",
  "Montana",
  "Nebraska",
  "Nevada",
  "New Hampshire",
  "New Jersey",
  "New Mexico",
  "New York",
  "North Carolina",
  "North Dakota",
  "Ohio",
  "Oklahoma",
  "Oregon",
  "Pennsylvania",
  "Puerto Rico",
  "Rhode Island",
  "South Carolina",
  "South Dakota",
  "Tennessee",
  "Texas",
  "Utah",
  "Vermont",
  "Virginia",
  "Virgin Islands",
  "Washington",
  "West Virginia",
  "Wisconsin",
  "Wyoming"
]

List locations on a resume

Get a candidate’s available work locations

GET /candidates/:candidate_id/resume/locations

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": "8a58f89e-d8fe-4477-aeaf-fe37f7c86e8c",
    "distance": 10,
    "city": "San Diego",
    "state": "California",
    "coordinates": [
      32.7993,
      -117.16
    ]
  }
]

Create a location

Create a new location.

Note: you can provide any US city and state here, but if we do not have any existing entries with the supplied city, you will not immediately receive geographic coordinates. Coordinates for new cities are determined asyncronously on our servers. If you need the coordinates immediately, perform a subsequent GET a few seconds after creating. Major cities will return coordinates immediately.

POST /candidates/:candidate_id/resume/locations

Input

city
Required string
state
Required string
distance
Optional integer - miles from the center of this city where the candidate is willing to work, defaults to 10
{
  "city": "San Diego",
  "state": "California",
  "distance": 10
}

Response

Status: 201 Created
Location: https://tapability.org/api/v1/candidates/eaf3022f-330e-46db-8665-01e0969ff2f7/resume/locations/8a58f89e-d8fe-4477-aeaf-fe37f7c86e8c
X-RateLimit-Limit: 5000
X-RateLimit-Remaining: 4999
{
  "id": "8a58f89e-d8fe-4477-aeaf-fe37f7c86e8c",
  "distance": 10,
  "city": "San Diego",
  "state": "California",
  "coordinates": [
    32.7993,
    -117.16
  ]
}

Delete a location

Delete the provided location.

DELETE /candidates/:candidate_id/resume/locations/:location_id

Response

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