Skip to content

Users

GET /user/USERID/

Returns the basic user information stored for the user with the id USERID.

Response format:

{
    "id": "github09829234",
    "username": "ExampleUsername",
    "firstName": "ExampleFirstName",
    "lastName": "ExampleLastName",
    "email": "[email protected]"
}

GET /user/

Returns the basic user information stored for the user associated with the id in the given JWT in the Authorization header.

Response format:

{
    "id": "github09829234",
    "username": "ExampleUsername",
    "firstName": "ExampleFirstName",
    "lastName": "ExampleLastName",
    "email": "[email protected]"
}

POST /user/

Sets the basic user information for the user as specified in the id field of the request. The information recorded in the database is returned in the response.

Request format:

{
    "id": "github000001",
    "username": "test",
    "firstName": "ExampleFirstName",
    "lastName": "ExampleLastName",
    "email": "[email protected]"
}

Response format:

{
    "id": "github000001",
    "username": "test",
    "firstName": "ExampleFirstName",
    "lastName": "ExampleLastName",
    "email": "[email protected]"
}

GET /user/filter/?key=value

Returns the basic user information, filtered with the given key-value pairs.

Response format:

{
    "users": [
        {
            "id": "github09829234",
            "username": "ExampleUsername",
            "firstName": "ExampleFirstName",
            "lastName": "ExampleLastName",
            "email": "[email protected]"
        },
        {
            "id": "github09829235",
            "username": "ExampleUsername2",
            "firstName": "ExampleFirstName2",
            "lastName": "ExampleLastName2",
            "email": "[email protected]"
        }
    ]
}

GET /user/qr/

Get the string to be embedded in the current user's QR code. The QR code string will contain information stored in the form of a URI.

Response format:

{
    "id": "github0000001",
    "qrInfo": "hackillinois://user?userid=github0000001"
}

GET /user/qr/{id}/

Get the string to be embedded in the specified user's QR code. The QR code string will contain information stored in the form of a URI.

Response format:

{
    "id": "github0000001",
    "qrInfo": "hackillinois://user?userid=github0000001"
}