Skip to content

CommunicationWebsiteApi.md

Latest commit

 

History

History
114 lines (80 loc) · 2.95 KB

CommunicationWebsiteApi.md

File metadata and controls

114 lines (80 loc) · 2.95 KB

OsunyApi::CommunicationWebsiteApi

All URIs are relative to https://demo.osuny.org/api/osuny/v1

Method HTTP request Description
communication_websites_get GET /communication/websites Lists the websites
communication_websites_id_get GET /communication/websites/{id} Shows a website

communication_websites_get

Array<CommunicationWebsite> communication_websites_get(opts)

Lists the websites

Example

# load the gem
require 'osuny_api'
# setup authorization
OsunyApi.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['X-Osuny-Token'] = '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['X-Osuny-Token'] = 'Bearer'
end

api_instance = OsunyApi::CommunicationWebsiteApi.new
opts = { 
  page_num: 1, # Integer | Page number
  per_page: 10000 # Integer | Number of items per page
}

begin
  #Lists the websites
  result = api_instance.communication_websites_get(opts)
  p result
rescue OsunyApi::ApiError => e
  puts "Exception when calling CommunicationWebsiteApi->communication_websites_get: #{e}"
end

Parameters

Name Type Description Notes
page_num Integer Page number [optional] [default to 1]
per_page Integer Number of items per page [optional] [default to 10000]

Return type

Array<CommunicationWebsite>

Authorization

api_key

HTTP request headers

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

communication_websites_id_get

CommunicationWebsite communication_websites_id_get(id)

Shows a website

Example

# load the gem
require 'osuny_api'
# setup authorization
OsunyApi.configure do |config|
  # Configure API key authorization: api_key
  config.api_key['X-Osuny-Token'] = '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['X-Osuny-Token'] = 'Bearer'
end

api_instance = OsunyApi::CommunicationWebsiteApi.new
id = 'id_example' # String | Website identifier


begin
  #Shows a website
  result = api_instance.communication_websites_id_get(id)
  p result
rescue OsunyApi::ApiError => e
  puts "Exception when calling CommunicationWebsiteApi->communication_websites_id_get: #{e}"
end

Parameters

Name Type Description Notes
id String Website identifier

Return type

CommunicationWebsite

Authorization

api_key

HTTP request headers

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