omsorg/omsorgWeb/mitarbeiter-app/api-client-php/docs/Api/OrdersApi.md

OmsorgCoreClient\OrdersApi

All URIs are relative to http://localhost, except if the operation defines another base path.

Method	HTTP request	Description
apiOrdersGet()	GET /api/orders
apiOrdersIdDelete()	DELETE /api/orders/{id}
apiOrdersIdGet()	GET /api/orders/{id}
apiOrdersIdPut()	PUT /api/orders/{id}
apiOrdersPost()	POST /api/orders

apiOrdersGet()

apiOrdersGet($search, $status_id, $facility_id, $priority, $required_qualification, $shift_type, $page, $page_size): \OmsorgCoreClient\Model\OrderResponsePagedResponse

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\OrdersApi(
    // 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
);
$search = 'search_example'; // string
$status_id = 'status_id_example'; // string
$facility_id = 'facility_id_example'; // string
$priority = 'priority_example'; // string
$required_qualification = 'required_qualification_example'; // string
$shift_type = 'shift_type_example'; // string
$page = 1; // int
$page_size = 20; // int

try {
    $result = $apiInstance->apiOrdersGet($search, $status_id, $facility_id, $priority, $required_qualification, $shift_type, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->apiOrdersGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
search	string		[optional]
status_id	string		[optional]
facility_id	string		[optional]
priority	string		[optional]
required_qualification	string		[optional]
shift_type	string		[optional]
page	int		[optional] [default to 1]
page_size	int		[optional] [default to 20]

Return type

\OmsorgCoreClient\Model\OrderResponsePagedResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

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

apiOrdersIdDelete()

apiOrdersIdDelete($id)

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\OrdersApi(
    // 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
);
$id = 'id_example'; // string

try {
    $apiInstance->apiOrdersIdDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->apiOrdersIdDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: Not defined

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

apiOrdersIdGet()

apiOrdersIdGet($id): \OmsorgCoreClient\Model\OrderResponse

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\OrdersApi(
    // 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
);
$id = 'id_example'; // string

try {
    $result = $apiInstance->apiOrdersIdGet($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->apiOrdersIdGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string

Return type

\OmsorgCoreClient\Model\OrderResponse

Authorization

Bearer

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json, text/json

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

apiOrdersIdPut()

apiOrdersIdPut($id, $update_order_request): \OmsorgCoreClient\Model\OrderResponse

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\OrdersApi(
    // 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
);
$id = 'id_example'; // string
$update_order_request = new \OmsorgCoreClient\Model\UpdateOrderRequest(); // \OmsorgCoreClient\Model\UpdateOrderRequest

try {
    $result = $apiInstance->apiOrdersIdPut($id, $update_order_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->apiOrdersIdPut: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
id	string
update_order_request	\OmsorgCoreClient\Model\UpdateOrderRequest		[optional]

Return type

\OmsorgCoreClient\Model\OrderResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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

apiOrdersPost()

apiOrdersPost($create_order_request): \OmsorgCoreClient\Model\OrderResponse

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure Bearer (JWT) authorization: Bearer
$config = OmsorgCoreClient\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OmsorgCoreClient\Api\OrdersApi(
    // 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
);
$create_order_request = new \OmsorgCoreClient\Model\CreateOrderRequest(); // \OmsorgCoreClient\Model\CreateOrderRequest

try {
    $result = $apiInstance->apiOrdersPost($create_order_request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrdersApi->apiOrdersPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
create_order_request	\OmsorgCoreClient\Model\CreateOrderRequest		[optional]

Return type

\OmsorgCoreClient\Model\OrderResponse

Authorization

Bearer

HTTP request headers

• Content-Type: application/json, text/json, application/*+json
• Accept: text/plain, application/json, text/json

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