API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformListing

Summary

Methods
Properties
Constants
headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
__construct()
find()
search()
$moxi_works_listing_id
$lot_size_acres
$address
$address2
$agent_created_listing
$city
$state_or_province
$postal_code
$county_or_parish
$latitude
$longitude
$bathrooms_full
$bathrooms_half
$bathrooms_one_quarter
$bathrooms_partial
$bathrooms_total_integer
$bathrooms_three_quarter
$bathrooms_total
$bedrooms_total
$public_remarks
$modification_timestamp
$internet_address_display_yn
$days_on_market
$listing_contract_date
$created_date
$elementary_school
$garage_spaces
$waterfront_yn
$high_school
$association_fee
$list_office_name
$list_price
$listing_id
$list_agent_full_name
$list_agent_uuid
$lot_size_square_feet
$middle_or_junior_school
$list_office_aor
$internet_entire_listing_display_yn
$on_market
$pool_yn
$property_type
$tax_annual_amount
$tax_year
$secondary_list_agent_uuid
$secondary_list_agent_full_name
$single_story
$living_area
$view_yn
$year_built
$open_house
$listing_images
$property_features
$company_listing_attributes
$listing_url
$status
$virtual_tour_url
$public_title
$list_agent_moxi_works_office_id
$list_agent_office_id
$community
$list_office_aor_area
$images_last_modified
No constants found
No protected methods found
No protected properties found
N/A
sendRequest()
underscoreAttributeNames()
No private properties found
N/A

Properties

$moxi_works_listing_id

$moxi_works_listing_id : string

Type

string — the Moxi Works Platform ID of the listing moxi_works_listing_id is the Moxi Works Platform ID of the listing this must be set for any Moxi Works Platform transaction

$lot_size_acres

$lot_size_acres : float

Type

float — the property acreage of the listing

$address

$address : string

Type

string — the street address of the listing

$address2

$address2 : string

Type

string — a second line for the street address if needed

$agent_created_listing

$agent_created_listing : boolean

Type

boolean — whether the agent created the listing

$city

$city : string

Type

string — the city of property address

$state_or_province

$state_or_province : string

Type

string — the state of property address

$postal_code

$postal_code : string

Type

string — zip code of property address

$county_or_parish

$county_or_parish : string

Type

string — county of property address

$latitude

$latitude : string

Type

string — latitude of address

$longitude

$longitude : string

Type

string — longitude of address

$bathrooms_full

$bathrooms_full : integer|null

Type

integer|null — number of full bathrooms null if no data available

$bathrooms_half

$bathrooms_half : integer|null

Type

integer|null — number of half bathrooms null if no data available

$bathrooms_one_quarter

$bathrooms_one_quarter : integer|null

Type

integer|null — number of quarter bathrooms null if no data available

$bathrooms_partial

$bathrooms_partial : integer|null

Type

integer|null — number of partial bathrooms null if no data available

$bathrooms_total_integer

$bathrooms_total_integer : integer

Type

integer — | null number of rooms that are bathrooms | nil if no data available

$bathrooms_three_quarter

$bathrooms_three_quarter : integer|null

Type

integer|null — number of three_quarter bathrooms null if no data available

$bathrooms_total

$bathrooms_total : float

Type

float — number of bathrooms

$bedrooms_total

$bedrooms_total : integer

Type

integer — number of bedrooms

$public_remarks

$public_remarks : string

Type

string — agent generated comments regarding the property

$modification_timestamp

$modification_timestamp : array

Type

array — date represented in format 'MM/DD/YYYY'

$internet_address_display_yn

$internet_address_display_yn : boolean

Type

boolean — whether to display the address publicly

$days_on_market

$days_on_market : integer

Type

integer — number of days the listing has been on market

$listing_contract_date

$listing_contract_date : array

Type

array — date represented in format 'MM/DD/YYYY'

$created_date

$created_date : array

Type

array — date represented in format 'MM/DD/YYYY'

$elementary_school

$elementary_school : string

Type

string — elementary school for the property

$garage_spaces

$garage_spaces : integer

Type

integer — number of garage spaces

$waterfront_yn

$waterfront_yn : boolean|null

Type

boolean|null — whether the property has waterfront acreage

$high_school

$high_school : string

Type

string — High school for the property

$association_fee

$association_fee : integer

Type

integer — HOA fees

$list_office_name

$list_office_name : string

Type

string — name of office responsible for listing

$list_price

$list_price : integer

Type

integer — listed price

$listing_id

$listing_id : string

Type

string — mls number for the listing

$list_agent_full_name

$list_agent_full_name : string

Type

string — name of listing agent

$list_agent_uuid

$list_agent_uuid : string

Type

string — moxi works agent id of listing agent

$lot_size_square_feet

$lot_size_square_feet : integer

Type

integer — square footage of lot

$middle_or_junior_school

$middle_or_junior_school : string

Type

string — Middle school for the property

$list_office_aor

$list_office_aor : string

Type

string — MLS the listing is listed with

$internet_entire_listing_display_yn

$internet_entire_listing_display_yn : boolean

Type

boolean — whether to display the listing on the internet

$on_market

$on_market : boolean

Type

boolean — whether the listing is on market

$pool_yn

$pool_yn : boolean

Type

boolean — whether the property has a pool

$property_type

$property_type : string

Type

