Swagger\Client\FavoriteApi

All URIs are relative to https://localhost

Method	HTTP request	Description
addFavoriteList	POST /core/addfavoritelist
clearFavoritesInNamedList	POST /core/clearfavoritesinnamedlist
getAllFavoriteLists	GET /core/getallfavoritelists
getFavoriteListForItem	GET /core/getfavoritelistforitem
getFavoritesInList	GET /core/getfavoritesinlist
getFavoritesInNamedList	GET /core/getfavoritesinnamedlist
removeFavoriteList	POST /core/removefavoritelist
replaceFavoriteList	POST /core/replacefavoritelist
setFavorite	POST /core/setfavorite
unsetFavorite	POST /core/unsetfavorite
updateFavoriteList	POST /core/updatefavoritelist

addFavoriteList

string addFavoriteList($name)

User can add new favorite list in the system (HTTP POST)

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$name = "name_example"; // string | Name of the file to be added to favorites.

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

Parameters

Name	Type	Description	Notes
name	string	Name of the file to be added to favorites.

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

clearFavoritesInNamedList

string clearFavoritesInNamedList($name)

User can clear favorites from the named list

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$name = "name_example"; // string | Name of the Favorite List

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

Parameters

Name	Type	Description	Notes
name	string	Name of the Favorite List

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

getAllFavoriteLists

string getAllFavoriteLists($type)

User can get all the favorites list of the system

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$type = "type_example"; // string | Type here is favorites

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

Parameters

Name	Type	Description	Notes
type	string	Type here is favorites

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getFavoriteListForItem

string getFavoriteListForItem($path)

User can get favorite list available for the item

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$path = "path_example"; // string | Specify the path of file

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

Parameters

Name	Type	Description	Notes
path	string	Specify the path of file

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getFavoritesInList

string getFavoritesInList($id)

User can get all the favorites from list

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$id = "id_example"; // string | Id of the Favorite List

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

Parameters

Name	Type	Description	Notes
id	string	Id of the Favorite List

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

getFavoritesInNamedList

string getFavoritesInNamedList($name)

User can get all the favorites from named list

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$name = "name_example"; // string | Name of the Favorite List

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

Parameters

Name	Type	Description	Notes
name	string	Name of the Favorite List

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: Not defined

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

removeFavoriteList

string removeFavoriteList($id)

User can remove favorite list from the system (HTTP POST)

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$id = "id_example"; // string | Id no. of the favorite list to be deleted

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

Parameters

Name	Type	Description	Notes
id	string	Id no. of the favorite list to be deleted

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

replaceFavoriteList

string replaceFavoriteList($id, $count)

User replace favorite list

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$id = "id_example"; // string | Id number of the Favorite list
$count = "count_example"; // string | Number of files

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

Parameters

Name	Type	Description	Notes
id	string	Id number of the Favorite list
count	string	Number of files

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

setFavorite

string setFavorite($name, $id)

User can add file to their Favorite list in the system (HTTP POST)

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$name = "name_example"; // string | Name of the file to be added to favorites.
$id = "id_example"; // string | Id number of the Favorite list

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

Parameters

Name	Type	Description	Notes
name	string	Name of the file to be added to favorites.
id	string	Id number of the Favorite list

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

unsetFavorite

string unsetFavorite($id, $name)

User can remove file from their Favorite list in the system (HTTP POST)

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$id = "id_example"; // string | Id number of the Favorite list
$name = "name_example"; // string | Name of the file to be added to favorites.

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

Parameters

Name	Type	Description	Notes
id	string	Id number of the Favorite list
name	string	Name of the file to be added to favorites.

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

updateFavoriteList

string updateFavoriteList($id, $name)

User can update favorite list

Example

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

$apiInstance = new Swagger\Client\Api\FavoriteApi(
    // 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()
);
$id = "id_example"; // string | Id number of the Favorite list
$name = "name_example"; // string | Name of the file to be added to favorites.

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

Parameters

Name	Type	Description	Notes
id	string	Id number of the Favorite list
name	string	Name of the file to be added to favorites.

Return type

string

Authorization

No authorization required

HTTP request headers

Content-Type: application/x-www-form-urlencoded
Accept: Not defined

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

Files

FavoriteApi.md

Latest commit

History

FavoriteApi.md

File metadata and controls

Swagger\Client\FavoriteApi

addFavoriteList

Example

Parameters

Return type

Authorization

HTTP request headers

clearFavoritesInNamedList

Example

Parameters

Return type

Authorization

HTTP request headers

getAllFavoriteLists

Example

Parameters

Return type

Authorization

HTTP request headers

getFavoriteListForItem

Example

Parameters

Return type

Authorization

HTTP request headers

getFavoritesInList

Example

Parameters

Return type

Authorization

HTTP request headers

getFavoritesInNamedList

Example

Parameters

Return type

Authorization

HTTP request headers

removeFavoriteList

Example

Parameters

Return type

Authorization

HTTP request headers

replaceFavoriteList

Example

Parameters

Return type

Authorization

HTTP request headers

setFavorite

Example

Parameters

Return type

Authorization

HTTP request headers

unsetFavorite

Example

Parameters

Return type

Authorization

HTTP request headers

updateFavoriteList

Example

Parameters

Return type

Authorization

HTTP request headers