Skip to content

Latest commit

 

History

History
113 lines (79 loc) · 3.12 KB

ProvisionerApi.md

File metadata and controls

113 lines (79 loc) · 3.12 KB

Yoast\MyYoastApiClient\ProvisionerApi

All URIs are relative to https://my.yoast.test

Method HTTP request Description
getMany GET /api/ProvisionerData Get provisioner data
getOne GET /api/ProvisionerData/{id} Get provisioner data

getMany

\Yoast\MyYoastApiClient\Model\ProvisionerData[] getMany()

Get provisioner data

Get and filter provisioner data

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\ProvisionerApi(
    // 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
);

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

Parameters

This endpoint does not need any parameter.

Return type

\Yoast\MyYoastApiClient\Model\ProvisionerData[]

Authorization

bearer

HTTP request headers

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

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

getOne

\Yoast\MyYoastApiClient\Model\Subscription getOne($id)

Get provisioner data

Get provisioner data

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');
    // Configure HTTP bearer authorization: bearer
    $config = Yoast\MyYoastApiClient\Configuration::getDefaultConfiguration()
    ->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Yoast\MyYoastApiClient\Api\ProvisionerApi(
    // 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 = "38400000-8cf0-11bd-b23e-10b96e4ef00d"; // string | 

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

Parameters

Name Type Description Notes
id string

Return type

\Yoast\MyYoastApiClient\Model\Subscription

Authorization

bearer

HTTP request headers

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

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