ExRets v0.1.1 ExRets.RetsResponse View Source

The parsed response of a RETS request.

Link to this section Summary

Types

Included to provide a mechanism to pass additional information to the client in the event that the request is processed OK but some condition still exist that may require an action by the client.

reply_text()

Human-readable meaning of the reply_code/0

response()

Main content of the RETS response.

t()

Parsed response of a RETS request.

Link to this section Types

reply_code()

(since 0.1.0)

reply_code() :: non_neg_integer()

Included to provide a mechanism to pass additional information to the client in the event that the request is processed OK but some condition still exist that may require an action by the client.

A value of '0' indicates success.

reply_text()

(since 0.1.0)

reply_text() :: String.t()

Human-readable meaning of the reply_code/0

response()

(since 0.1.0)

response() ::
  ExRets.LoginResponse.t()
  | ExRets.LogoutResponse.t()
  | ExRets.SearchResponse.t()

Main content of the RETS response.

t()

(since 0.1.0)

t() :: %ExRets.RetsResponse{
  reply_code: reply_code(),
  reply_text: reply_text(),
  response: response()
}

Parsed response of a RETS request.