Experience
The Experience endpoint allows you to manage experience records. You can create, update, delete, or retrieve them. Each experience record has fields like organization name, position, description, and start/end dates.
Summary Table
| Method | Endpoint | Requires apikey Header | Requires :id |
|---|---|---|---|
| GET | /api/experience | No | No |
| POST | /api/experience | Yes | No |
| PATCH | /api/experience/:id | Yes | Yes |
| DELETE | /api/experience/:id | Yes | Yes |
Schema
The experience schema includes the following fields:
- organization (String, Required): Name of the organization where the experience took place.
- position (String, Required): The job title or position held.
- startDate (String, Required): The starting date of the experience.
- endDate (String, Optional): The ending date of the experience.
- description (String, Optional): A description or summary of the job role.
Usage
Getting All Experience Records
Endpoint: /api/experience
Method: GET
Description: Retrieves a list of all experience records.
Creating a New Experience Record
Endpoint: /api/experience
Method: POST
Description: Adds a new experience record. Requires the apikey header.
Headers:
apikey: Your API key
Request Body Example:
{
"organization": "SFU Esports Association",
"position": "Graphic Design Club Executive",
"startDate": "2022",
"endDate": "Ongoing",
"description": "Responsible for designing graphics and managing visual content."
}
Updating an Experience Record
Endpoint: /api/experience/:id
Method: PATCH
Description: Updates an existing experience record by its ID. Requires the apikey header.
Headers:
apikey: Your API key
Request Body Example:
{
"organization": "Some Other Organization",
"position": "Senior Designer",
"endDate": "2023",
"description": "Updated responsibilities and role description."
}
Deleting an Experience Record
Endpoint: /api/experience/:id
Method: DELETE
Description: Deletes an existing experience record by its ID. Requires the apikey header.
Headers:
apikey: Your API key