Zoho: Get Kiosk Associations
Zoho kiosksGetRecords.getKioskAssociations: arguments, response, policy and SDK examples.
← Kiosks get records operations · Get started
Operation zoho.getkioskassociations
Provider route: GET /crm/v8/settings/kiosks/{kioskId}/associations. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/zoho with npm, or alter-sdk-zoho with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { ZohoIntegration } from "@alter-ai/zoho";
async function execute(input: Parameters<ZohoIntegration["kiosksGetRecords"]["getKioskAssociations"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new ZohoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.kiosksGetRecords.getKioskAssociations(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_zoho import ZohoIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = ZohoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.kiosks_get_records.get_kiosk_associations(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.kioskId | string | Required within parent | Maximum length: 255 |
query | object | Optional | Additional keys: not allowed |
query.include_inner_details | string | Optional | Maximum length: 500 |
query.include | string | Optional | Maximum length: 255 |
query.module | string | Optional | Maximum length: 255 |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get Kiosk Associations — response body |
Referenced models: Get Kiosk Associations — response body
Schemas
Section titled “Schemas”Get Kiosk Associations — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing kiosk association information including detail view page associations. Additional keys: not allowed |
kiosks | array | Required within parent | Array of kiosk association data. Maximum items: 1 |
kiosks[] | Model | Each item | Expand Get Kiosk Associations — response body — kiosks item |
Referenced models: Get Kiosk Associations — response body — kiosks item
Get Kiosk Associations — response body — kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Kiosk item with its association information. Additional keys: not allowed |
_associations | array | Required within parent | List of associations for this kiosk. Maximum items: 50 |
_associations[] | Model | Each item | Expand Get Kiosk Associations — response body — kiosks item associations item |
id | string | Required within parent | Kiosk identifier. Maximum length: 255 |
Referenced models: Get Kiosk Associations — response body — kiosks item associations item
Get Kiosk Associations — response body — kiosks item associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Kiosk association entry for detail view pages. Additional keys: not allowed |
detail_view_page | array | Required within parent | Detail view page configurations. Maximum items: 50 |
detail_view_page[] | Model | Each item | Expand Get Kiosk Associations — response body — kiosks item associations item detail view page item |
resources | null | Required within parent | Resources field (null for detail_view_page type). |
type | string | Required within parent | Type of association. Maximum length: 255 |
Referenced models: Get Kiosk Associations — response body — kiosks item associations item detail view page item
Get Kiosk Associations — response body — kiosks item associations item detail view page item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Detail view page information. Additional keys: not allowed |
id | string | Required within parent | Unique identifier. Maximum length: 255 |
name | string | Required within parent | Name of the detail view page association. Maximum length: 255 |
sequence_number | JSON | Required within parent | |
sequence_number (anyOf 1) | integer | Alternative | Display sequence number. Format: int32 |
sequence_number (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getkioskassociations. Catalog operation: getKioskAssociations. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.