Actions69
- Item Actions
- Occurrence Actions
- Other Resource Actions
- Report Actions
- Room Actions
- Room Group Actions
- Room Template Actions
Room → Get
AI-generatedSummary
Retrieve detailed information about a specific Room identified by its numeric Room ID from the dRofus API.
Inputs
- Room ID (required) — The numeric primary key of the room to retrieve (corresponds to rooms.{ID} in the dRofus API). Must be an integer greater than or equal to 1.
- Filter Mode — Determines how to build the optional OData $filter query parameter, with options to not send a filter, build one via a typed filter builder, or specify a raw OData filter expression.
- Filter Builder — Configures a structured, typed filter with combinators, conditions, and sub-groups; used only if Filter Mode is 'Builder'.
- Filter (Raw OData) — Directly specify a raw OData $filter expression string; used only if Filter Mode is 'Raw'.
- Query Parameters — Additional query options including JSON extra parameters, order by clause, page size, select fields, and number of rows to skip; applies standard OData and endpoint-specific parameters.
Output shape
a single record representing the Room with the specified Room ID, including the fields returned by the API based on the select parameter and default fields
If filters are used, they refine the returned data; pagination parameters control data returned but are ignored if 'Return All' option is enabled. The output data structure matches the dRofus Room resource schema. Errors occur if the Room ID is invalid or not found.
Examples
Example 1: Retrieve Room with ID 123
Set Room ID to 123, leave Filter Mode as 'None', optionally specify select fields or other query parameters to refine output.