Module: LUSI::API::Core::Endpoint

Included in:
LUSI::API::Course::ModuleBase, Enrolment::EnrolmentBase
Defined in:
lib/lusi_api/core/api.rb

Overview

Mixin defining properties for a LUSI API endpoint URL, “extend LUSI::API::Core::Endpoint” to include as class methods

Instance Method Summary collapse

Instance Method Details

#lusi_ws_endpoint ⇒ String

Returns the LUSI API endpoint

Returns:

  • (String) —

    the LUSI API endpoint

Raises:

  • (NotImplementedError) 


163
164
165
 
# File 'lib/lusi_api/core/api.rb', line 163

def lusi_ws_endpoint
  raise NotImplementedError
end

#lusi_ws_method ⇒ String

Returns the LUSI API method

Returns:

  • (String) —

    the LUSI API method

Raises:

  • (NotImplementedError) 


169
170
171
 
# File 'lib/lusi_api/core/api.rb', line 169

def lusi_ws_method
  raise NotImplementedError
end

#lusi_ws_path ⇒ String

Returns the LUSI API URL path

Returns:

  • (String) —

    the LUSI API URL path

Raises:

  • (NotImplementedError) 


175
176
177
 
# File 'lib/lusi_api/core/api.rb', line 175

def lusi_ws_path
  raise NotImplementedError
end

#lusi_ws_xml_root ⇒ String

Returns the root element name of the LUSI API XML response

Returns:

  • (String) —

    the root XML element name

Raises:

  • (NotImplementedError) 


181
182
183
 
# File 'lib/lusi_api/core/api.rb', line 181

def lusi_ws_xml_root
  raise NotImplementedError
end