Inventory

List rooms containing an inventory item

Retrieves the list of all rooms containing a specific inventory item.

get/inventory/{inventory_id}/rooms

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/inventory/{inventory_id}/rooms
Auth: HTTP bearer

Path parameters

inventory_idstring uuid required

Inventory item ID

Response

Rooms containing the item retrieved successfully

idstring uuid required

Unique identifier of the junction

room_idstring uuid required

Room ID

inventory_idstring uuid required

Inventory item ID

quantity_in_roominteger required

Quantity of the item in this room

location_descriptionstring nullable

Description of the location within the room

position_xnumber nullable

X position in the room (in meters)

position_ynumber nullable

Y position in the room (in meters)

Condition state of an inventory item

condition_notes_in_roomstring nullable

Notes on the condition in this room

placed_datestring date required

Date placed in the room

removed_datestring date nullable

Date removed from the room

is_activeboolean required

Indicates whether the item is currently in this room

notesstring nullable

Notes specific to this room

created_atstring date-time required

Creation date

updated_atstring date-time required

Last modification date

Example response

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "room_id": "550e8400-e29b-41d4-a716-446655440001",
    "inventory_id": "550e8400-e29b-41d4-a716-446655440002",
    "quantity_in_room": 1,
    "location_description": "Near the window",
    "position_x": 2.5,
    "position_y": 1.2,
    "condition_in_room": "GOOD",
    "condition_notes_in_room": "Works well in this room",
    "placed_date": "2024-01-15",
    "is_active": true,
    "notes": "Near the window",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.