API Reference

User

Register New User
URL: 138.197.83.143:3000/user/register
URL Parameters: None
Request Type: POST
Authentication Required: No
JSON Object Sent: { "name": "", "birthday": "<MM/DD/YYYY>", "username": "", "password": "", "email": "" }

Authenticate User
URL: 138.197.83.143:3000/user/authenticate
URL Parameters: None
Request Type: POST
Authentication Required: No
JSON Object Sent: { "username": "", "password": "" }

User Profile
URL: 138.197.83.143:3000/user/profile
URL Parameters: None
Request Type: GET
Authentication Required: Yes
JSON Object Sent: None

Home

List User’s Homes
URL: 138.197.83.143:3000/home/list
URL Parameters: None
Request Type: GET
Authentication Required: YES
JSON Object Sent: None

Detail Specific Home
URL: 138.197.83.143:3000/home/detail
URL Parameters: homeId
Request Type: GET
Authentication Required: Yes
JSON Object Sent: None

Create Home
URL: 138.197.83.143:3000/home/create
URL Parameters: None
Request Type: POST
Authentication Required: Yes
JSON Object Sent: { "name": "", "address": "<address" }

Update Home
URL: 138.197.83.143:3000/home/update
URL Parameters: homeId
Request Type: PUT
Authentication Required: Yes
JSON Object Sent: { "name": "", "address": "<address" }

Delete Home
URL: 138.197.83.143:3000/home/delete
URL Parameters: homeId
Request Type: DELETE
Authentication Required: Yes
JSON Object Sent: None

Add Module To Home
URL: 138.197.83.143:3000/home/addModule
URL Parameters: homeId
Request Type: POST
Authentication Required: Yes
JSON Object Sent: { "name": "", "location": "", "serial": "" }

Delete Home’s Module
URL: 138.197.83.143:3000/home/deleteModule
URL Parameters: homeId, moduleId
Request Type: DELETE
Authentication Required: Yes
JSON Object Sent: None