Class: RepsClient::Community

Inherits:
Modelish::Base
  • Object
show all
Defined in:
lib/reps_client/community.rb

Overview

A community (i.e. location) as configured in the MDI Achieve REPS service.

Instance Method Summary collapse

Instance Method Details

#address1 ⇒ String

Returns the first line of the community’s street address.

Returns:

  • (String) —

    the first line of the community’s street address



14
 
# File 'lib/reps_client/community.rb', line 14

property :address1, :from => :community_address1, :type => String

#address2 ⇒ String

Returns the second line of the community’s street address.

Returns:

  • (String) —

    the second line of the community’s street address



17
 
# File 'lib/reps_client/community.rb', line 17

property :address2, :from => :community_address2, :type => String

#city ⇒ String

Returns the city where the community is located.

Returns:

  • (String) —

    the city where the community is located



20
 
# File 'lib/reps_client/community.rb', line 20

property :city, :from => :community_city, :type => String

#community_id ⇒ Integer

Note:

This ID will be required as an argument in most service calls.

Returns the unique identifier for the community in REPS.

Returns:

  • (Integer) —

    the unique identifier for the community in REPS.



8
 
# File 'lib/reps_client/community.rb', line 8

property :community_id, :from => :community_idy, :type => Integer

#name ⇒ String

Returns the name of the community.

Returns:

  • (String) —

    the name of the community



11
 
# File 'lib/reps_client/community.rb', line 11

property :name, :type => String

#state ⇒ String

Returns the state or territory where the community is located.

Returns:

  • (String) —

    the state or territory where the community is located



23
 
# File 'lib/reps_client/community.rb', line 23

property :state, :from => :community_state, :type => String

#zip ⇒ String

Returns the zip or postal code of the community.

Returns:

  • (String) —

    the zip or postal code of the community



26
 
# File 'lib/reps_client/community.rb', line 26

property :zip, :from => :community_zip, :type => String