Module: Atnd4r

Defined in:
lib/atnd4r.rb

Defined Under Namespace

Modules: AtndAPIUtil Classes: ATNDHTTPError, ATNDParameterError, AtndAPI, AtndEvent, AtndUser

Class Method Summary collapse

Class Method Details

.atnd_api_events=(val = 0) ⇒ Object

ATND の イベント情報 API のパスを設定します。(末尾は ‘/’ である必要があります) 万が一 URL に変更がある場合は独自に設定してください



34
35
36
 
# File 'lib/atnd4r.rb', line 34

def self.atnd_api_events=(val = 0)
  @atnd_api_events = val.to_i
end

.atnd_api_port=(val = 0) ⇒ Object

ATND の ポート番号を設定します。万が一 URL に変更がある場合は独自に設定してください



28
29
30
 
# File 'lib/atnd4r.rb', line 28

def self.atnd_api_port=(val = 0)
  @atnd_api_port = val.to_i
end

.atnd_api_url=(val = "") ⇒ Object

ATND の HOST名（http:// は不要）を設定します。万が一 URL に変更がある場合は独自に設定してください



22
23
24
 
# File 'lib/atnd4r.rb', line 22

def self.atnd_api_url=(val = "")
  @atnd_api_url = val
end

.atnd_api_users=(val = "") ⇒ Object

ATND の 出席情報 API のパスを設定します。(末尾は ‘/’ である必要があります) 万が一 URL に変更がある場合は独自に設定してください



40
41
42
 
# File 'lib/atnd4r.rb', line 40

def self.atnd_api_users=(val = "")
  @atnd_api_users = val
end

.get_event_list(param = {}) ⇒ Object

イベントサーチAPI

イベントサーチAPI を実行します

引数

param

Hashのオブジェクト。一つの検索パラメータに対して、複数の値を渡す場合は、value部分を配列にしてください。

例えば、event_id で検索する場合は、下記のようなパラメータを渡してください

{:event_id => 1}

event_id を複数渡したい場合は配列にします。=> [1,2]

戻り値

Atnd4r::AtndAPI

Atnd4r::AtndAPIオブジェクト

例外

Atnd4r::ATNDHTTPError

API ヘアクセスした際に、400系や500系の応答コードがかえってきた場合に発生します

Atnd4r::ATNDParameterError

API 実行結果に Error メッセージが入っていた場合に発生します



61
62
63
64
65
66
67
 
# File 'lib/atnd4r.rb', line 61

def self.get_event_list(param = {})
  xml = get_xml(@atnd_api_events, make_query(param))
  event = parse_common_xml(xml)
  event.events = parse_events_xml(xml)

  return event
end

.get_user_list(param = {}) ⇒ Object

出欠確認API

出欠確認API を実行します

引数

param

Hashのオブジェクト。一つの検索パラメータに対して、複数の値を渡す場合は、value部分を配列にしてください。

例えば、user_id で検索する場合は、下記のようなパラメータを渡してください

{:user_id => 1}

user_id を複数渡したい場合は配列にします。=> [1,2]

戻り値

Atnd4r::AtndAPI

Atnd4r::AtndAPIオブジェクト

例外

Atnd4r::ATNDHTTPError

API ヘアクセスした際に、400系や500系の応答コードがかえってきた場合に発生します

Atnd4r::ATNDParameterError

API 実行結果に Error メッセージが入っていた場合に発生します



82
83
84
85
86
87
88
 
# File 'lib/atnd4r.rb', line 82

def self.get_user_list(param = {})
  xml = get_xml(@atnd_api_users, make_query(param))
  event = parse_common_xml(xml)
  event.events = parse_users_xml(xml)

  return event
end