API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformAgent

Summary

Methods
Properties
Constants
headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
__construct()
find()
search()
$moxi_works_agent_id
$moxi_works_office_id
$client_agent_id
$client_office_id
$client_company_id
$mls_agent_id
$license
$mls_name
$mls_abbreviation
$agent_id
$office_id
$company_id
$alt_phone_number
$lead_routing_email_address
$gc_goal
$office_address_street
$office_address_street2
$office_address_city
$office_address_state
$office_address_zip
$name
$mobile_phone_number
$home_phone_number
$fax_phone_number
$main_phone_number
$office_phone_number
$primary_email_address
$secondary_email_address
$twitter
$google_plus
$facebook
$home_page
$profile_image_url
$profile_thumb_url
$title
$uuid
$has_engage_access
$available_mls
$alternate_offices
$gci_goal
$region
$buyer_commission_rate
$seller_commission_rate
$first_name
$last_name
No constants found
No protected methods found
No protected properties found
N/A
sendRequest()
No private properties found
N/A

Properties

$moxi_works_agent_id

$moxi_works_agent_id : string

Type

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

$moxi_works_office_id

$moxi_works_office_id : string

Type

string — the UUID of the office which the Agent is associated

$client_agent_id

$client_agent_id : string

Type

string — the id of the agent used by the company of the agent

$client_office_id

$client_office_id : string

Type

string — the id office used by the company of the agent

$client_company_id

$client_company_id : string

Type

string — the id of the company used by the company of the agent

$mls_agent_id

$mls_agent_id : string

Type

string — the agent's MLS ID

$license

$license : string

Type

string — the agent's license number

$mls_name

$mls_name : string

Type

string — agent's primary MLS name

$mls_abbreviation

$mls_abbreviation : string

Type

string — the agent's primary MLS abbreviation

$agent_id

$agent_id : string

Type

string — the agent's ID

$office_id

$office_id : string

Type

string — the agent's Office ID

$company_id

$company_id : string

Type

string — the agent's Company ID

$alt_phone_number

$alt_phone_number : string

Type

string — the agent's alternate phone number

$lead_routing_email_address

$lead_routing_email_address : string

Type

string — the agent's lead routing email address

$gc_goal

$gc_goal : string

Type

string — the agent's GCI goal

$office_address_street

$office_address_street : string

Type

string — the agent's office address, street and number

$office_address_street2

$office_address_street2 : string

Type

string — the agent's office address, suite or office number

$office_address_city

$office_address_city : string

Type

string — the agent's office address, city

$office_address_state

$office_address_state : string

Type

string — the agent's office address, state

$office_address_zip

$office_address_zip : string

Type

string — the agent's office address, zip code

$name

$name : string

Type

string — the agent's name

$mobile_phone_number

$mobile_phone_number : string

Type

string — agent's mobile phone number

$home_phone_number

$home_phone_number : string

Type

string — agent's home phone number

$fax_phone_number

$fax_phone_number : string

Type

string — agent's fax phone number

$main_phone_number

$main_phone_number : string

Type

string — agent's main phone number

$office_phone_number

$office_phone_number : string

Type

string — agent's office phone number

$primary_email_address

$primary_email_address : string

Type

string — agent's primary email address

$secondary_email_address

$secondary_email_address : string

Type

string — agent's secondary email address

$twitter

$twitter : string

Type

string — agent's twitter handel

$google_plus

$google_plus : string

Type

string — agent's google plus page url

$facebook

$facebook : string

Type

string — agent's facebook page url

$home_page

$home_page : string

Type

string — agent's home page url

$profile_image_url

$profile_image_url : string

Type

string — url of a full sized profile image of the agent

$profile_thumb_url

$profile_thumb_url : string

Type

string — url of a thumb sized profile image of the agent

$title

$title : string

Type

string — title -- any business titles associated with the agent

$uuid

$uuid : string

Type

string — uuid -- uuid of the agent

$has_engage_access

$has_engage_access : boolean

Type

boolean — has_engage_access -- whether the agent has access to MoxiWorks Engage

$available_mls

$available_mls : Array

Type

Array — available_mls -- available MLSs for this agent

$alternate_offices

$alternate_offices : Array

Type

Array — alternate_offices -- alternate offices for this agent

$gci_goal

$gci_goal : Integer

Type

Integer — gci_goal -- GCI goal for this agent

$region

$region : String

Type

String — region -- region for this agent

$buyer_commission_rate

$buyer_commission_rate : Float

Type

Float — buyer_commission_rate -- buyer commission rate for this agent

$seller_commission_rate

$seller_commission_rate : Float

Type

Float — seller_commission_rate -- seller commission rate for this agent

$first_name

$first_name : string

Type

string — agent's first name

$last_name

$last_name : string

Type

string — agent's last name

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)

Agent constructor.

Parameters

array $data

find()

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

Find an Agent on Moxi Works Platform.

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

Parameters

array $attributes


moxi_works_agent_id REQUIRED The Moxi Works Agent ID for the agent
agent_uuid REQUIRED The Moxi Works UUID for the agent -- either

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Agent|null

search()

search(array  $attributes = array()) : Array

Search for Agents by Company on Moxi Works Platform.

search can be performed by including moxi_works_company_id and updated_since in a parameter array \MoxiworksPlatform\Agent::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 agents

  <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 agents updated in the last seven days will be included in the response.

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

Array —

paged response array with the format: [ page_number: [Integer], total_pages: [Integer], agents: [Array] containing MoxiworkPlatform\Agent objects ]

sendRequest()

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

Parameters

$method
array $opts
null $url

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\RemoteRequestFailureException

Returns

\MoxiworksPlatform\Agent|null