timothyhollabaugh / resource-website-backend

resource-website/backend

Coded in Rust, manages database manipulation using AJAX requests from frontend.

Dependencies:

• Rouille 3.0.0
• Diesel 1.3.3
• dotenv 0.13.0
• serde 1.0
• serde_json 1.0
• log 0.4
• simplelog

API Calls

GET /users Gets information about every user in the system. Returns a List of Users.

GET /users/{id: u64} Gets information about the user with the given id. Returns a single User.

POST /users Creates a new user. The body of POST should be a valid User. Returns the id of the created user.

POST /users/{id: u64} Updates a given user.

Data Models

Many of the API calls share a common set of data models, represented in JSON format.

User

Property Name	Type	Optional	Description
id	u64	No	The internal id of the user
first_name	String	No	The first name of the user
last_name	String	no	The last name of the user
banner_id	u64	No	The banner id of the user
email	String	Yes	The Rowan email of the user. If the user does not have an email, this will be null of non-existent

{
    "id": 11,
    "first_name": "John"
    "last_name": "Smith",
    "banner_id": 9162xxxxx,
    "email": "[e-mail]"
}

Partial User

Property Name	Type	Optional	Description
first_name	String	Yes	The first name of the user
last_name	String	Yes	The last name of the user
banner_id	u64	Yes	The banner id of the user
email	String	Yes	The Rowan email of the user. If the user does not have an email, this will be null of non-existent

{
    "first_name": "John"
    "last_name": "Smith",
    "banner_id": 9162xxxxx,
    "email": "[e-mail]"
}

List of Users

Property Name	Type	Optional	Description
users	List of Users	No	A list of Users

{
    "users": [
    {
    "first_name": "John"
    "last_name": "Smith",
    "banner_id": 9162xxxxx,
    "email": "[e-mail]"
    },
    {
    "first_name": "Mike"
    "last_name": "Johnson",
    "banner_id": 9162xxxxx,
    "email": "[e-mail]"
    }
    ]
}