Skip to main content

HrWorksSyncMessage

Something worth reporting from a synchronisation run.

type HrWorksSyncMessage {
  code: String!
  employeeName: String
  message: String!
  organizationUnit: String
  residentialParkId: ResidentialParkID
  severity: HrWorksSyncSeverity!
}

Fields​

HrWorksSyncMessage.code ● String! non-null scalar​

A stable machine-readable identifier for why the message was recorded, for example PARK_NOT_LINKED or MISSING_EMAIL.

Deliberately a string rather than an enum: the set of reportable conditions grows as more of the synchronisation is built, and a client that switched exhaustively over an enum would break each time one is added. Treat an unrecognised value as "some other condition" and fall back to message.

HrWorksSyncMessage.employeeName ● String scalar​

The person the message concerns, for display, or null when it concerns no single person.

Falls back to the HR WORKS personnel number where no name was available.

HrWorksSyncMessage.message ● String! non-null scalar​

The message text, in German, for display to administrators. Recorded already translated: the interface renders it as it stands, and the codes above are what a client branches on.

HrWorksSyncMessage.organizationUnit ● String scalar​

The HR WORKS organisation unit the message concerns.

Populated instead of residentialParkId when the unit is linked to no park, since naming the unit is the only way to tell what still needs linking.

HrWorksSyncMessage.residentialParkId ● ResidentialParkID scalar​

The residential park the message concerns, or null when it concerns none.

HrWorksSyncMessage.severity ● HrWorksSyncSeverity! non-null enum​

How much attention the message deserves.

Member Of​

HrWorksSyncRun object ● ResidentialPark object