-
Notifications
You must be signed in to change notification settings - Fork 0
Personal Endpoint
Roberto Martinez edited this page Dec 13, 2021
·
6 revisions
Contains information about my personal life such as my full name, email, contact links, skills, interests and a brief description about me.
-
GET/personal/info --> Retrieves the main details about me: full name, email and description -
PUT/personal/info --> Updates the main details about me (should only be the description)
Sample API Response
{
"firstName": "Roberto",
"lastName": "Martinez",
"email": "robertomiguel2001@gmail.com",
"description": "I am a sophomore at ...",
}-
GET/personal/interests --> Retrieves my favorite topic of interests. -
GET/personal/interests/{ interestId } --> Retrieves one of my many topic of interests. -
PATCH/personal/interests/{ interestId } --> Updates the specific topic of interest and/or image
Sample API Response
"interests": [
{
"id": 1,
"topic": "AI",
"image": "<link_to_image>"
},
{
"id": 2,
"topic": "Innovation",
"image": "<link_to_image>"
},
{
"id": 3,
"topic": "Blockchain",
"image": "<link_to_image>"
},
{
"id": 4,
"topic": "Venture Capital",
"image": "<link_to_image>"
}
],-
GET/personal/skills --> Retrieves all of my technical skills. -
GET/personal/skills/{ skillId } --> Retrieves one of my many technical skills. -
POST/personal/skills --> Creates a new technical skill. -
DELETE**/personal/skills/{ skillId } --> Deletes a specific technical skill
Sample API Response
"skills": [
{
"id": 1,
"topic": "Python",
"image": "<link_to_image>"
},
{
"id": 2,
"topic": "C",
"image": "<link_to_image>"
},
{
"id": 3,
"topic": "Javascript",
"image": "<link_to_image>"
}
],-
GET/personal/contact --> Retrieves all my points of communication. -
GET/personal/contact/{ contactId } --> Retrieves a specific point of communication. -
POST/personal/contact --> Creates a new point of communication.
Sample API Response
"contact": [
{
"id": 1,
"title": "Twitter",
"link": "<link_to_social>"
},
{
"id": 2,
"title": "Github",
"link": "<link_to_social>"
},
{
"id": 3,
"title": "LinkedIn",
"link": "<link_to_social>"
}
]| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
{ interestId } |
integer |
required | The value for the Interest object you want to look up. |
{ skillId } |
integer |
required | The value for the skill of type Thing you want to look up. |
{ interestId } |
integer |
required | The value for the Interest object you want to look up. |
{ contactId } |
integer |
required | The value for the Contact object you want to look up. |
personal/info
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
firstName |
string |
optional | The first name of the person in the Person object. |
lastName |
string |
optional | The last name of the person in the Person object. |
email |
string |
optional | The email of the person in the Person object. |
description |
string |
required | A brief description of the person in the Person object. |
personal/interests
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
{ interestId } |
integer |
optional | The value for the interest object you want to look up. |
topic |
string |
optional | The name of the specific interest in the type Thing in the interest property. |
image |
string |
optional | The image of the specific interest in the type Thing in the interest property. |
personal/skills
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
{ skillId } |
integer |
optional | The value for the skill object you want to look up. |
topic |
string |
optional | The name of the specific skill in the type Thing in the skill property. |
image |
string |
optional | The image of the specific skill/technology in the type Thing in the skill property. |
personal/contact
| Parameter | Required/Optional | Description | Type |
|---|---|---|---|
{ contactId } |
integer |
optional | The value for the contact object you want to look up. |
title |
string |
optional | The title of the social media application in the type Social in the contact property. |
image |
string |
optional | The image of the specific interest in the type Thing in the contact property. |