All URIs are relative to https://www.{domain}/api/v3/integration
Method | HTTP request | Description |
---|---|---|
addAddressService | POST /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services | |
deleteAddressService | DELETE /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id} | |
getAddressService | GET /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id} | |
getAddressServices | GET /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services | |
getServices | GET /services | |
updateAddressService | PATCH /facilities/{facility_id}/doctors/{doctor_id}/addresses/{address_id}/services/{address_service_id} |
addAddressService($body, $facility_id, $doctor_id, $address_id)
Adds new service to an address of the doctor Services added here are specific to this address (address_services).
<?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\ServicesApi(
// 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\AddAddressServiceRequest(); // \DocPlanner\Client\Model\AddAddressServiceRequest |
$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->addAddressService($body, $facility_id, $doctor_id, $address_id);
} catch (Exception $e) {
echo 'Exception when calling ServicesApi->addAddressService: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \DocPlanner\Client\Model\AddAddressServiceRequest | ||
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 |
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]
deleteAddressService($facility_id, $doctor_id, $address_id, $address_service_id)
Service deleted in this endpoint is an address service from this specified address (address_services).
<?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\ServicesApi(
// 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
$address_service_id = "address_service_id_example"; // string | ID of an address service
try {
$apiInstance->deleteAddressService($facility_id, $doctor_id, $address_id, $address_service_id);
} catch (Exception $e) {
echo 'Exception when calling ServicesApi->deleteAddressService: ', $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 | |
address_service_id | string | ID of an address service |
void (empty response body)
- Content-Type: Not defined
- Accept: application/vnd.error+docplanner+json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DocPlanner\Client\Model\AddressService getAddressService($facility_id, $doctor_id, $address_id, $address_service_id)
Service returned in this endpoint is an address service. Service returned here is from a specified address (address_services).
<?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\ServicesApi(
// 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
$address_service_id = "address_service_id_example"; // string | ID of an address service
try {
$result = $apiInstance->getAddressService($facility_id, $doctor_id, $address_id, $address_service_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ServicesApi->getAddressService: ', $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 | |
address_service_id | string | ID of an address service |
\DocPlanner\Client\Model\AddressService
- 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\AddressServices getAddressServices($facility_id, $doctor_id, $address_id, $start)
Services returned in this endpoint are address services. Services returned here are from specified address (address_services).
<?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\ServicesApi(
// 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). Limits results to only those linked to slots that start on that date.
try {
$result = $apiInstance->getAddressServices($facility_id, $doctor_id, $address_id, $start);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ServicesApi->getAddressServices: ', $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). Limits results to only those linked to slots that start on that date. | [optional] |
\DocPlanner\Client\Model\AddressServices
- 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\Services getServices($with)
Services returned in this endpoint are dictionary services. Services returned here are from a dictionary (item_services). Scopes: * services.only_diagnostics
- with this parameter in url, query results will return only dictionary of services dedicated to integration with diagnostics marketplace
<?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\ServicesApi(
// 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
);
$with = array(new \DocPlanner\Client\Model\ServicesScopes()); // \DocPlanner\Client\Model\ServicesScopes[] |
try {
$result = $apiInstance->getServices($with);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ServicesApi->getServices: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
with | \DocPlanner\Client\Model\ServicesScopes[] | [optional] |
\DocPlanner\Client\Model\Services
- Content-Type: Not defined
- Accept: application/vnd.docplanner+json; charset=UTF-8
[Back to top] [Back to API list] [Back to Model list] [Back to README]
\DocPlanner\Client\Model\AddressService updateAddressService($body, $facility_id, $doctor_id, $address_id, $address_service_id)
Service updated in this endpoint is an address service from this specified address (address_services).
<?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\ServicesApi(
// 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\UpdateAddressServiceRequest(); // \DocPlanner\Client\Model\UpdateAddressServiceRequest |
$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
$address_service_id = "address_service_id_example"; // string | ID of an address service
try {
$result = $apiInstance->updateAddressService($body, $facility_id, $doctor_id, $address_id, $address_service_id);
print_r($result);
} catch (Exception $e) {
echo 'Exception when calling ServicesApi->updateAddressService: ', $e->getMessage(), PHP_EOL;
}
?>
Name | Type | Description | Notes |
---|---|---|---|
body | \DocPlanner\Client\Model\UpdateAddressServiceRequest | ||
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 | |
address_service_id | string | ID of an address service |
\DocPlanner\Client\Model\AddressService
- 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]