Skip to content

Latest commit

 

History

History
336 lines (233 loc) · 11.8 KB

AnnouncementsApi.md

File metadata and controls

336 lines (233 loc) · 11.8 KB
Raw

OpenAPI\Client\AnnouncementsApi

All URIs are relative to https://cloud9.circuitid.com, except if the operation defines another base path.

Method HTTP request Description
createAnnouncement() POST /announcements Create a new object
findAnnouncements() GET /announcements Find multiple objects
getAnnouncement() GET /announcements/{id} Get object by id
patchAnnouncement() PATCH /announcements/{id} Patch object's data
removeAnnouncement() DELETE /announcements/{id} Delete object by id

createAnnouncement()

createAnnouncement($announcementsCreateOrPatch): \OpenAPI\Client\CircuitID\GetAnnouncement200Response

Create a new object

Add a new object to the system.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\AnnouncementsApi(
    // 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
);
$announcementsCreateOrPatch = new \OpenAPI\Client\CircuitID\AnnouncementsCreateOrPatch(); // \OpenAPI\Client\CircuitID\AnnouncementsCreateOrPatch | The JSON object that will be posted to the REST API endpoint.

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

Parameters

Name Type Description Notes
announcementsCreateOrPatch \OpenAPI\Client\CircuitID\AnnouncementsCreateOrPatch The JSON object that will be posted to the REST API endpoint.

Return type

\OpenAPI\Client\CircuitID\GetAnnouncement200Response

Authorization

jwt

HTTP request headers

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

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

findAnnouncements()

findAnnouncements($search, $limit, $skip, $sort, $select, $or, $and): \OpenAPI\Client\CircuitID\FindAnnouncements200Response

Find multiple objects

Search and retrieve multiple objects simultaneously.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\AnnouncementsApi(
    // 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
);
$search = 'search_example'; // string | Filter results by the specified value.
$limit = 56; // int | $limit will return only the number of results you specify.
$skip = 56; // int | $skip will skip the specified number of results.
$sort = array('key' => new \stdClass); // object | $sort will sort based on the object you provide. It can contain a list of properties by which to sort mapped to the order (1 ascending, -1 descending).
$select = array('select_example'); // string[] | $select allows to pick which fields to include in the result.
$or = array(new \stdClass); // object[] | Find all records that match any of the given criteria.
$and = array(new \stdClass); // object[] | Find all records that match all of the given criteria.

try {
    $result = $apiInstance->findAnnouncements($search, $limit, $skip, $sort, $select, $or, $and);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnnouncementsApi->findAnnouncements: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
search string Filter results by the specified value. [optional]
limit int $limit will return only the number of results you specify. [optional]
skip int $skip will skip the specified number of results. [optional]
sort object $sort will sort based on the object you provide. It can contain a list of properties by which to sort mapped to the order (1 ascending, -1 descending). [optional]
select string[] $select allows to pick which fields to include in the result. [optional]
or object[] Find all records that match any of the given criteria. [optional]
and object[] Find all records that match all of the given criteria. [optional]

Return type

\OpenAPI\Client\CircuitID\FindAnnouncements200Response

Authorization

jwt

HTTP request headers

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

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

getAnnouncement()

getAnnouncement($id): \OpenAPI\Client\CircuitID\GetAnnouncement200Response

Get object by id

Get an object from the REST API Endpoint by its unique id.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\AnnouncementsApi(
    // 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 | The ObjectId (unique 12 bytes ID) of record you would like to GET.

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

Parameters

Name Type Description Notes
id string The ObjectId (unique 12 bytes ID) of record you would like to GET.

Return type

\OpenAPI\Client\CircuitID\GetAnnouncement200Response

Authorization

jwt

HTTP request headers

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

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

patchAnnouncement()

patchAnnouncement($id, $announcementsCreateOrPatch): \OpenAPI\Client\CircuitID\GetAnnouncement200Response

Patch object's data

Make updates to specific fields within the record without replacing the entire dataset.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\AnnouncementsApi(
    // 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 | The ObjectId (unique 12 bytes ID) of record you would like to GET.
$announcementsCreateOrPatch = new \OpenAPI\Client\CircuitID\AnnouncementsCreateOrPatch(); // \OpenAPI\Client\CircuitID\AnnouncementsCreateOrPatch | The request data.

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

Parameters

Name Type Description Notes
id string The ObjectId (unique 12 bytes ID) of record you would like to GET.
announcementsCreateOrPatch \OpenAPI\Client\CircuitID\AnnouncementsCreateOrPatch The request data.

Return type

\OpenAPI\Client\CircuitID\GetAnnouncement200Response

Authorization

jwt

HTTP request headers

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

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

removeAnnouncement()

removeAnnouncement($id): \OpenAPI\Client\CircuitID\GetAnnouncement200Response

Delete object by id

Delete an object by id, removing it from the service.

Example

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


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


$apiInstance = new OpenAPI\Client\Api\AnnouncementsApi(
    // 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 | The ObjectId (unique 12 bytes ID) of record you would like to GET.

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

Parameters

Name Type Description Notes
id string The ObjectId (unique 12 bytes ID) of record you would like to GET.

Return type

\OpenAPI\Client\CircuitID\GetAnnouncement200Response

Authorization

jwt

HTTP request headers

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

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