Zoho: Kiosk Associations — kiosks Get Records get All Kiosks Associations
Zoho kiosksGetRecords.getAllKiosksAssociations: arguments, response, policy and SDK examples.
← Kiosks get records operations · Get started
Operation zoho.getallkiosksassociations
Provider route: GET /crm/v8/settings/kiosks/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"]["getAllKiosksAssociations"]>[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.getAllKiosksAssociations(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_all_kiosks_associations(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.include_inner_details | string | Optional | Maximum length: 500 |
query.module | string | Optional | Maximum length: 255 |
query.include | 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 |
|---|---|---|---|
$ | JSON | Root | |
$ (anyOf 1) | Model | Alternative | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks |
$ (anyOf 2) | null | Alternative |
Referenced models: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks
Schemas
Section titled “Schemas”Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Response containing association information for all kiosks. Additional keys: not allowed |
kiosks | array | Required within parent | Array of kiosk association data. Maximum items: 200 |
kiosks[] | Model | Each item | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item |
Referenced models: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Kiosk item with its detail view page 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 Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item |
id | string | Required within parent | Kiosk identifier. Maximum length: 255 |
Referenced models: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Kiosk association entry including detail view page configurations with layout and module details. 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 Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks 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: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Detail view page information with layout and module details. Additional keys: not allowed |
id | string | Required within parent | Unique identifier. Maximum length: 255 |
layout | Model | Required within parent | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item layout Layout associated with this detail view page. |
module | Model | Required within parent | Expand Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item module Module associated with this detail view page. |
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]+)?$ |
Referenced models: Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item layout, Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item module
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item layout
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Layout details in association responses. Additional keys: not allowed |
id | string | Required within parent | Unique identifier of the layout. Maximum length: 19 |
name | string | Required within parent | Name of the layout. Maximum length: 255 |
status | string | Required within parent | Status of the layout. Maximum length: 50 |
Kiosk Associations — kiosks Get Records get All Kiosks Associations — response body — kiosks kiosks item associations item detail view page item module
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Module details in association responses. Additional keys: not allowed |
api_name | string | Required within parent | API name of the module. Maximum length: 50 |
display_label | string | Required within parent | Display label of the module. Maximum length: 255 |
id | string | Required within parent | Unique identifier of the module. Maximum length: 19 |
name | string | Required within parent | Name of the module. Maximum length: 50 |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: zoho.getallkiosksassociations. Catalog operation: getAllKiosksAssociations. 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.
No-content response statuses: [204]