API Reference

Set one or multiple external reservation codes of different types to the product reservation

post
https://{project_url}/webservice/rest-api/{api_interface}/{version}/product-reservations/actions/set-product-reservation-external-codes

Set one or multiple external reservation codes of different types to the product reservation.
The method will set all the reservation codes from the request.
If a reservation code type already exists in the reservation, it will be replaced with a new value from the request. If the request does not contain the reservation code type already in the reservation, CareCloud will make no changes to the reservation code.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The unique ID of the product reservation.

external_reservation_codes
array of objects
required
length ≤ 1000

List of the external reservation codes. Id codes can have different sources. Please get in touch with your account manager for the list of ID sources.

external_reservation_codes*
Headers
string
Defaults to cs, en-gb;q=0.8

The unique ID of the language code by ISO 639-1.

Responses
204

No Content

error.error_data.invalid_params[] array lists the parameters that caused the failure, each carrying a reason code. See the BadRequestErrorBody schema for the generic reason taxonomy. Operations with domain-specific business rules document additional reasons at the operation level.

429

Too many requests - more than the resource limit.

503

Temporary state when the service is temporarily unavailable, overloaded or there is a maintenance window.

Updated 5 months ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?