ClearCacheApi.md

OpenAPI\Client\ClearCacheApi

All URIs are relative to https://api.inda.ai, except if the operation defines another base path.

Method	HTTP request	Description
clearSearchResultsDELETE()	DELETE /hr/v2/index/{indexname}/resumes/search/scroll/	Clear Search Results

clearSearchResultsDELETE()

clearSearchResultsDELETE($indexname, $search_id): \OpenAPI\Client\Model\CacheDeletion

Clear Search Results

This method deletes the SearchID and the cache previously (and eventually) created by all those API calls that have a SearchID key in their response. They include: + Full-Text Search on Resumes + Full-Text Search on JobAds + Search Resumes + Search Applicants + Search Applications + Get JobAds + Get Applicants + Get Applications When a user leaves a search page linked to INDA API, it is a good practice to delete the search cache using this method.

Example

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


// Configure Bearer authorization: APIKey
$config = OpenAPI\Client\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new OpenAPI\Client\Api\ClearCacheApi(
    // 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
);
$indexname = 'indexname_example'; // string
$search_id = 'search_id_example'; // string

try {
    $result = $apiInstance->clearSearchResultsDELETE($indexname, $search_id);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ClearCacheApi->clearSearchResultsDELETE: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
indexname	string
search_id	string

Return type

\OpenAPI\Client\Model\CacheDeletion

Authorization

APIKey

HTTP request headers

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

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