Method: ETAPI::Session#subscriber_retrieve

Defined in:
lib/etapi/calls/subscriber.rb

#subscriber_retrieve(*args) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/etapi/calls/subscriber.rb', line 153

def subscriber_retrieve(*args)
  
  # options
  options         = args.extract_options!
  @subscriber_id  = options[:subscriber_id]
  @account_id     = options[:account_id] ||= ""
  
  # check for required options
  required_options = ["subscriber_id"]
  return false unless check_required(required_options)
  
  # merge parameters and values
  @parameters = {
    "search_type"   => "subid",
    "search_value"  => @subscriber_id,
    "search_value2" => ""
  }
  
  response = build_call("subscriber", "retrieve", {:ignore_parse => true})
  Hash.from_xml(response)['exacttarget']['system']['subscriber'].first rescue false
  
end