Skip to main content

DefaultViewParams

Configuration options for the default view associated with an iGUIDE.

bannerIdstring

A banner ID to be used for this iGUIDE

descriptionstring

A description of the property shown in the Details tab of the iGUIDE Viewer.

expiresAtstring

Expiration date in ISO 8601 (YYYY-MM-DDTHH:mm:ss.SSSZ) format (max 10 years future, min 1 year past) Dates in the past will lock the iGUIDE view.

isProtectedboolean

If set to false, the View will be accessible publicly. Otherwise, the View will be accessible to the authenticated users appearing in the viewer list. The manager and editors always will have viewing access.

measStdstring

Measurement standard: "ansi" or "rms". If not explicitly set, the measurement standard will be set to the System Default (ANSI for US addresses, RMS otherwise).

viewersstring[]

A list of user IDs allowed to access the View when isProtected is set. The manager and editors always will have viewing access.

DefaultViewParams
{
"bannerId": "string",
"description": "string",
"expiresAt": "string",
"isProtected": true,
"measStd": "string",
"viewers": [
"string"
]
}