dRofus icon

dRofus

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

Actions69

Room Template → Get Template Occurrences

AI-generated

Summary

Retrieve occurrences of a specified room template from dRofus with optional OData filtering, sorting, pagination, and selection of fields.

Inputs

  • Template ID (required) — Numeric primary key of the room template to fetch occurrences for (roomtemplates.{ID} in the dRofus API)
  • Return All — Whether to return all matching occurrences or limit to a specified count
  • Limit — Maximum number of occurrences to return if Return All is false
  • Filter Mode — Method to construct the OData $filter query parameter: None, Builder (structured filter), or Raw (custom OData expression)
  • Filter Builder — Structured filter conditions to build the OData $filter parameter when Filter Mode is Builder
  • Filter (Raw OData) — Raw OData $filter expression string when Filter Mode is Raw
  • Query Parameters — Additional OData query parameters such as select fields, order by, skip, top, and extra JSON parameters for API extensions

Output shape

a list of room template occurrence objects

Supports pagination using $top, $skip, and can return all results via multiple requests if 'Return All' is true. Returned fields can be restricted with the 'select' query parameter. The data items represent occurrences where the specified room template is used.

Links

Discussion