Corrigo: Wo visit check in (Wo Visit Check In Command)

Corrigo commands.woVisitCheckIn: arguments, response, policy and SDK examples.

Operation corrigo.cmd_wovisitcheckincommand

Provider route: POST /v1/cmd/WoVisitCheckInCommand. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/corrigo with npm, or alter-sdk-corrigo with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { CorrigoIntegration } from "@alter-ai/corrigo";

async function execute(input: Parameters<CorrigoIntegration["commands"]["woVisitCheckIn"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new CorrigoIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.commands.woVisitCheckIn(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_corrigo import CorrigoIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = CorrigoIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.commands.wo_visit_check_in(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
`$`	object	Root	Additional keys: not allowed
`body`	object	Required within parent	Additional keys: not allowed
`body.requestId`	JSON	Optional
`body.requestId (anyOf 1)`	string	Alternative
`body.requestId (anyOf 2)`	null	Alternative
`body.command`	Model	Required within parent	Expand Wo visit check in (Wo Visit Check In Command) — request body — body command

Referenced models: Wo visit check in (Wo Visit Check In Command) — request body — body command

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

Schemas

Wo visit check in (Wo Visit Check In Command) — request body — body command

Field	Type	Presence	Description and constraints
`$`	object	Root
`dtWhen`	string	Optional	Format: date-time
`otherComments`	JSON	Optional
`otherComments (anyOf 1)`	string	Alternative
`otherComments (anyOf 2)`	null	Alternative
`services`	JSON	Optional
`services (anyOf 1)`	array	Alternative
`services (anyOf 1)[]`	integer	Each item	Format: int32
`services (anyOf 2)`	null	Alternative
`workOrderId`	integer	Optional	Format: int32
`iLatitude`	number	Optional	Format: double
`iLongitude`	number	Optional	Format: double
`iPhone`	JSON	Optional
`iPhone (anyOf 1)`	string	Alternative
`iPhone (anyOf 2)`	null	Alternative
`iValidated`	boolean	Optional
`iWeather`	JSON	Optional
`iWeather (anyOf 1)`	string	Alternative
`iWeather (anyOf 2)`	null	Alternative

Policy, approvals and errors

SDK function policy ID: corrigo.cmd_wovisitcheckincommand. Catalog operation: cmd.WoVisitCheckInCommand. 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.

Official provider source

Report an issue with this page