AppointmentApi

Method Path Operation

POST

/appointment

createAppointment — Creates a Appointment

GET

/appointment

listAppointment — List or find Appointment objects

GET

/appointment/{id}

retrieveAppointment — Retrieves a Appointment by ID

Operations

Appointment

POST /appointment

Operation ID

createAppointment

Creates a Appointment

Description

This operation creates a Appointment entity.

Parameters
Body parameter
Name Description and type Required Default Pattern

AppointmentFVO

The Appointment to be created AppointmentFVO

X
Query parameters
Name Description and type Required Default Pattern

fields

Comma-separated properties to be provided in response

-

null
Authorization

  • OAuth2ClientCredentials

Return type

Appointment

Request content types

  • application/json

Response content types

  • application/json

Responses
Code Message Data type

201

Created

Appointment

400

Bad Request

ErrorMessage

401

Unauthorized

ErrorMessage

403

Forbidden

ErrorMessage

404

Not Found

ErrorMessage

405

Method Not allowed

ErrorMessage

409

Conflict

ErrorMessage

500

Internal Server Error

ErrorMessage

501

Not Implemented

ErrorMessage

503

Service Unavailable

ErrorMessage

GET /appointment

Operation ID

listAppointment

List or find Appointment objects

Description

This operation list or find Appointment entities

Parameters
Query parameters
Name Description and type Required Default Pattern

fields

Comma-separated properties to be provided in response

-

null

offset

Requested index for start of resources to be provided in response

-

null

limit

Requested number of resources to be provided in response

-

null
Authorization

  • OAuth2ClientCredentials

Return type

array[Appointment]

Response content types

  • application/json

Responses
Code Message Data type

200

Success

array of Appointment

400

Bad Request

ErrorMessage

401

Unauthorized

ErrorMessage

403

Forbidden

ErrorMessage

404

Not Found

ErrorMessage

405

Method Not allowed

ErrorMessage

500

Internal Server Error

ErrorMessage

501

Not Implemented

ErrorMessage

503

Service Unavailable

ErrorMessage

GET /appointment/{id}

Operation ID

retrieveAppointment

Retrieves a Appointment by ID

Description

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

Parameters
Path parameters
Name Description and type Required Default Pattern

id

Identifier of the API Resource

X

null
Query parameters
Name Description and type Required Default Pattern

fields

Comma-separated properties to be provided in response

-

null
Authorization

  • OAuth2ClientCredentials

Return type

Appointment

Response content types

  • application/json

Responses
Code Message Data type

200

Success

Appointment

400

Bad Request

ErrorMessage

401

Unauthorized

ErrorMessage

403

Forbidden

ErrorMessage

404

Not Found

ErrorMessage

405

Method Not allowed

ErrorMessage

500

Internal Server Error

ErrorMessage

501

Not Implemented

ErrorMessage

503

Service Unavailable

ErrorMessage