Skip to content

Latest commit

 

History

History
222 lines (161 loc) · 6.63 KB

SubscriptionApi.md

File metadata and controls

222 lines (161 loc) · 6.63 KB

SubscriptionApi

All URIs are relative to https://hornet-trunk.dev.xtrf.eu/home-api

Method HTTP request Description
areHooksSupported GET /subscription/supports This method can be used to determine if hooks are supported.
getAll4 GET /subscription Returns all subscriptions
subscribe POST /subscription Subscribe to event
unsubscribe DELETE /subscription/{subscriptionId} Unsubscribe from event

areHooksSupported

Boolean areHooksSupported()

This method can be used to determine if hooks are supported.

This method can be used to determine if hooks are supported.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.SubscriptionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

SubscriptionApi apiInstance = new SubscriptionApi();
try {
    Boolean result = apiInstance.areHooksSupported();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionApi#areHooksSupported");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

Boolean

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

getAll4

List<ActiveSubscriptionDTO> getAll4()

Returns all subscriptions

Returns all subscriptions. Subscriptions are automatically removed if they do not work (ie. if 404 status is returned). To improve notification reliability one can use this method to check if subscription is still active and re-subscribe if necessary.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.SubscriptionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

SubscriptionApi apiInstance = new SubscriptionApi();
try {
    List<ActiveSubscriptionDTO> result = apiInstance.getAll4();
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionApi#getAll4");
    e.printStackTrace();
}

Parameters

This endpoint does not need any parameter.

Return type

List<ActiveSubscriptionDTO>

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

subscribe

String subscribe(body)

Subscribe to event

Subscribe to event. Returns subscription Id.

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.SubscriptionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

SubscriptionApi apiInstance = new SubscriptionApi();
SubscriptionDTO body = new SubscriptionDTO(); // SubscriptionDTO | Returns subscription Id.
try {
    String result = apiInstance.subscribe(body);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionApi#subscribe");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
body SubscriptionDTO Returns subscription Id.

Return type

String

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: application/json;charset=UTF-8
  • Accept: application/vnd.xtrf-v1+json;charset=UTF-8

unsubscribe

unsubscribe(subscriptionId)

Unsubscribe from event

Unsubscribe from job status changed event

Example

// Import classes:
//import io.swagger.client.ApiClient;
//import io.swagger.client.ApiException;
//import io.swagger.client.Configuration;
//import io.swagger.client.auth.*;
//import io.swagger.client.api.SubscriptionApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

// Configure API key authorization: X-AUTH-ACCESS-TOKEN
ApiKeyAuth X-AUTH-ACCESS-TOKEN = (ApiKeyAuth) defaultClient.getAuthentication("X-AUTH-ACCESS-TOKEN");
X-AUTH-ACCESS-TOKEN.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//X-AUTH-ACCESS-TOKEN.setApiKeyPrefix("Token");

SubscriptionApi apiInstance = new SubscriptionApi();
String subscriptionId = "subscriptionId_example"; // String | 
try {
    apiInstance.unsubscribe(subscriptionId);
} catch (ApiException e) {
    System.err.println("Exception when calling SubscriptionApi#unsubscribe");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
subscriptionId String

Return type

null (empty response body)

Authorization

X-AUTH-ACCESS-TOKEN

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined