Skip to content

AppointmentApi

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

Method HTTP request Description
createAppointment POST /appointment Creates a Appointment
listAppointment GET /appointment List or find Appointment objects
retrieveAppointment GET /appointment/{id} Retrieves a Appointment by ID

createAppointment

Appointment createAppointment(Appointment_FVO, fields)

Creates a Appointment

This operation creates a Appointment entity.

Parameters

Name Type Description Notes
Appointment_FVO Appointment_FVO The Appointment to be created
fields String Comma-separated properties to be provided in response [optional] [default to null]

Return type

Appointment

Authorization

No authorization required

HTTP request headers

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

listAppointment

List listAppointment(fields, offset, limit)

List or find Appointment objects

This operation list or find Appointment entities

Parameters

Name Type Description Notes
fields String Comma-separated properties to be provided in response [optional] [default to null]
offset Integer Requested index for start of resources to be provided in response [optional] [default to null]
limit Integer Requested number of resources to be provided in response [optional] [default to null]

Return type

List of Appointment

Authorization

No authorization required

HTTP request headers

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

retrieveAppointment

Appointment retrieveAppointment(id, fields)

Retrieves a Appointment by ID

This operation retrieves a Appointment entity. Attribute selection is enabled for all first level attributes.

Parameters

Name Type Description Notes
id String Identifier of the API Resource [default to null]
fields String Comma-separated properties to be provided in response [optional] [default to null]

Return type

Appointment

Authorization

No authorization required

HTTP request headers

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