string — type of property, could be 'Residential' 'Condo-Coop' 'Townhouse' 'Land' 'Multifamily'

$tax_annual_amount

$tax_annual_amount : integer

Type

integer — annual property tax for the property

$tax_year

$tax_year : integer

Type

integer — assessment year that property_tax reflects

$secondary_list_agent_uuid

$secondary_list_agent_uuid : string

Type

string — moxi works agent id of secondary listing agent

$secondary_list_agent_full_name

$secondary_list_agent_full_name : string

Type

string — If there is a second listing agent, the name of the second listing agent.

$single_story

$single_story : boolean

Type

boolean — whether the building is one story

$living_area

$living_area : integer

Type

integer — square footage of building

$view_yn

$view_yn : boolean

Type

boolean — whether the property has a view

$year_built

$year_built : integer

Type

integer — year the building was built

$open_house

$open_house : array

Type

array — open house arrays associated with the listing in the format [ "date" => "(string) YYYY-MM-DD formatted string representing the date of the open house" "start_time" => "(string) HH:MM:SS formatted string representing the time when the open house starts. This is expressed in the local time where the listing is located." "end_time" => "(string) HH:MM:SS formatted string representing the time when the open house ends. This is expressed in the local time where the listing is located." ]

$listing_images

$listing_images : array

Type

array — of image associative arrays associated with the listing in the format [ "thumb_url" => "(string) url to thumbnail size image -- smallest", "small_url" => "(string) url to small size image -- small", "full_url" => "(string) url to medium size image -- medium", "gallery_url" => "(string) url to large size image -- large", "raw_url" => "(string) url to largest size image -- largest" "title" => (String) human readable title of image "is_main_listing_image" => (Boolean) whether the image is the main image for the listing "embedded_html_content" => (String) Embedded HTML that can be placed into a webpage – this will be used for embedded movies. "caption" => (String) human readable caption for the image "description" => (String) human readable description of the image "width" => (Integer) width of the raw image "height" => (Integer) height of the raw image "mime_type" => (String) MIME or media type of the image ]

$property_features

$property_features : array

Type

array — of associative arrays with the following format [ "property_feature_name" => "(string) name of property feature" "property_feature_values" => "(array) values for property feature" ]

$company_listing_attributes

$company_listing_attributes : array

Type

array — Company specific attributes associated with the listing. These will be defined by the company & should not be expected to be uniform across companies.

$listing_url

$listing_url : string

Type

string — Details URL for this listing.

$status

$status : string

Type

string — Detailed status of the listing; whether it’s active pending

$virtual_tour_url

$virtual_tour_url : string

Type

string — Virtual tour URL for this listing.

$public_title

$public_title : string

Type

string — Title of this listing

$list_agent_moxi_works_office_id

$list_agent_moxi_works_office_id : string

Type

string — list_agent_moxi_works_office_id -- office ID of the listing agent

$list_agent_office_id

$list_agent_office_id : string

Type

string — list_agent_office_id -- office ID of the listing agent

$community

$community : string

Type

string — Community this listing is located in

$list_office_aor_area

$list_office_aor_area : string

Type

string — MLS area of this listing

$images_last_modified

$images_last_modified : integer

Type

integer — Timestamp representing when the images for the listing were last updated

Methods

headers()

headers()

authHeader()

authHeader()

acceptHeader()

acceptHeader()

contentTypeHeader()

contentTypeHeader()

userAgentHeader()

userAgentHeader()

apiConnection()

apiConnection(  $method,   $url,   $attributes)

Parameters

$method
$url
$attributes

checkForErrorInResponse()

checkForErrorInResponse(  $json)

Parameters

$json

underscore()

underscore(  $attr)

Parameters

$attr

__construct()

__construct(array  $data)

Listing constructor.

Parameters

array $data

find()

find(array  $attributes = array()) : \MoxiworksPlatform\Listing|null

Find a Listing on Moxi Works Platform.

find can be performed including the Moxi Works Listing ID in a parameter array \MoxiworksPlatform\Listing::find([moxi_works_listing_id: 'abc123'])

Parameters

array $attributes


moxi_works_listing_id REQUIRED The Moxi Works Listing ID for the listing

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Listing|null

search()

search(array  $attributes = array()) : \MoxiworksPlatform\Listing

Search for Listings by Company on Moxi Works Platform.

search can be performed by including moxi_works_company_id and updated_since in a parameter array \MoxiworksPlatform\Listing::search([moxi_works_company_id: 'abc123', updated_since: 1463595006])

Parameters

array $attributes


moxi_works_company_id REQUIRED string The Moxi Works Company ID for the company in which we are searching for listings

  <h2>
optional Task search parameters


updated_since integer Unix timestamp representing the start time for the search. If no updated_since parameter is included in the request, only listings updated in the last seven days will be included in the response.
last_moxi_works_listing_id string For multi-page responses (where the response value 'last_page' is false), send the listing ID of the last Listing in the previous page.

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\Exception\ArgumentException

if at least one search parameter is not defined

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Listing —

paged response array with the format: [ final_page: [Boolean], listings: [Array] containing MoxiworkPlatform\Listing objects ]

sendRequest()

sendRequest(  $method, array  $opts = array(), null  $url = null) : \MoxiworksPlatform\Listing|null

Parameters

$method
array $opts
null $url

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Listing|null

underscoreAttributeNames()

underscoreAttributeNames(  $array)

Parameters

$array