Routes - GhostyJade/Hellocate GitHub Wiki

Routes:

User

  • Registration: POST /api/v1/users

    body:

    {
        "data": {
            "username": ":username",
            "usrPassword": "password"
        }
    }
    
  • Login: POST /api/v1/users/:username

    body:

    {
        "password": ":usrPassword"
    }
    

Ambient

  • Add new ambient: POST /api/v1/ambients/:username

    body:

    {
        "data": {
            "name": "ambientName"
        }
    }
    
  • Get all user's ambients: GET /api/v1/ambients/:username

  • Delete ambient: DELETE /api/v1/ambients/:username

    body:

    {
        "data": {
            "key": "ambientKey"
        }
    }
    
  • Update ambient name: PUT /api/v1/ambients/:username

    body:

    {
        "data": {
            "key": "ambientKey",
            "name": "newname"
        }
    }
    

Room

  • Add new room: POST /api/v1/rooms/:username/

    body:

    {
        "data": {
            "key": "ambientKey",
            "room": {
                "name": "roomName",
                "icon": "iconName"
            }
        }
    }
    
  • Get user's ambients and rooms: GET /api/v1/rooms/:username

  • Delete room: DELETE /api/v1/rooms/:username

    body:

    {
        "data": {
            "ambientKey": "ambientKey",
            "roomKey": "roomKey"
        }
    }
    
  • Update room data: PUT /api/v1/rooms/:username/

    body:

    {
        "data": {
          "ambientKey": "existingAmbientKey",
          "roomKey": "existingRoomKey",
          "room": {
            "name": "newName",
            "icon": "newIconName"
          }
        }
    }
    

Items:

  • Add new Item: POST /api/v1/items/:username body:
    {
        "data": {
            "ambientKey": "existingAmbientKey",
            "roomKey": "existingRoomKey",
            "item": {
                "name": "itemName",
                "description": "itemDescription",
                "color": "#colorValue"
            }
         }
    }
    
    
  • Get Items in a specified Ambient and Room: POST /api/v1/items/:username/list body:
    {
        "data": {
            "ambientKey": "existingAmbientKey",
            "roomKey": "existingRoomKey"
         }
    }