Skip to content

NotificationListenersClientSideApi

All URIs are relative to https://api.example.com/tmf-api/appointmentManagement/v5

Method HTTP request Description
listenToAppointmentAttributeValueChangeEvent POST /listener/appointmentAttributeValueChangeEvent Client listener for entity AppointmentAttributeValueChangeEvent
listenToAppointmentCreateEvent POST /listener/appointmentCreateEvent Client listener for entity AppointmentCreateEvent
listenToAppointmentDeleteEvent POST /listener/appointmentDeleteEvent Client listener for entity AppointmentDeleteEvent
listenToAppointmentStateChangeEvent POST /listener/appointmentStateChangeEvent Client listener for entity AppointmentStateChangeEvent
listenToSearchTimeSlotAttributeValueChangeEvent POST /listener/searchTimeSlotAttributeValueChangeEvent Client listener for entity SearchTimeSlotAttributeValueChangeEvent
listenToSearchTimeSlotStateChangeEvent POST /listener/searchTimeSlotStateChangeEvent Client listener for entity SearchTimeSlotStateChangeEvent

listenToAppointmentAttributeValueChangeEvent

listenToAppointmentAttributeValueChangeEvent(AppointmentAttributeValueChangeEvent)

Client listener for entity AppointmentAttributeValueChangeEvent

Example of a client listener for receiving the notification AppointmentAttributeValueChangeEvent

Parameters

Name Type Description Notes
AppointmentAttributeValueChangeEvent AppointmentAttributeValueChangeEvent Appointment attributeValueChange Event payload

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listenToAppointmentCreateEvent

listenToAppointmentCreateEvent(AppointmentCreateEvent)

Client listener for entity AppointmentCreateEvent

Example of a client listener for receiving the notification AppointmentCreateEvent

Parameters

Name Type Description Notes
AppointmentCreateEvent AppointmentCreateEvent Appointment Create Event payload

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listenToAppointmentDeleteEvent

listenToAppointmentDeleteEvent(AppointmentDeleteEvent)

Client listener for entity AppointmentDeleteEvent

Example of a client listener for receiving the notification AppointmentDeleteEvent

Parameters

Name Type Description Notes
AppointmentDeleteEvent AppointmentDeleteEvent Appointment delete Event payload

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listenToAppointmentStateChangeEvent

listenToAppointmentStateChangeEvent(AppointmentStateChangeEvent)

Client listener for entity AppointmentStateChangeEvent

Example of a client listener for receiving the notification AppointmentStateChangeEvent

Parameters

Name Type Description Notes
AppointmentStateChangeEvent AppointmentStateChangeEvent Appointment stateChange Event payload

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listenToSearchTimeSlotAttributeValueChangeEvent

listenToSearchTimeSlotAttributeValueChangeEvent(SearchTimeSlotAttributeValueChangeEvent)

Client listener for entity SearchTimeSlotAttributeValueChangeEvent

Example of a client listener for receiving the notification SearchTimeSlotAttributeValueChangeEvent

Parameters

Name Type Description Notes
SearchTimeSlotAttributeValueChangeEvent SearchTimeSlotAttributeValueChangeEvent Appointment attributeValueChange Event payload

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listenToSearchTimeSlotStateChangeEvent

listenToSearchTimeSlotStateChangeEvent(SearchTimeSlotStateChangeEvent)

Client listener for entity SearchTimeSlotStateChangeEvent

Example of a client listener for receiving the notification SearchTimeSlotStateChangeEvent

Parameters

Name Type Description Notes
SearchTimeSlotStateChangeEvent SearchTimeSlotStateChangeEvent SearchTimeSlot stateChange Event payload

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json