Skip to content

Latest commit

 

History

History
194 lines (142 loc) · 6.89 KB

SearchApi.md

File metadata and controls

194 lines (142 loc) · 6.89 KB
Raw

Ageras\Api\SearchApi

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

Method HTTP request Description
searchIndex GET /search
searchSuggestIndex GET /search/suggest
searchTypeaheadIndex GET /search/typeahead

searchIndex

\Ageras\Api\SearchResult searchIndex($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\SearchApi();
$criteria = [
        '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->searchIndex($criteria);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SearchApi->searchIndex: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
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\SearchResult

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]

searchSuggestIndex

\Ageras\Api\SearchResult searchSuggestIndex($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\SearchApi();
$criteria = [
        'limit' => 56; // int | Limit the number of suggest resources pr. page.
        'geo_code' => "geo_code_example"; // string | Geo Location Code ( ISO 3166 ).
        'query' => "query_example"; // string | The search query to search by.
        'type' => "type_example"; // string | Type to search for.
        'partner_state' => "partner_state_example"; // string | Partner state.
        'page' => 56; // int | The page position in the result.
    ];

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

Parameters

Name Type Description Notes
limit int Limit the number of suggest resources pr. page. [optional]
geo_code string Geo Location Code ( ISO 3166 ). [optional]
query string The search query to search by. [optional]
type string Type to search for. [optional]
partner_state string Partner state. [optional]
page int The page position in the result. [optional]

Return type

\Ageras\Api\SearchResult

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]

searchTypeaheadIndex

\Ageras\Api\TypeaheadResult searchTypeaheadIndex($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\SearchApi();
$criteria = [
        'limit' => 56; // int | Limit the number of suggest resources pr. page.
        'geo_code' => "geo_code_example"; // string | Geo Location Code ( ISO 3166 ).
        'query' => "query_example"; // string | The search query to search by.
        'type' => "type_example"; // string | Type to search for.
        'partner_state' => "partner_state_example"; // string | Partner state.
        'page' => 56; // int | The page position in the result.
    ];

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

Parameters

Name Type Description Notes
limit int Limit the number of suggest resources pr. page. [optional]
geo_code string Geo Location Code ( ISO 3166 ). [optional]
query string The search query to search by. [optional]
type string Type to search for. [optional]
partner_state string Partner state. [optional]
page int The page position in the result. [optional]

Return type

\Ageras\Api\TypeaheadResult

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]