Spaces

Space Management

The space endpoints allow you to manage the physical areas of the establishment.

• GET /spaces: Gets all the spaces of the establishment.

  • Authorization: Requires a valid access token (sent automatically via cookies)
  • cURL Example:

  curl -X GET "http://127.0.0.1:9154/spaces" \
    -H "Cookie: accessToken=$ACCESS_TOKEN" \
    -H "Cookie: refreshToken=$REFRESH_TOKEN"

  • Response Body (Success - 200 OK):

  [
    {
      "id": "9214936c-0d95-4101-97ac-a2f04e4929bd",
      "name": "Terrace"
    },
    {
      "id": "9008646f-b24b-4e14-9c4a-00cec2d124da", 
      "name": "Main Hall"
    }
  ]

  • Response Body (No Content - 204 No Content):

  "No spaces found"

• GET /spaces/{id}: Gets a specific space by its ID.

  • Authorization: Requires a valid access token (sent automatically via cookies)
  • Path Parameters:
    • id (string): ID of the space to get
  • cURL Example:

  curl -X GET "http://127.0.0.1:9154/spaces/34fe7489-74e9-4e7a-968a-66cd0cdc00d7" \
    -H "Cookie: accessToken=$ACCESS_TOKEN" \
    -H "Cookie: refreshToken=$REFRESH_TOKEN"

  • Response Body (Success - 200 OK):

  {
    "id": "34fe7489-74e9-4e7a-968a-66cd0cdc00d7",
    "name": "Terrace"
  }

• POST /spaces: Creates a new space.

  • Authorization: Requires a valid access token (sent automatically via cookies)
  • Request Body:

  {
    "name": "string"
  }

  • cURL Example:

  curl -X POST "http://127.0.0.1:9154/spaces" \
    -H "Cookie: accessToken=$ACCESS_TOKEN" \
    -H "Cookie: refreshToken=$REFRESH_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Outdoor Garden"
    }'

  • Response Body (Success - 201 Created):

  {
    "id": "cadd2c99-3a87-4fb6-802d-9a57b4c05ba5",
    "message": "Space added successfully"
  }

• PUT /spaces/{id}: Updates an existing space.

  • Authorization: Requires a valid access token (sent automatically via cookies)
  • Path Parameters:
    • id (string): ID of the space to update
  • Request Body:

  {
    "name": "string"
  }

  • cURL Example:

  curl -X PUT "http://127.0.0.1:9154/spaces/9008646f-b24b-4e14-9c4a-00cec2d124da" \
    -H "Cookie: accessToken=$ACCESS_TOKEN" \
    -H "Cookie: refreshToken=$REFRESH_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{
      "name": "Renovated Terrace"
    }'

  • Response Body (Success - 200 OK):

  {
    "id": "9008646f-b24b-4e14-9c4a-00cec2d124da",
    "message": "Space updated successfully"
  }

• DELETE /spaces/{id}: Deletes a space from the system.

  • Authorization: Requires a valid access token (sent automatically via cookies)
  • Path Parameters:
    • id (string): ID of the space to delete
  • cURL Example:

  curl -X DELETE "http://127.0.0.1:9154/spaces/9008646f-b24b-4e14-9c4a-00cec2d124da" \
    -H "Cookie: accessToken=$ACCESS_TOKEN" \
    -H "Cookie: refreshToken=$REFRESH_TOKEN"

  • Response Body (Success - 200 OK):

  {
    "id": "9008646f-b24b-4e14-9c4a-00cec2d124da",
    "message": "Space deleted successfully"
  }

Important notes:

• All space endpoints require authentication.
• Space IDs are automatically generated UUIDs.
• A space can contain multiple tables.
• You cannot delete a space that has associated tables.