GetIoxRefrigerationOptions (...)

Introduction
Lists the refrigeration units IOX modules can be configured with, as one tree: module types, each with its makes, each make with its models, each model with its harnesses.
With no parameters it returns every module that supports refrigeration. Pass moduleType to narrow it to one module, then also make to narrow it to one make, then also model to narrow it to one model and its harnesses. The parameters must be given in that order. The response always has the same shape and only has fewer branches the more is specified. Values are distinct and sorted, and module type, make and model are matched ignoring case and surrounding spaces. Pass a make, model and harness from the tree as ioxModule.refrigeration to ConfigureDevicePeripheral. This method needs no install token and does not touch any device. Errors (error code): InvalidIoxModuleType (unknown module type), InvalidIoxConfiguration (the module has no refrigeration support, a make was given without a module type, a model was given without a make, or the make or model is unknown), UnsupportedApiVersion.
Parameters

apiKey

The API key (user ID) of the authenticated caller, as returned by Authenticate. Send null when authenticating with a Bearer token.

make

Optional. The refrigeration make. Requires moduleType.

model

Optional. The refrigeration model. Requires make.

moduleType

Optional. The module: IOX-COLD, IOX-COLD-RUGGED or IOX-UREADER. IOX-CLAMP has no refrigeration support.

sessionId

The session ID of the authenticated caller, as returned by Authenticate. Send null when authenticating with a Bearer token.
Return value
An ApiIoxRefrigerationOptions: moduleTypes, each with makes, each with models, each with harnesses.
Remarks
With no parameters it returns every module that supports refrigeration. Pass moduleType to narrow it to one module, then also make to narrow it to one make, then also model to narrow it to one model and its harnesses. The parameters must be given in that order. The response always has the same shape and only has fewer branches the more is specified. Values are distinct and sorted, and module type, make and model are matched ignoring case and surrounding spaces. Pass a make, model and harness from the tree as ioxModule.refrigeration to ConfigureDevicePeripheral. This method needs no install token and does not touch any device. Errors (error code): InvalidIoxModuleType (unknown module type), InvalidIoxConfiguration (the module has no refrigeration support, a make was given without a module type, a model was given without a make, or the make or model is unknown), UnsupportedApiVersion.
Code samples

Loading API Runner...