OrganizationsApi.md

QuantClient\OrganizationsApi

All URIs are relative to https://dashboard.quantcdn.io, except if the operation defines another base path.

Method	HTTP request	Description
organizationsList()	GET /api/v2/organizations	Retrieve all organizations
organizationsRead()	GET /api/v2/organizations/{organization}	Get details of a single organization

organizationsList()

organizationsList(): \QuantClient\Model\OrganizationsList200ResponseInner[]

Retrieve all organizations

Example

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


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


$apiInstance = new QuantClient\Api\OrganizationsApi(
    // 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->organizationsList();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrganizationsApi->organizationsList: ', $e->getMessage(), PHP_EOL;
}

Parameters

This endpoint does not need any parameter.

Return type

\QuantClient\Model\OrganizationsList200ResponseInner[]

Authorization

BearerAuth

HTTP request headers

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

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

organizationsRead()

organizationsRead($organization): \QuantClient\Model\V2Organization

Get details of a single organization

Example

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


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


$apiInstance = new QuantClient\Api\OrganizationsApi(
    // 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
);
$organization = test-org; // string | Organization identifier

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

Parameters

Name	Type	Description	Notes
organization	string	Organization identifier

Return type

\QuantClient\Model\V2Organization

Authorization

BearerAuth

HTTP request headers

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

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