Skip to main content

iGUIDE Types

iGUIDE create input

PropertyTypeDescription
industry
(mandatory)
stringA string indicating the Property Industry of iGUIDE to be created.

Accepted Values:
  • residential - Residential Real Estate iGUIDE
  • commercial - Commercial Real Estate iGUIDE
  • irc - Insurance & Restoration iGUIDE
  • aec - Architecture, Engineering & Construction iGUIDE

Learn more about Property Industries
type
(mandatory)
stringA string indicating the type of iGUIDE to be created.

Accepted Values:
Learn more about Packages
editors[]stringA list of user IDs to be added as editors to the created iGUIDE.
primaryContactstringA user ID to be assigned as the primary contact to the created iGUIDE.
reportSubscribers[]stringA list of email addresses to be subscribed to the iGUIDE’s report.
webhooks[]WebhookA list of webhooks to be added to the iGUIDE.

See Webhooks
   
address
(mandatory)
AddressThe iGUIDE address
defaultViewViewParamsParameters for the Default View
skipPrepublishboolThis option is only applicable for draftable iGUIDE types such as standard or premium. When set to true, the iGUIDE will be published even if the Drafting team chooses to pre-publish it.
applyDefaultsboolEnabling this field will apply user-defined presets in following order
  1. Apply the current iGUIDE Defaults of the operator.
  2. Apply Banner Settings when a banner ID is provided in ViewParams
Key Guidelines
  • Any values specified in the payload of this request will override the applied settings, except for array fields where new values will be appended to existing ones.
  • For add-ons, applied settings values will not be included and must be manually set in the request payload.
  • For operator sub-accounts without iGUIDE defaults, the root account's iGUIDE default settings will be applied.
addons
(obsolete)
[]stringObsolete: add-ons are automatically activated upon work order requests

A list of paid addons to be purchased for the iGUIDE upon creation.

Accepted values:
  • vr - iGUIDE VR add-on (included in Premium iGUIDE),
  • advmeas - Advanced Measurement add-on (included in Premium iGUIDE),
  • floorplanner - Floorplanner add-on,
  • streetview - Google Street View add-on,
  • esx - Xactimate ESX add-on,

Work order create input

PropertyTypeDescription
types
(mandatory)
[]stringAn array of strings specifying the types of work to be performed. Available task types depend on the iGUIDE package type.

Available task types by iGUIDE package:
  • iGUIDE Standard:
    • premium-upgrade - Upgrade to iGUIDE Premium package
    • draft-update - Update drafted iGUIDE data
    • produce-xactimate-esx: Obsolete: use esx-init instead. Request ESX add-on for Xactimate integration
    • esx-init - Request ESX add-on for Xactimate integration Learn more
    • dwg-init - Request CAD Floor Plan add-on Learn more
      Required: units attribute must be specified containing metric or imperial option
    • corelogic-fml (Beta): Request Corelogic FML add-on
    • siteplan - Request a Site Plan Learn more. If the initial work order is still pending, the siteplan task is appended to it instead of creating a new work order. Cannot be requested while an existing siteplan work order is pending.
  • iGUIDE Premium:
    • All tasks supported by Standard iGUIDE (except premium-upgrade)
    • rvt-init - Request 3D Model add-on Learn more
      Required: units attribute must be specified containing metric or imperial option. Optional: output attribute containing dwg or rvt
    • rvt-dwg-floor-plans: Can be combined with rvt-init to request CAD Floor Plan along with the 3D Model. This is similar to dwg-init.
      Download deliverables using the iGUIDE download endpoint.
    • ads-pdf-reflected-ceiling - Request Reflected Ceiling Plans add-on Learn more
      Prerequisite: dwg-init or rvt-init must be requested concurrently or previously
    • dwg-elevation: Request Exterior Elevations add-on Learn more
      Prerequisite: dwg-init or rvt-init must be requested concurrently or previously
    • dwg-roof: Roof Plans Learn more
    • dwg-plotted-pdf: Plotted Drawings (PDF deliverable)
  • iGUIDE Radix:
    • radix-update - Update Stitch Data
    • draft-convert - Upgrade to iGUIDE Standard package
    • draft-premium-convert - Upgrade to iGUIDE Premium package
attrsjsonAdditional attributes for your request. Depends on the task types being requested.
  • units: metric or imperial. Required if requesting dwg-init, dwg-update,rvt-init or rvt-update.
  • output: dwg or rvt. Optional for rvt-init.
skipPrepublishboolThis option is only applicable for draftable upgrade task types such as draft-convert or draft-premium-convert. When set to true, the iGUIDE will be published even if the Drafting team chooses to pre-publish it.
taskType (obsolete)stringObsolete: use types instead.

A string specifying the type of work to be performed.
enableEsxAddon
(obsolete)
boolObsolete: add-ons are automatically enabled upon work order requests
enableFmlAddon
(obsolete)
boolObsolete: add-ons are automatically enabled upon work order requests