User Endpoints - ShengHuaWu/cv-soar GitHub Wiki

Get user info

method: GET

path: /users/:id

success response example:

{
    "user": {
        "last_name": "Wu",
        "email": "[email protected]",
        "id": "1",
        "first_name": "ShengHua",
        "token": "0987654321",
        "educations": [
            {
                "id": 1,
                "school": "NCTU",
                "description": "",
                "links": "",
                "user_id": 1,
                "start_date": "2011-09-01T00:00:00.000Z",
                "degree": "Master of Science",
                "end_date": "2012-06-01T00:00:00.000Z"
            }
        ],
        "avatar": "",
        "skills": [
            {
                "id": "1",
                "title": "Objective-C",
                "user_id": 1
            },
            {
                "id": "2",
                "title": "Swift",
                "user_id": 1
            }
        ],
        "experiences": [
            {
                "location": "Berlin, Germany",
                "id": "1",
                "description": "",
                "title": "iOS Developer",
                "links": "",
                "user_id": 1,
                "company": "Conichi",
                "start_date": "2017-09-17T00:00:00.000Z",
                "end_date": null
            }
        ]
    }
}

Update user info

method: PATCH

path: /users/:id

parameters:

last_name: String
first_name: String
email: String
password: String

parameters example:

{
    "last_name": "Wu",
    "first_name": "ShengHua",
    "email": "[email protected]",
    "password": "my_password"
}

success response example:

{
    "user": {
        "id": 1,
        "last_name": "Wu",
        "first_name": "ShengHua",
        "email": "[email protected]",
        "avatar": "",
        "token": "tgb456rfv829"
    }
}

Update user avatar

method: POST

path: /users/:id/avatar

parameters:

avatar: data
extension: String

• All parameters are required.

parameters example:

{
    "avatar": my_avatar_file,
    "extension": "png"
}

success response example:

{
    "user": {
        "id": 1,
        "last_name": "Wu",
        "first_name": "ShengHua",
        "email": "[email protected]",
        "avatar": "0987654321",
        "token": "tgb456rfv829"
    }
}