Skip to content

Latest commit

 

History

History
353 lines (241 loc) · 11.2 KB

CaseMarkersApi.md

File metadata and controls

353 lines (241 loc) · 11.2 KB

Swagger\Client\CaseMarkersApi

All URIs are relative to https://de.openlegaldata.io/api

Method HTTP request Description
caseMarkersCreate POST /case_markers/
caseMarkersDelete DELETE /case_markers/{id}/
caseMarkersList GET /case_markers/
caseMarkersPartialUpdate PATCH /case_markers/{id}/
caseMarkersRead GET /case_markers/{id}/
caseMarkersUpdate PUT /case_markers/{id}/

caseMarkersCreate

\Swagger\Client\Model\CaseMarker caseMarkersCreate($data)

Example

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CaseMarkersApi(
    // 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
);
$data = new \Swagger\Client\Model\CaseMarker(); // \Swagger\Client\Model\CaseMarker | 

try {
    $result = $apiInstance->caseMarkersCreate($data);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseMarkersApi->caseMarkersCreate: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
data \Swagger\Client\Model\CaseMarker

Return type

\Swagger\Client\Model\CaseMarker

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

caseMarkersDelete

caseMarkersDelete($id)

Example

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CaseMarkersApi(
    // 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 = 56; // int | A unique integer value identifying this case marker.

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

Parameters

Name Type Description Notes
id int A unique integer value identifying this case marker.

Return type

void (empty response body)

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

caseMarkersList

\Swagger\Client\Model\InlineResponse2002 caseMarkersList($belongs_to, $label, $limit, $offset)

Example

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CaseMarkersApi(
    // 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
);
$belongs_to = 8.14; // float | 
$label = 8.14; // float | 
$limit = 56; // int | Number of results to return per page.
$offset = 56; // int | The initial index from which to return the results.

try {
    $result = $apiInstance->caseMarkersList($belongs_to, $label, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CaseMarkersApi->caseMarkersList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
belongs_to float [optional]
label float [optional]
limit int Number of results to return per page. [optional]
offset int The initial index from which to return the results. [optional]

Return type

\Swagger\Client\Model\InlineResponse2002

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

caseMarkersPartialUpdate

\Swagger\Client\Model\CaseMarker caseMarkersPartialUpdate($id, $data)

Example

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CaseMarkersApi(
    // 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 = 56; // int | A unique integer value identifying this case marker.
$data = new \Swagger\Client\Model\CaseMarker(); // \Swagger\Client\Model\CaseMarker | 

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

Parameters

Name Type Description Notes
id int A unique integer value identifying this case marker.
data \Swagger\Client\Model\CaseMarker

Return type

\Swagger\Client\Model\CaseMarker

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

caseMarkersRead

\Swagger\Client\Model\CaseMarker caseMarkersRead($id)

Example

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CaseMarkersApi(
    // 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 = 56; // int | A unique integer value identifying this case marker.

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

Parameters

Name Type Description Notes
id int A unique integer value identifying this case marker.

Return type

\Swagger\Client\Model\CaseMarker

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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

caseMarkersUpdate

\Swagger\Client\Model\CaseMarker caseMarkersUpdate($id, $data)

Example

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Authorization', 'Bearer');

$apiInstance = new Swagger\Client\Api\CaseMarkersApi(
    // 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 = 56; // int | A unique integer value identifying this case marker.
$data = new \Swagger\Client\Model\CaseMarker(); // \Swagger\Client\Model\CaseMarker | 

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

Parameters

Name Type Description Notes
id int A unique integer value identifying this case marker.
data \Swagger\Client\Model\CaseMarker

Return type

\Swagger\Client\Model\CaseMarker

Authorization

api_key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

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