\MoxiworksPlatformSoldListing

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
$single_story
$living_area
$view_yn
$year_built
$sold_date
$sold_price
$title
$company_listing_attributes
$listing_url
$status
$public_title
$secondary_list_agent_full_name
$community
$list_office_aor_area
$virtual_tour_url
$listing_images
$property_features
$open_house

No constants found

No protected methods found

No protected properties found

N/A

sendRequest()
underscoreAttributeNames()

No private properties found

N/A

File: SoldListing.php
Package: Default
Class hierarchy: \MoxiworksPlatform\Resource

\MoxiworksPlatform\SoldListing

Tags

None found

Properties

$moxi_works_listing_id

$moxi_works_listing_id : string

Type

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

$lot_size_acres

$lot_size_acres : float

Type

float — the property acreage of the SoldListing

$address

$address : string

Type

string — the street address of the SoldListing

$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 SoldListing

$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 SoldListing 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 SoldListing

$list_price

$list_price : integer

Type

integer — listed price

$listing_id

$listing_id : string

Type

string — mls number for the SoldListing

$list_agent_full_name

$list_agent_full_name : string

Type

string — name of SoldListing agent

$list_agent_uuid

$list_agent_uuid : string

Type

string — moxi works agent id of SoldListing 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 SoldListing is listed with

$internet_entire_listing_display_yn

$internet_entire_listing_display_yn : boolean

Type

boolean — whether to display the SoldListing on the internet

$on_market

$on_market : boolean

Type

boolean — whether the SoldListing 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 SoldListing 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

$sold_date

$sold_date : string

Type

string — representing the date the listing was sold

$sold_price

$sold_price : integer

Type

integer — price listing sold for

$title

$title : string

Type

string — Title of this listing

$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 :

Type

Tags

string	Details URL for this listing.

$status

$status : string

Type

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

$public_title

$public_title : string

Type

string — Title

$secondary_list_agent_full_name

$secondary_list_agent_full_name : string

Type

string — Secondary listing agent name

$community

$community : string

Type

string — Community the listing is located in

$list_office_aor_area

$list_office_aor_area : string

Type

string — The MLS Area which this listing is in.

$virtual_tour_url

$virtual_tour_url : string

Type

string — Virtual tour URL

$listing_images

$listing_images : array

Type

array — of image arrays associated with the property 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 SoldListing "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" ]

$open_house

$open_house : array

Type

array — of associative arrays with the following format [ "date" => "(string) string representing date of open house" "start_time" => "string representing start time of open house" "end_time" => "string representing end time of open house" ]

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)

SoldListing constructor.

Parameters

array

$data

find()

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

Find a SoldListing on Moxi Works Platform.

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

Parameters

array

$attributes

moxi_works_listing_id REQUIRED The Moxi Works SoldListing ID for the SoldListing

Throws

\MoxiworksPlatform\Exception\ArgumentException: if required parameters are not included
\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\SoldListing|null

search()

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

Search for SoldListings by Company on Moxi Works Platform.

search can be performed by including moxi_works_company_id and sold_since in a parameter array \MoxiworksPlatform\SoldListing::search([moxi_works_company_id: 'abc123', sold_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 SoldListings

  <h2>
optional Task search parameters

sold_since integer Unix timestamp representing the start time for the search. If no sold_since parameter is included in the request, only SoldListings 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 SoldListing ID of the last SoldListing 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\SoldListing —

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

sendRequest()

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

Parameters

	$method
array	$opts
null	$url

Throws

\MoxiworksPlatform\Exception\ArgumentException: if required parameters are not included
\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\SoldListing|null

underscoreAttributeNames()

underscoreAttributeNames(  $array)

Parameters

$array