Ageras\Api\ContentsApi

All URIs are relative to https://api.ageras.com/v2

Method	HTTP request	Description
contentsPagesAggregationsIndex	GET /contents/pages/aggregations
contentsPagesAggregationsIndex_0	GET /contents/{content_id}/pages/aggregations
contentsPagesGet	GET /contents/pages/{content_page_id}
contentsPagesGet_0	GET /contents/{content_id}/pages/{content_page_id}
contentsPagesIndex	GET /contents/pages
contentsPagesTypesIndex	GET /contents/pages/types

contentsPagesAggregationsIndex

\Ageras\Api\AggregationResult contentsPagesAggregationsIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ContentsApi();
$criteria = [
        'page_id' => "page_id_example"; // string | List of page identification(ID).
        'page_type' => "page_type_example"; // string | Filter pages by their type
        'page_type_id' => "page_type_id_example"; // string | Filter pages by their type id
        'letter' => "letter_example"; // string | Filter pages by first letter
        'geo_code' => "geo_code_example"; // string | Geo Code for the Content Page
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->contentsPagesAggregationsIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentsApi->contentsPagesAggregationsIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
page_id	string	List of page identification(ID).	[optional]
page_type	string	Filter pages by their type	[optional]
page_type_id	string	Filter pages by their type id	[optional]
letter	string	Filter pages by first letter	[optional]
geo_code	string	Geo Code for the Content Page	[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\AggregationResult

Authorization

jwt, login

HTTP request headers

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

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

contentsPagesAggregationsIndex_0

\Ageras\Api\AggregationResult contentsPagesAggregationsIndex_0($content_id , $criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ContentsApi();
$content_id = "content_id_example"; // string | 
$criteria = [
        'page_id' => "page_id_example"; // string | List of page identification(ID).
        'page_type' => "page_type_example"; // string | Filter pages by their type
        'page_type_id' => "page_type_id_example"; // string | Filter pages by their type id
        'letter' => "letter_example"; // string | Filter pages by first letter
        'geo_code' => "geo_code_example"; // string | Geo Code for the Content Page
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->contentsPagesAggregationsIndex_0($content_id , $criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentsApi->contentsPagesAggregationsIndex_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
content_id	string
page_id	string	List of page identification(ID).	[optional]
page_type	string	Filter pages by their type	[optional]
page_type_id	string	Filter pages by their type id	[optional]
letter	string	Filter pages by first letter	[optional]
geo_code	string	Geo Code for the Content Page	[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\AggregationResult

Authorization

jwt, login

HTTP request headers

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

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

contentsPagesGet

\Ageras\Api\ContentPageResource contentsPagesGet($content_page_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ContentsApi();
$content_page_id = "content_page_id_example"; // string | 

try {
    $result = $api_instance->contentsPagesGet($content_page_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentsApi->contentsPagesGet: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
content_page_id	string

Return type

\Ageras\Api\ContentPageResource

Authorization

jwt, login

HTTP request headers

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

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

contentsPagesGet_0

\Ageras\Api\ContentPageResource contentsPagesGet_0($content_id, $content_page_id )

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ContentsApi();
$content_id = "content_id_example"; // string | 
$content_page_id = "content_page_id_example"; // string | 

try {
    $result = $api_instance->contentsPagesGet_0($content_id,  $content_page_id );
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentsApi->contentsPagesGet_0: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
content_id	string
content_page_id	string

Return type

\Ageras\Api\ContentPageResource

Authorization

jwt, login

HTTP request headers

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

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

contentsPagesIndex

\Ageras\Api\ContentPageResult contentsPagesIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ContentsApi();
$criteria = [
        'page_id' => "page_id_example"; // string | List of page identification(ID).
        'page_type' => "page_type_example"; // string | Filter pages by their type
        'page_type_id' => "page_type_id_example"; // string | Filter pages by their type id
        'letter' => "letter_example"; // string | Filter pages by first letter
        'geo_code' => "geo_code_example"; // string | Geo Code for the Content Page
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->contentsPagesIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentsApi->contentsPagesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
page_id	string	List of page identification(ID).	[optional]
page_type	string	Filter pages by their type	[optional]
page_type_id	string	Filter pages by their type id	[optional]
letter	string	Filter pages by first letter	[optional]
geo_code	string	Geo Code for the Content Page	[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ContentPageResult

Authorization

jwt, login

HTTP request headers

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

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

contentsPagesTypesIndex

\Ageras\Api\ContentPageTypeResult contentsPagesTypesIndex($criteria)

Example

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

// Configure API key authorization: jwt
Ageras\Api\Configuration::getDefaultConfiguration()->setApiKey('token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Ageras\Api\Configuration::getDefaultConfiguration()->setApiKeyPrefix('token', 'Bearer');
// Configure HTTP basic authorization: login
Ageras\Api\Configuration::getDefaultConfiguration()->setUsername('YOUR_USERNAME');
Ageras\Api\Configuration::getDefaultConfiguration()->setPassword('YOUR_PASSWORD');

$api_instance = new Ageras\Api\Api\ContentsApi();
$criteria = [
        'page_type_id' => "page_type_id_example"; // string | List of page type identification(ID).
        'geo_code' => "geo_code_example"; // string | geo
        'limit' => 56; // int | The number of resources to be returned.
        'page' => 56; // int | The page position in the result.
        'query' => "query_example"; // string | The search wildcard.
    ];

try {
    $result = $api_instance->contentsPagesTypesIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ContentsApi->contentsPagesTypesIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name	Type	Description	Notes
page_type_id	string	List of page type identification(ID).	[optional]
geo_code	string	geo	[optional]
limit	int	The number of resources to be returned.	[optional]
page	int	The page position in the result.	[optional]
query	string	The search wildcard.	[optional]

Return type

\Ageras\Api\ContentPageTypeResult

Authorization

jwt, login

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

ContentsApi.md

Latest commit

History

ContentsApi.md

File metadata and controls

Ageras\Api\ContentsApi

contentsPagesAggregationsIndex

Example

Parameters

Return type

Authorization

HTTP request headers

contentsPagesAggregationsIndex_0

Example

Parameters

Return type

Authorization

HTTP request headers

contentsPagesGet

Example

Parameters

Return type

Authorization

HTTP request headers

contentsPagesGet_0

Example

Parameters

Return type

Authorization

HTTP request headers

contentsPagesIndex

Example

Parameters

Return type

Authorization

HTTP request headers

contentsPagesTypesIndex

Example

Parameters

Return type

Authorization

HTTP request headers