Viewer

Interact with active 3D viewer sessions. Get and set the current selection in the Qonic viewer.

GET https://api.qonic.com/v1/viewer/get-active-selection

Get active selection

Returns the currently selected products in the user's running Qonic app. The X-Client-Session-Id header is required — use GET /v1/sessions to list running sessions and obtain a valid session ID.

Response fields

  • Name
    productIds
    Type
    array<object>
    Required
    Optional
    Description

Error responses

  • Name
    401
    Type
    error
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.
  • Name
    403
    Type
    error
    Description
    Insufficient permissions for this operation
POST https://api.qonic.com/v1/viewer/set-active-selection

Set active selection

Sets the selected products in the user's running Qonic app. The X-Client-Session-Id header is required — use GET /v1/sessions to list running sessions and obtain a valid session ID.

Request body

  • Name
    productIds
    Type
    array<object>
    Required
    Optional
    Description

Error responses

  • Name
    400
    Type
    error
    Description
    Invalid request parameters or body
  • Name
    401
    Type
    error
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.
  • Name
    403
    Type
    error
    Description
    Insufficient permissions for this operation
GET https://api.qonic.com/v1/viewer/product-profile

Get elevation profile of a product

Returns the elevation profile of a single product currently loaded in the user's running Qonic app, as sampled closed polylines in project coordinates. The X-Client-Session-Id header is required — use GET /v1/sessions to list running sessions and obtain a valid session ID.

Query parameters

  • Name
    modelGuid
    Type
    string
    Required
    Optional
    Description
    GUID of the model containing the product.
  • Name
    productId
    Type
    string
    Required
    Optional
    Description
    Product identifier within the model.

Response fields

  • Name
    outer
    Type
    array<array<number>>
    Required
    Optional
    Description
  • Name
    inner
    Type
    array<array<array<number>>>
    Required
    Optional
    Description

Error responses

  • Name
    401
    Type
    error
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.
  • Name
    403
    Type
    error
    Description
    Insufficient permissions for this operation
POST https://api.qonic.com/v1/viewer/product-profiles

Get elevation profiles of multiple products in a single request

Returns the elevation profile for each product currently loaded in the user's running Qonic app. Each item in the response is independent — per-product extraction failures are reported via the error field rather than a non-2xx HTTP status, so callers can mix successes and failures freely. The X-Client-Session-Id header is required — use GET /v1/sessions to list running sessions and obtain a valid session ID. Up to 50 products per request. Duplicate (modelGuid, productId) pairs are deduped before being forwarded to the viewer.

Request body

  • Name
    products
    Type
    array<object>
    Required
    Optional
    Description

Response fields

  • Name
    profiles
    Type
    array<object>
    Required
    Optional
    Description

Error responses

  • Name
    400
    Type
    error
    Description
    Invalid request parameters or body
  • Name
    401
    Type
    error
    Description
    Authentication required. Provide a valid Bearer token in the Authorization header.
  • Name
    403
    Type
    error
    Description
    Insufficient permissions for this operation
‹
Previous
Types