Skip to content

Latest commit

 

History

History
114 lines (82 loc) · 3.65 KB

AnnouncementApi.md

File metadata and controls

114 lines (82 loc) · 3.65 KB
Raw

AnnouncementApi

All URIs are relative to https://localhost/api/v1

Method HTTP request Description
announcementGet GET /announcement Get site announcements.
announcementGetUrgent GET /announcement/urgent Get urgent (banner) announcements.

announcementGet

List<Announcement> announcementGet(columns)

Get site announcements.

Example

// Import classes:
//import io.swagger.client.ApiException;
//import io.swagger.client.api.AnnouncementApi;


AnnouncementApi apiInstance = new AnnouncementApi();
String columns = "columns_example"; // String | Array of column names to fetch. If omitted, will return all columns.
try {
    List<Announcement> result = apiInstance.announcementGet(columns);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling AnnouncementApi#announcementGet");
    e.printStackTrace();
}

Parameters

Name Type Description Notes
columns String Array of column names to fetch. If omitted, will return all columns. [optional]

Return type

List<Announcement>

Authorization

No authorization required

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript

announcementGetUrgent

List<Announcement> announcementGetUrgent()

Get urgent (banner) announcements.

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.AnnouncementApi;

ApiClient defaultClient = Configuration.getDefaultApiClient();

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

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

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

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

Parameters

This endpoint does not need any parameter.

Return type

List<Announcement>

Authorization

apiKey, apiNonce, apiSignature

HTTP request headers

  • Content-Type: application/json, application/x-www-form-urlencoded
  • Accept: application/json, application/xml, text/xml, application/javascript, text/javascript