Swagger\Client\OrgApi

All URIs are relative to https://atlas.forsta.io/v1

Method	HTTP request	Description
orgCreate	POST /org/
orgDelete	DELETE /org/{id}/
orgList	GET /org/
orgPartialUpdate	PATCH /org/{id}/
orgRead	GET /org/{id}/
orgUpdate	PUT /org/{id}/

orgCreate

\Swagger\Client\Model\Org orgCreate($data)

API endpoint for Org data

Example

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

// Configure API key authorization: JSON Web Token
$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\OrgApi(
    // 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\Org(); // \Swagger\Client\Model\Org | 

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

Parameters

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

Return type

\Swagger\Client\Model\Org

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

orgDelete

orgDelete($id)

API endpoint for Org data

Example

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

// Configure API key authorization: JSON Web Token
$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\OrgApi(
    // 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->orgDelete($id);
} catch (Exception $e) {
    echo 'Exception when calling OrgApi->orgDelete: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string

Return type

void (empty response body)

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

orgList

\Swagger\Client\Model\InlineResponse2002 orgList($ordering, $search, $page, $page_size)

API endpoint for Org data

Example

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

// Configure API key authorization: JSON Web Token
$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\OrgApi(
    // 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
);
$ordering = "ordering_example"; // string | Which field to use when ordering the results.
$search = "search_example"; // string | A search term.
$page = 56; // int | A page number within the paginated result set.
$page_size = 56; // int | Number of results to return per page.

try {
    $result = $apiInstance->orgList($ordering, $search, $page, $page_size);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrgApi->orgList: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
ordering	string	Which field to use when ordering the results.	[optional]
search	string	A search term.	[optional]
page	int	A page number within the paginated result set.	[optional]
page_size	int	Number of results to return per page.	[optional]

Return type

\Swagger\Client\Model\InlineResponse2002

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

orgPartialUpdate

\Swagger\Client\Model\Org orgPartialUpdate($id, $data)

API endpoint for Org data

Example

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

// Configure API key authorization: JSON Web Token
$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\OrgApi(
    // 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 | 
$data = new \Swagger\Client\Model\Org(); // \Swagger\Client\Model\Org | 

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

Parameters

Name	Type	Description	Notes
id	string
data	\Swagger\Client\Model\Org

Return type

\Swagger\Client\Model\Org

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

orgRead

\Swagger\Client\Model\Org orgRead($id)

API endpoint for Org data

Example

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

// Configure API key authorization: JSON Web Token
$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\OrgApi(
    // 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->orgRead($id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling OrgApi->orgRead: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
id	string

Return type

\Swagger\Client\Model\Org

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

orgUpdate

\Swagger\Client\Model\Org orgUpdate($id, $data)

API endpoint for Org data

Example

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

// Configure API key authorization: JSON Web Token
$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\OrgApi(
    // 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 | 
$data = new \Swagger\Client\Model\Org(); // \Swagger\Client\Model\Org | 

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

Parameters

Name	Type	Description	Notes
id	string
data	\Swagger\Client\Model\Org

Return type

\Swagger\Client\Model\Org

Authorization

[JSON Web Token](../../README.md#JSON Web Token)

HTTP request headers

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

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

Files

OrgApi.md

Latest commit

History

OrgApi.md

File metadata and controls

Swagger\Client\OrgApi

orgCreate

Example

Parameters

Return type

Authorization

HTTP request headers

orgDelete

Example

Parameters

Return type

Authorization

HTTP request headers

orgList

Example

Parameters

Return type

Authorization

HTTP request headers

orgPartialUpdate

Example

Parameters

Return type

Authorization

HTTP request headers

orgRead

Example

Parameters

Return type

Authorization

HTTP request headers

orgUpdate

Example

Parameters

Return type

Authorization

HTTP request headers