AppointmentRefOrValue

One of

Appointment, AppointmentRef

Appointment reference and value

Field Required Nullable Type Description Constraints Example

@type

Yes

No

String

When sub-classing, this defines the sub-class Extensible name

@baseType

No

No

String

When sub-classing, this defines the super-class

@schemaLocation

No

No

String

A URI to a JSON-Schema file that defines additional attributes and relationships

id

Yes

No

String

Unique identifier

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

No

No

URI

Hyperlink reference

https://api.example.org/resource/id

name

No

No

String

Name of the referred entity.

EntityName

@referredType

No

No

String

The actual type of the target instance when needed for disambiguation.

category

No

No

String

Business category : intervention for example or to be more precise after SalesIntervention, orderDeliveryIntervention,…​

intervention

creationDate

No

No

DateTime

Appointment creation date

2023-01-01T08:00:00+01:00

description

No

No

String

Short free text describing the appointment

Lorem ipsum dolor

externalId

No

No

String

External reference known by the customer

1234

lastUpdate

No

No

DateTime

Date of last appointment update

2023-01-01T08:00:00+01:00

attachment

No

No

array of AttachmentRefOrValue

Attachment

[]

contactMedium

No

No

array of ContactMedium

Contact medium

[]

note

No

No

array of Note

Note

[]

relatedParty

No

No

array of RelatedPartyOrPartyRole

Related party

[]

relatedPlace

No

No

RelatedPlaceRefOrValue

Related place defines (by reference or value) the place where the appointment will take place.

status

No

No

AppointmentStateType

validFor

Yes

No

TimePeriod