All URIs are relative to https://www.{domain}/api/v3/integration
Method | HTTP request | Description |
---|---|---|
cancelBooking | DELETE /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id} | |
getBooking | GET /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id} | |
getBookings | GET /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings | |
moveBooking | POST /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/bookings/{booking_id}/move | |
requestOpinion | PUT /facilities/{facility_id}/doctors/{doctor_id}/opinion-request |
cancelBooking($facility_id, $doctor_id, $address_id, $booking_id, $body)
Cancel the booking
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new DocPlanner\Client\Api\BookingsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$facility_id = "facility_id_example"; // string | ID of the Facility
$doctor_id = "doctor_id_example"; // string | ID of a doctor in a facility
$address_id = "address_id_example"; // string | ID of a doctor`s address in a facility
$booking_id = "booking_id_example"; // string | ID of the Booking
$body = new \DocPlanner\Client\Model\CancelBookingRequest(); // \DocPlanner\Client\Model\CancelBookingRequest |
try {
$apiInstance->cancelBooking($facility_id, $doctor_id, $address_id, $booking_id, $body);
} catch (Exception $e) {
echo 'Exception when calling BookingsApi->cancelBooking: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
facility_id | string | ID of the Facility | |
doctor_id | string | ID of a doctor in a facility | |
address_id | string | ID of a doctor`s address in a facility | |
booking_id | string | ID of the Booking | |
body | \DocPlanner\Client\Model\CancelBookingRequest | [optional] |
void (empty response body)
- Content-Type: application/json
- Accept: application/vnd.error+docplanner+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DocPlanner\Client\Model\Booking getBooking($facility_id, $doctor_id, $address_id, $booking_id)
View specific booking
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new DocPlanner\Client\Api\BookingsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$facility_id = "facility_id_example"; // string | ID of the Facility
$doctor_id = "doctor_id_example"; // string | ID of a doctor in a facility
$address_id = "address_id_example"; // string | ID of a doctor`s address in a facility
$booking_id = "booking_id_example"; // string | ID of the Booking
try {
$result = $apiInstance->getBooking($facility_id, $doctor_id, $address_id, $booking_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BookingsApi->getBooking: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
facility_id | string | ID of the Facility | |
doctor_id | string | ID of a doctor in a facility | |
address_id | string | ID of a doctor`s address in a facility | |
booking_id | string | ID of the Booking |
\DocPlanner\Client\Model\Booking
- Content-Type: Not defined
- Accept: application/vnd.docplanner+json; charset=UTF-8, application/vnd.error+docplanner+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DocPlanner\Client\Model\Bookings getBookings($facility_id, $doctor_id, $address_id, $start, $end, $page, $limit, $with)
Get bookings list of a doctor in the facility Passing the page
parameter in the query string will enable pagination. Extensions: * booking.patient
- with this parameter in url, query results will return patient data for every booking * booking.address_service
- with this parameter in url, query results will return address service for every booking * booking.presence
- with this parameter in url, query results will return additional information weather patient was present for every booking
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new DocPlanner\Client\Api\BookingsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$facility_id = "facility_id_example"; // string | ID of the Facility
$doctor_id = "doctor_id_example"; // string | ID of a doctor in a facility
$address_id = "address_id_example"; // string | ID of a doctor`s address in a facility
$start = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Slot start date (parameter must be urlencoded before sending request)
$end = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Slot start date (parameter must be urlencoded before sending request)
$page = 56; // int | Page number to use for pagination. If not provided the pagination is not applied.
$limit = 56; // int | Maximum number of items per page. If not provided the default value of 100 is applied if pagination is used.
$with = array(new \DocPlanner\Client\Model\BookingsScopes()); // \DocPlanner\Client\Model\BookingsScopes[] |
try {
$result = $apiInstance->getBookings($facility_id, $doctor_id, $address_id, $start, $end, $page, $limit, $with);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BookingsApi->getBookings: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
facility_id | string | ID of the Facility | |
doctor_id | string | ID of a doctor in a facility | |
address_id | string | ID of a doctor`s address in a facility | |
start | \DateTime | Slot start date (parameter must be urlencoded before sending request) | |
end | \DateTime | Slot start date (parameter must be urlencoded before sending request) | |
page | int | Page number to use for pagination. If not provided the pagination is not applied. | [optional] |
limit | int | Maximum number of items per page. If not provided the default value of 100 is applied if pagination is used. | [optional] |
with | \DocPlanner\Client\Model\BookingsScopes[] | [optional] |
\DocPlanner\Client\Model\Bookings
- Content-Type: Not defined
- Accept: application/vnd.docplanner+json; charset=UTF-8, application/vnd.error+docplanner+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DocPlanner\Client\Model\Booking moveBooking($body, $facility_id, $doctor_id, $address_id, $booking_id)
Move booking for a doctor
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new DocPlanner\Client\Api\BookingsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$body = new \DocPlanner\Client\Model\MoveBookingRequest(); // \DocPlanner\Client\Model\MoveBookingRequest |
$facility_id = "facility_id_example"; // string | ID of the Facility
$doctor_id = "doctor_id_example"; // string | ID of a doctor in a facility
$address_id = "address_id_example"; // string | ID of a doctor`s address in a facility
$booking_id = "booking_id_example"; // string | ID of the Booking
try {
$result = $apiInstance->moveBooking($body, $facility_id, $doctor_id, $address_id, $booking_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling BookingsApi->moveBooking: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \DocPlanner\Client\Model\MoveBookingRequest | ||
facility_id | string | ID of the Facility | |
doctor_id | string | ID of a doctor in a facility | |
address_id | string | ID of a doctor`s address in a facility | |
booking_id | string | ID of the Booking |
\DocPlanner\Client\Model\Booking
- Content-Type: application/json
- Accept: application/vnd.docplanner+json; charset=UTF-8, application/vnd.error+docplanner+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
requestOpinion($facility_id, $doctor_id, $body)
After the visit was booked via clinics software, by calling this endpoint you can request SMS asking patient to leave an opinion. We do not store patient and visit information
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure OAuth2 access token for authorization: oauth2
$config = DocPlanner\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');
$apiInstance = new DocPlanner\Client\Api\BookingsApi(
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
// This is optional, `GuzzleHttp\Client` will be used as default.
new GuzzleHttp\Client(),
$config
);
$facility_id = "facility_id_example"; // string | ID of the Facility
$doctor_id = "doctor_id_example"; // string | ID of a doctor in a facility
$body = new \DocPlanner\Client\Model\OpinionRequest(); // \DocPlanner\Client\Model\OpinionRequest | Phone number of the patient
try {
$apiInstance->requestOpinion($facility_id, $doctor_id, $body);
} catch (Exception $e) {
echo 'Exception when calling BookingsApi->requestOpinion: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
facility_id | string | ID of the Facility | |
doctor_id | string | ID of a doctor in a facility | |
body | \DocPlanner\Client\Model\OpinionRequest | Phone number of the patient | [optional] |
void (empty response body)
- Content-Type: application/json
- Accept: application/vnd.error+docplanner+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]