ExRets v0.1.1 ExRets.SearchArguments View Source

Arguments for a RETS Search Transaction.

Link to this section Summary

Types

class()

Specifies the class of the resource to search. Required.

count()

Controls whether the server's response includes a count.

format()

Selects one of the three supported data return formats for the query response.

limit()

Requests the server to apply or suspend a limit on the number of records returned in the search.

offset()

Retrieve records beginning with the record number indicated, with a value of 1 indicating to start with the first record.

payload()

Request a specific XML format for the return set.

query()

Query as specified by the language denoted in query_type.

query_type()

Designates the query language used in query.

restricted_indicator()

Used in place of withheld field values.

search_type()

Specifies the resource to search. Required.

select()

A comma-separated list of fields for the server to return.

standard_names()

Specifies whether to use standard names or system names.

t()

Arguments for a RETS Search Transaction.

Functions

encode_query(search_arguments)

Encodes search arguments t/0 into a query string.

Link to this section Types

class()

(since 0.1.0)

class() :: String.t()

Specifies the class of the resource to search. Required.

count()

(since 0.1.0)

count() :: :no_record_count | :include_record_count | :only_record_count

Controls whether the server's response includes a count.

Possible values:

:no_record_count - no record count returned
:include_record_count - record-count is returned in addition to the data
:only_record_count - only a record-count is returned; no data is returned

format()

(since 0.1.0)

format() :: String.t()

Selects one of the three supported data return formats for the query response.

Possible values:

COMPACT
COMPACT-DECODED
STANDARD-XML

limit()

(since 0.1.0)

limit() :: integer() | String.t()

Requests the server to apply or suspend a limit on the number of records returned in the search.

offset()

(since 0.1.0)

offset() :: non_neg_integer()

Retrieve records beginning with the record number indicated, with a value of 1 indicating to start with the first record.

payload()

(since 0.1.0)

payload() :: String.t() | nil

Request a specific XML format for the return set.

Only set payload OR format and optionally select.

query()

(since 0.1.0)

query() :: String.t() | nil

Query as specified by the language denoted in query_type.

query_type()

(since 0.1.0)

query_type() :: String.t() | nil

Designates the query language used in query.

restricted_indicator()

(since 0.1.0)

restricted_indicator() :: String.t() | nil

Used in place of withheld field values.

search_type()

(since 0.1.0)

search_type() :: String.t()

Specifies the resource to search. Required.

select()

(since 0.1.0)

select() :: String.t() | nil

A comma-separated list of fields for the server to return.

standard_names()

(since 0.1.0)

standard_names() :: boolean()

Specifies whether to use standard names or system names.

This argument affects to all names used in search_type, class, query, and select arguments.

Possible values:

false - system names
true - standard names

t()

(since 0.1.0)

t() :: %ExRets.SearchArguments{
  class: class(),
  count: count(),
  format: format(),
  limit: limit(),
  offset: offset(),
  payload: payload(),
  query: query(),
  query_type: query_type(),
  restricted_indicator: restricted_indicator(),
  search_type: search_type(),
  select: select(),
  standard_names: standard_names()
}

Arguments for a RETS Search Transaction.

Link to this section Functions

encode_query(search_arguments)

(since 0.1.0)

encode_query(search_arguments :: t()) :: String.t()

Encodes search arguments t/0 into a query string.

Examples

iex> search_arguments = %ExRets.SearchArguments{
...>   search_type: "Property",
...>   class: "Residential"
...> }
iex> ExRets.SearchArguments.encode_query(search_arguments)
"Class=Residential&Count=0&Format=COMPACT-DECODED&Limit=NONE&Offset=1&QueryType=DMQL2&SearchType=Property&StandardNames=0"