Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SetJobAppointment

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 with the supplied appointment_date — moving the job to appointment_confirmed, or, when appointmentConfirmed is false, writing the date while leaving the status where it is.

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

Hierarchy

Index

Constructors

Properties

Constructors

constructor

Properties

_cid

_cid: string

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

Optional _metadata

_metadata?: {}

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

Type declaration

  • [key: string]: string

_type

_type: CommandName

The command type

_v

_v: string

Command format version / API version

Optional appointmentConfirmed

appointmentConfirmed?: boolean

Is this slot committed, or only planned?

S4C's dispatch system (FLS) plans a slot at "Bestätigt" — real, but still movable — and commits it at "Fixiert". Only a committed slot should move the job to appointment_confirmed and fire the confirmation side effects.

Omitted means committed. Every sender before this field existed meant "confirmed", and the backfill scripts still do, so absent must keep the original behaviour. The FLS-status → boolean mapping stays in the Dynamics flow: GID should not learn FLS picklist codes.

Optional appointmentEnd

appointmentEnd?: string

appointmentStart

appointmentStart: string

Optional gidOrderNumber

gidOrderNumber?: string

Optional invoicingEid

invoicingEid?: string

Optional jobApiId

jobApiId?: string

Optional yourOrderID

yourOrderID?: string

Generated using TypeDoc