github.com/grokify/go-ringcentral-client@v0.3.31/office/v1/client/docs/APIInfoApi.md (about)

     1  # \APIInfoApi
     2  
     3  All URIs are relative to *https://platform.devtest.ringcentral.com*
     4  
     5  Method | HTTP request | Description
     6  ------------- | ------------- | -------------
     7  [**GetAPIVersion**](APIInfoApi.md#GetAPIVersion) | **Get** /restapi | Get API Versions
     8  [**GetVersionInfo**](APIInfoApi.md#GetVersionInfo) | **Get** /restapi/{apiVersion} | Get Version Info
     9  [**LoadAPIStatus**](APIInfoApi.md#LoadAPIStatus) | **Get** /restapi/v1.0/status | Get Status
    10  
    11  
    12  # **GetAPIVersion**
    13  > GetVersionsResponse GetAPIVersion(ctx, )
    14  Get API Versions
    15  
    16  <p style='font-style:italic;'>Since 1.0.0</p><p>Returns current API version(s) and server info.</p><h4>Usage Plan Group</h4><p>Light</p>
    17  
    18  ### Required Parameters
    19  This endpoint does not need any parameter.
    20  
    21  ### Return type
    22  
    23  [**GetVersionsResponse**](GetVersionsResponse.md)
    24  
    25  ### Authorization
    26  
    27  [OAuth2](../README.md#OAuth2)
    28  
    29  ### HTTP request headers
    30  
    31   - **Content-Type**: Not defined
    32   - **Accept**: application/json
    33  
    34  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    35  
    36  # **GetVersionInfo**
    37  > GetVersionResponse GetVersionInfo(ctx, apiVersion)
    38  Get Version Info
    39  
    40  <p style='font-style:italic;'>Since 1.0.0</p><p>Returns current API version info by apiVersion.</p><h4>Usage Plan Group</h4><p>Light</p>
    41  
    42  ### Required Parameters
    43  
    44  Name | Type | Description  | Notes
    45  ------------- | ------------- | ------------- | -------------
    46   **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc.
    47    **apiVersion** | **string**| API version to be requested, for example &#39;v1.0&#39; | 
    48  
    49  ### Return type
    50  
    51  [**GetVersionResponse**](GetVersionResponse.md)
    52  
    53  ### Authorization
    54  
    55  [OAuth2](../README.md#OAuth2)
    56  
    57  ### HTTP request headers
    58  
    59   - **Content-Type**: Not defined
    60   - **Accept**: application/json
    61  
    62  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    63  
    64  # **LoadAPIStatus**
    65  > LoadAPIStatus(ctx, )
    66  Get Status
    67  
    68  <p style='font-style:italic;'>Since 1.0.27 (Release 8.3)</p><p>Returns the API status; status '200' means the API is working fine, and '503' means it is temporary unavailable.</p><h4>API Group</h4><p>Light</p>
    69  
    70  ### Required Parameters
    71  This endpoint does not need any parameter.
    72  
    73  ### Return type
    74  
    75   (empty response body)
    76  
    77  ### Authorization
    78  
    79  [OAuth2](../README.md#OAuth2)
    80  
    81  ### HTTP request headers
    82  
    83   - **Content-Type**: Not defined
    84   - **Accept**: Not defined
    85  
    86  [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
    87