Skip to content

Latest commit

 

History

History
179 lines (125 loc) · 5.94 KB

CalendarsApi.md

File metadata and controls

179 lines (125 loc) · 5.94 KB
Raw

DocPlanner\Client\CalendarsApi

All URIs are relative to https://www.{domain}/api/v3/integration

Method HTTP request Description
disableCalendar POST /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/disable
enableCalendar POST /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar/enable
getCalendar GET /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/calendar

disableCalendar

disableCalendar($facility_id, $doctor_id, $address_id)

Disable calendar on the address

Example

<?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\CalendarsApi(
    // 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

try {
    $apiInstance->disableCalendar($facility_id, $doctor_id, $address_id);
} catch (Exception $e) {
    echo 'Exception when calling CalendarsApi->disableCalendar: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.error+docplanner+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

enableCalendar

enableCalendar($facility_id, $doctor_id, $address_id)

Enable calendar on the address

Example

<?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\CalendarsApi(
    // 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

try {
    $apiInstance->enableCalendar($facility_id, $doctor_id, $address_id);
} catch (Exception $e) {
    echo 'Exception when calling CalendarsApi->enableCalendar: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

void (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.error+docplanner+json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getCalendar

\DocPlanner\Client\Model\Calendar getCalendar($facility_id, $doctor_id, $address_id)

Gets calendar of the address

Example

<?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\CalendarsApi(
    // 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

try {
    $result = $apiInstance->getCalendar($facility_id, $doctor_id, $address_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CalendarsApi->getCalendar: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

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

Return type

\DocPlanner\Client\Model\Calendar

Authorization

oauth2

HTTP request headers

  • 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]