dRofus icon

dRofus

dRofus API: rooms, items, occurrences, room groups, room templates, systems, and RDL PDF reporting

Room Template → Get

AI-generated

Summary

Retrieve detailed information about a specific room template in dRofus by its numeric Template ID, optionally applying OData filters and additional query parameters to refine the returned data.

Inputs

  • Template ID (required) — The numeric primary key identifying the room template to retrieve (corresponding to roomtemplates.{ID} in the dRofus API). Must be a positive integer.
  • Filter Mode — Determines how to construct the OData $filter parameter: 'None' to skip filtering, 'Builder' to create a typed filter from field/operator/value conditions, or 'Raw' to provide a custom OData filter string.
  • Filter Builder — When 'Filter Mode' is 'Builder', defines typed filter conditions and optional sub-groups for fine-grained filtering based on room template fields.
  • Filter (Raw OData) — When 'Filter Mode' is 'Raw', allows specifying a custom OData $filter expression as a string, supporting string literals with single quotes and OData functions.
  • Query Parameters — Optional extra query parameters including Order By ($orderby), Page Size ($top), Select ($select) to limit fields returned, Skip ($skip), and additional JSON parameters for the dRofus endpoint.

Output shape

a single room template record matching the specified Template ID with fields filtered and selected according to provided parameters

The operation returns exactly one room template identified by the required Template ID. The optional OData $filter and other query parameters can refine the fields returned but do not alter the item selected by Template ID. If filters exclude the template, no data will be returned. Pagination parameters are ignored since this is a single-item fetch. The returned data structure corresponds to the room template resource schema in dRofus.

Examples

Example 1: Retrieve room template details by ID without additional filtering

Set Template ID to the desired template's numeric ID; leave Filter Mode as 'None'; omit other optional parameters.

Links

Discussion