Skip to content

CustomerFriendsApi.md

Latest commit

 

History

History
64 lines (45 loc) · 2.89 KB

CustomerFriendsApi.md

File metadata and controls

64 lines (45 loc) · 2.89 KB

Swagger\Client\CustomerFriendsApi

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

Method HTTP request Description
getFriendInfo GET /user/customer/friends/{userId} Get friend information

getFriendInfo

\Swagger\Client\Model\UserFriendInfo getFriendInfo($user_id, $if_none_match)

Get friend information

Example

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

// Configure API key authorization: api_key
$config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('Ocp-Apim-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Ocp-Apim-Subscription-Key', 'Bearer');

$apiInstance = new Swagger\Client\Api\CustomerFriendsApi(
    // 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
);
$user_id = "user_id_example"; // string | Your friend user id
$if_none_match = "if_none_match_example"; // string | ETag value to identify the last known version of requested resource.\\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3

try {
    $result = $apiInstance->getFriendInfo($user_id, $if_none_match);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerFriendsApi->getFriendInfo: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

Name Type Description Notes
user_id string Your friend user id
if_none_match string ETag value to identify the last known version of requested resource.\ To avoid useless exchange, we recommend you to indicate the ETag you previously got from this operation.\ If the ETag value does not match the response will be 200 to give you a new content, otherwise the response will be: 304 Not Modified, without any content.\ For more details go to this link: http://tools.ietf.org/html/rfc7232#section-2.3 [optional]

Return type

\Swagger\Client\Model\UserFriendInfo

Authorization

api_key

HTTP request headers

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

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