Options
All
  • Public
  • Public/Protected
  • All
Menu

Set (or update) the appointment for a specific job. Triggered by S4C via the /v3/commands/s4c/appointment endpoint and consumed in jobs-service, which calls gid-api admin/jobs/set-status to transition the job to appointment_confirmed with the supplied appointment_date.

Exactly one of jobApiId, invoicingEid, gidOrderNumber, or yourOrderID must be provided to identify the target job.

Hierarchy

Index

Constructors

Properties

_cid: string

Command ID. This can be any string, and it's up to the api integrator to ensure uniqueness.

_metadata?: {}

Arbitrary metadata set by the api integrator. Keys must start with 'ext-'

Type declaration

  • [key: string]: string

The command type

_v: string

Command format version / API version

appointmentEnd?: string
appointmentStart: string
gidOrderNumber?: string
invoicingEid?: string
jobApiId?: string
yourOrderID?: string

Generated using TypeDoc