SubscriptionGroupsApi.md

SubscriptionGroupsApi

All URIs are relative to http://localhost

Method	HTTP request	Description
subscriptionGroupsCountGroupsAsync	GET /api/manage/v1/Subscriptions/{subscriptionId}/count	Returns a number of groups in subscription
subscriptionGroupsGetGroupsList	GET /api/manage/v1/Subscriptions/{subscriptionId}/groups	returns groups of the subscription or subscription user

subscriptionGroupsCountGroupsAsync

Long subscriptionGroupsCountGroupsAsync(subscriptionId)

Returns a number of groups in subscription

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.SubscriptionGroupsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    SubscriptionGroupsApi apiInstance = new SubscriptionGroupsApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | subscripiton id
    try {
      Long result = apiInstance.subscriptionGroupsCountGroupsAsync(subscriptionId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionGroupsApi#subscriptionGroupsCountGroupsAsync");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
subscriptionId	String	subscripiton id

Return type

Long

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Everything is all right	-
400	id is not hex24	-
402	Subscription is blocked	-
403	You don't have permisison to get groups from this subscription (or in your default (1st) subscription)	-
404	there is no subscription with provided id found, or user don't even have a subscription	-

subscriptionGroupsGetGroupsList

GroupsVM subscriptionGroupsGetGroupsList(subscriptionId, userId)

returns groups of the subscription or subscription user

Example

// Import classes:
import cloud.fastreport.ApiClient;
import cloud.fastreport.ApiException;
import cloud.fastreport.Configuration;
import cloud.fastreport.auth.*;
import cloud.fastreport.models.*;
import cloud.fastreport.client.SubscriptionGroupsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");
    
    // Configure HTTP basic authorization: ApiKey
    HttpBasicAuth ApiKey = (HttpBasicAuth) defaultClient.getAuthentication("ApiKey");
    ApiKey.setUsername("YOUR USERNAME");
    ApiKey.setPassword("YOUR PASSWORD");

    // Configure HTTP bearer authorization: JWT
    HttpBearerAuth JWT = (HttpBearerAuth) defaultClient.getAuthentication("JWT");
    JWT.setBearerToken("BEARER TOKEN");

    SubscriptionGroupsApi apiInstance = new SubscriptionGroupsApi(defaultClient);
    String subscriptionId = "subscriptionId_example"; // String | subscripiton id
    String userId = "userId_example"; // String | user Id (optional)
    try {
      GroupsVM result = apiInstance.subscriptionGroupsGetGroupsList(subscriptionId, userId);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling SubscriptionGroupsApi#subscriptionGroupsGetGroupsList");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
subscriptionId	String	subscripiton id
userId	String	user Id (optional)	[optional]

Return type

GroupsVM

Authorization

ApiKey, JWT

HTTP request headers

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

HTTP response details

Status code	Description	Response headers
200	Everything is all right (list of groups may be empty)	-
400	id is not hex24	-
402	Subscription is blocked	-
403	You don't have permisison to get groups from this subscription (or in your default (1st) subscription)	-
404	there is no subscription with provided id found, or user don't even have a subscription	-