Skip to content

Latest commit

 

History

History
432 lines (317 loc) · 14 KB

ForeignSystemApi.md

File metadata and controls

432 lines (317 loc) · 14 KB
Raw

Membercare\Client\ForeignSystemApi

All URIs are relative to /

Method HTTP request Description
deleteFoerignSystem DELETE /api/v1/foreignSystems/{id} Delete a ForeginSystem
getCompaniesByForeignSystem GET /api/v1/foreignSystems/{id}/companies Get Persons via ForeginSystem
getFoerignSystem GET /api/v1/foreignSystems/{id} Get a ForeginSystem
getFoerignSystems GET /api/v1/foreignSystems Get all ForeginSystems
getOrganizationsByForeignSystem GET /api/v1/foreignSystems/{id}/organizations Get Organizations via ForeginSystem
getPersonsForeignSystem GET /api/v1/foreignSystems/{id}/persons Get Persons via ForeignSystem
patchFoerignSystem PATCH /api/v1/foreignSystems/{id} Update ForeginSystem
postFoerignSystem POST /api/v1/foreignSystems Create a ForeginSystem

deleteFoerignSystem

deleteFoerignSystem($id, $token)

Delete a ForeginSystem

Example

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

$apiInstance = new Membercare\Client\Api\ForeignSystemApi(
    // 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()
);
$id = 789; // int | 
$token = "token_example"; // string | access token

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

Parameters

Name Type Description Notes
id int
token string access token

Return type

void (empty response body)

Authorization

No authorization required

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]

getCompaniesByForeignSystem

\Membercare\Client\Model\CompanyPagedResult getCompaniesByForeignSystem($id, $token, $external_id, $only_valid, $page, $page_size)

Get Persons via ForeginSystem

Example

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

$apiInstance = new Membercare\Client\Api\ForeignSystemApi(
    // 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()
);
$id = 789; // int | 
$token = "token_example"; // string | access token
$external_id = "external_id_example"; // string | 
$only_valid = true; // bool | 
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getCompaniesByForeignSystem($id, $token, $external_id, $only_valid, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ForeignSystemApi->getCompaniesByForeignSystem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
token string access token
external_id string [optional]
only_valid bool [optional] [default to true]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\CompanyPagedResult

Authorization

No authorization required

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]

getFoerignSystem

\Membercare\Client\Model\ForeignSystem getFoerignSystem($id, $token)

Get a ForeginSystem

Example

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

$apiInstance = new Membercare\Client\Api\ForeignSystemApi(
    // 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()
);
$id = 789; // int | 
$token = "token_example"; // string | access token

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

Parameters

Name Type Description Notes
id int
token string access token

Return type

\Membercare\Client\Model\ForeignSystem

Authorization

No authorization required

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]

getFoerignSystems

\Membercare\Client\Model\ForeignSystem[] getFoerignSystems($token)

Get all ForeginSystems

Example

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

$apiInstance = new Membercare\Client\Api\ForeignSystemApi(
    // 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()
);
$token = "token_example"; // string | access token

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

Parameters

Name Type Description Notes
token string access token

Return type

\Membercare\Client\Model\ForeignSystem[]

Authorization

No authorization required

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]

getOrganizationsByForeignSystem

\Membercare\Client\Model\OrganizationPagedResult getOrganizationsByForeignSystem($id, $token, $external_id, $only_valid, $page, $page_size)

Get Organizations via ForeginSystem

Example

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

$apiInstance = new Membercare\Client\Api\ForeignSystemApi(
    // 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()
);
$id = 789; // int | 
$token = "token_example"; // string | access token
$external_id = "external_id_example"; // string | 
$only_valid = true; // bool | 
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getOrganizationsByForeignSystem($id, $token, $external_id, $only_valid, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ForeignSystemApi->getOrganizationsByForeignSystem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
token string access token
external_id string [optional]
only_valid bool [optional] [default to true]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\OrganizationPagedResult

Authorization

No authorization required

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]

getPersonsForeignSystem

\Membercare\Client\Model\PersonPagedResult getPersonsForeignSystem($id, $token, $external_id, $only_valid, $unit_closed_after, $page, $page_size)

Get Persons via ForeignSystem

Example

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

$apiInstance = new Membercare\Client\Api\ForeignSystemApi(
    // 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()
);
$id = 789; // int | 
$token = "token_example"; // string | access token
$external_id = "external_id_example"; // string | 
$only_valid = true; // bool | 
$unit_closed_after = new \DateTime("2013-10-20T19:20:30+01:00"); // \DateTime | Only used when externalId is null and onlyValid is false
$page = 1; // int | 
$page_size = 50; // int | 

try {
    $result = $apiInstance->getPersonsForeignSystem($id, $token, $external_id, $only_valid, $unit_closed_after, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ForeignSystemApi->getPersonsForeignSystem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
id int
token string access token
external_id string [optional]
only_valid bool [optional] [default to true]
unit_closed_after \DateTime Only used when externalId is null and onlyValid is false [optional]
page int [optional] [default to 1]
page_size int [optional] [default to 50]

Return type

\Membercare\Client\Model\PersonPagedResult

Authorization

No authorization required

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]

patchFoerignSystem

\Membercare\Client\Model\ForeignSystem patchFoerignSystem($token, $id, $body)

Update ForeginSystem

Example

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

$apiInstance = new Membercare\Client\Api\ForeignSystemApi(
    // 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()
);
$token = "token_example"; // string | access token
$id = 789; // int | 
$body = new \Membercare\Client\Model\ForeignSystemPatch(); // \Membercare\Client\Model\ForeignSystemPatch | 

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

Parameters

Name Type Description Notes
token string access token
id int
body \Membercare\Client\Model\ForeignSystemPatch [optional]

Return type

\Membercare\Client\Model\ForeignSystem

Authorization

No authorization required

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]

postFoerignSystem

\Membercare\Client\Model\ForeignSystem postFoerignSystem($token, $body)

Create a ForeginSystem

Example

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

$apiInstance = new Membercare\Client\Api\ForeignSystemApi(
    // 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()
);
$token = "token_example"; // string | access token
$body = new \Membercare\Client\Model\ForeignSystem(); // \Membercare\Client\Model\ForeignSystem | 

try {
    $result = $apiInstance->postFoerignSystem($token, $body);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ForeignSystemApi->postFoerignSystem: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
token string access token
body \Membercare\Client\Model\ForeignSystem [optional]

Return type

\Membercare\Client\Model\ForeignSystem

Authorization

No authorization required

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]