Skip to content

Appointment

Appointment

Data type: Entity

An Appointment is an arrangement to do something or meet someone at a particular time, at a place (for face to face appointment) or in a contact medium (for phone appointment).

Name Type Description Example
@type (1) string When sub-classing, this defines the sub-class Extensible name
validFor (1) TimePeriod
@baseType string When sub-classing, this defines the super-class
@schemaLocation string A URI to a JSON-Schema file that defines additional attributes and relationships
id string Unique identifier 2d7ed5fd-9f62-4211-bc84-357f5f7b80f5
href URI Hyperlink reference https://api.example.org/resource/id
category string Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,... intervention
creationDate DateTime Appointment creation date 2023-01-01T08:00+01:00
description string Short free text describing the appointment Lorem ipsum dolor
externalId string External reference known by the customer 1234
lastUpdate DateTime Date of last appointment update 2023-01-01T08:00+01:00
attachment AttachmentRefOrValue [n..m] Attachment []
contactMedium ContactMedium [n..m] Contact medium []
note Note [n..m] Note []
relatedParty RelatedPartyOrPartyRole [n..m] Related party []
relatedPlace RelatedPlaceRefOrValue
status AppointmentStateType