List user's education
Endpoint: /api/v2/educations
Method | Action | Parameters |
---|---|---|
GET | List a user's education |
|
An example of a return response for a url like /api/v2/educations?&user=12345678
"data": [ // The returned work experience collection
{
"type": "education",
"id": "123456",
"attributes": {
"title": "MSc",
"institution": "University of Tampere",
"field": "Interactive Technology",
"description": "Studying computer science and media.",
"start-year": "2001",
"end-year": "2007",
"created-at": "Tue, 16 May 2017 15:08:46 +0300",
"updated-at": "Tue, 16 May 2017 15:08:46 +0300"
},
"relationships": {
"user": {
"data": {
"type": "users",
"id": "12345678"
}
}
}
},
... // More education itms.
],
"meta": {
"total-count": 7 // Total number of items for this user
}
Single education items
Endpoint: /api/educations/:education_id
Method | Action | Parameters |
---|---|---|
DELETE | Delete education identified by education_id |
N/A |
Add new education
Endpoint: /api/v2/educations
Method | Action | Parameters |
---|---|---|
POST | Add new education. | N/A |
New education is added by issuing a POST
request to the api endpoint /api/v2/educations
.
Here's an example request to post:
{
"data": {
"type": "educations",
"attributes": {
"title": "MSc",
"institution": "University of Tampere",
"field": "Interactive Technology",
"description": "Studying computer science and media.",
"start-year": "2001",
"end-year": "2007",
"created-at": "Tue, 16 May 2017 15:08:46 +0300",
"updated-at": "Tue, 16 May 2017 15:08:46 +0300"
},
"relationships": {
"user": { // This defines the user whose work experience this is.
"data": {
"type": "users",
"id": "12345678"
}
}
}
}
}
The API endpoint will return a 201 Created
response with all the data for the newly created item.