DocPlanner\Client\ServicesApi

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

\DocPlanner\Client\Model\AddressService 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).

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\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 {
    $result = $apiInstance->addAddressService($body, $facility_id, $doctor_id, $address_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServicesApi->addAddressService: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description
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

Return type

\DocPlanner\Client\Model\AddressService

Authorization

oauth2

HTTP request headers

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]

deleteAddressService

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).

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\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;
}
?>

Parameters

Name	Type	Description
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

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]

getAddressService

\DocPlanner\Client\Model\AddressService getAddressService($facility_id, $doctor_id, $address_id, $address_service_id, $with)

Service returned in this endpoint is an address service. Service returned here is from a specified address (address_services). Extensions: * address_service.allowed_patients - with this parameter in url, query results will return additional parameter indicating which type of patients are allowed to book a given service * address_service.custom_name - with this parameter in url, query results will return additional field with a custom name of an address service * address_service.public_insurance_flow - with this parameter in url, query results will return information if public insurance flow is supported

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\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
$with = array(new \DocPlanner\Client\Model\AddressServiceScopes()); // \DocPlanner\Client\Model\AddressServiceScopes[] | 

try {
    $result = $apiInstance->getAddressService($facility_id, $doctor_id, $address_id, $address_service_id, $with);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServicesApi->getAddressService: ', $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
address_service_id	string	ID of an address service
with	\DocPlanner\Client\Model\AddressServiceScopes[]		[optional]

Return type

\DocPlanner\Client\Model\AddressService

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]

getAddressServices

\DocPlanner\Client\Model\AddressServices getAddressServices($facility_id, $doctor_id, $address_id, $start, $with)

Services returned in this endpoint are address services. Services returned here are from specified address (address_services). Extensions: * address_service.allowed_patients - with this parameter in url, query results will return additional parameter indicating which type of patients are allowed to book a given service * address_service.custom_name - with this parameter in url, query results will return additional field with a custom name of an address service * address_service.public_insurance_flow - with this parameter in url, query results will return information if public insurance flow is supported

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\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.
$with = array(new \DocPlanner\Client\Model\AddressServicesScopes()); // \DocPlanner\Client\Model\AddressServicesScopes[] | 

try {
    $result = $apiInstance->getAddressServices($facility_id, $doctor_id, $address_id, $start, $with);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServicesApi->getAddressServices: ', $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
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]
with	\DocPlanner\Client\Model\AddressServicesScopes[]		[optional]

Return type

\DocPlanner\Client\Model\AddressServices

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]

getServices

\DocPlanner\Client\Model\Services getServices($with, $specialization_id)

Services returned in this endpoint are dictionary services. Services returned here are from a dictionary (item_services). Extensions: * services.only_diagnostics - with this parameter in url, query results will return only dictionary of services dedicated to integration with diagnostics marketplace

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\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[] | 
$specialization_id = 56; // int | Filters services by specialization. When provided, only services associated with the given specialization are returned.

try {
    $result = $apiInstance->getServices($with, $specialization_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ServicesApi->getServices: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
with	\DocPlanner\Client\Model\ServicesScopes[]		[optional]
specialization_id	int	Filters services by specialization. When provided, only services associated with the given specialization are returned.	[optional]

Return type

\DocPlanner\Client\Model\Services

Authorization

oauth2

HTTP request headers

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]

updateAddressService

\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).

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\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;
}
?>

Parameters

Name	Type	Description
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

Return type

\DocPlanner\Client\Model\AddressService

Authorization

oauth2

HTTP request headers

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]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DocPlanner\Client\ServicesApi

addAddressService

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAddressService

Example

Parameters

Return type

Authorization

HTTP request headers

getAddressService

Example

Parameters

Return type

Authorization

HTTP request headers

getAddressServices

Example

Parameters

Return type

Authorization

HTTP request headers

getServices

Example

Parameters

Return type

Authorization

HTTP request headers

updateAddressService

Example

Parameters

Return type

Authorization

HTTP request headers

FilesExpand file tree

ServicesApi.md

Latest commit

History

ServicesApi.md

File metadata and controls

DocPlanner\Client\ServicesApi

addAddressService

Example

Parameters

Return type

Authorization

HTTP request headers

deleteAddressService

Example

Parameters

Return type

Authorization

HTTP request headers

getAddressService

Example

Parameters

Return type

Authorization

HTTP request headers

getAddressServices

Example

Parameters

Return type

Authorization

HTTP request headers

getServices

Example

Parameters

Return type

Authorization

HTTP request headers

updateAddressService

Example

Parameters

Return type

Authorization

HTTP request headers