Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 3.13 KB

AnnouncementApi.md

File metadata and controls

112 lines (76 loc) · 3.13 KB
Raw

SwaggerClient::AnnouncementApi

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

Method HTTP request Description
announcement_get GET /announcement Get site announcements.
announcement_get_urgent GET /announcement/urgent Get urgent (banner) announcements.

announcement_get

Array<Announcement> announcement_get(opts)

Get site announcements.

Example

# load the gem
require 'swagger_client'

api_instance = SwaggerClient::AnnouncementApi.new

opts = { 
  columns: 'columns_example' # String | Array of column names to fetch. If omitted, will return all columns.
}

begin
  #Get site announcements.
  result = api_instance.announcement_get(opts)
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling AnnouncementApi->announcement_get: #{e}"
end

Parameters

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

Return type

Array<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

announcement_get_urgent

Array<Announcement> announcement_get_urgent

Get urgent (banner) announcements.

Example

# load the gem
require 'swagger_client'
# setup authorization
SwaggerClient.configure do |config|
  # Configure API key authorization: apiKey
  config.api_key['api-key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-key'] = 'Bearer'

  # Configure API key authorization: apiNonce
  config.api_key['api-nonce'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-nonce'] = 'Bearer'

  # Configure API key authorization: apiSignature
  config.api_key['api-signature'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api-signature'] = 'Bearer'
end

api_instance = SwaggerClient::AnnouncementApi.new

begin
  #Get urgent (banner) announcements.
  result = api_instance.announcement_get_urgent
  p result
rescue SwaggerClient::ApiError => e
  puts "Exception when calling AnnouncementApi->announcement_get_urgent: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<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