Agent Web Service

This Web Service, located at https://secure.idxre.com/ihws/AgentWebService.cfc?wsdl, exposes the following methods:

· getAllAgents – returns XML containing all of client's agents.

Argument List:

o uid – company’s iHomefinder client ID number.

o sid - company’s iHomefinder password.

· getAgentsByID - returns XML containing a single agent record based on company's internal agent id.

Argument List:

o uid – company’s iHomefinder client ID number.

o sid - company’s iHomefinder password.

o AgentID – company’s internal agent id (AgentCompanyCode).

· getAgentsByOffice - returns XML containing all of client's agents based on company's internal office id.

Argument List:

o uid – company’s iHomefinder client ID number.

o sid - company’s iHomefinder password.

o OfficeID – company’s internal office id (OfficeCompanyCode).

· getAgentsByLanguage - returns XML containing all of client's agents based on language id (Use getLanguages method to get LanguageID).

Argument List:

o uid – company’s iHomefinder client ID number.

o sid - company’s iHomefinder password.

o LanguageID – iHomefinder language id (LanguageID).

· getLanguages - returns XML containing all available languages and corresponding language IDs (Use getAgentByLanguage to get all agents for specific LanguageID).

Argument List:

o uid – company’s iHomefinder client ID number.

o sid - company’s iHomefinder password.

· updateAgents - adds or updates agent info based on client's internal agent and office codes.

Argument List:

o uid – company’s iHomefinder client ID number.

o sid - company’s iHomefinder password.

o XmlDataString - an XML string that specifies the data values for update. The XmlDataString must be formatted as XML, must have a root element of "agentlist", and must contain the child elements agentcompanycode (company's internal agent code) and officecompanycode (company’s internal office code). Child elements are:

q firstname – Agent’s first name

q lastname – Agent’s last name

q designation – Agent’s designation/title (GRE, Realtorâ, President, etc.)

q photo – URL to agent’s photo

q head – HTML for header of agent’s bio page

q body – HTML for body of agent’s bio page

q email – Agent’s email address

q hasownsite – Enables link directly to agent’s own web site from roster (1=on, 0=off). If this is off and a URL is provided, link appears on agent’s bio page.

q URL – URL of agent’s web site

q enableagentlink – Enables link to agent’s bio page from roster (1=on, 0=off)

q officephone – Agent’s office phone number

q officefax – Agent’s office fax number

q homeoffphone – Agent’s home office phone number

q homefax – Agent’s home office fax number

q cellphone – Agent’s cell phone number

q address – Agent’s address (defaults to office or client address if blank)

q city – Agent’s city

q state – Agent’s state

q zip – Agent’s zip code

q agentusername – Agent’s username

q agentpassword – Agent’s password

q ccemail_yn – Enables CC email updates to be sent to agent

q role – Role in company (1=agent, 2=staff, 3=management)

q agentselector_yn – Show agent on Sign-up dropdown selector

q agentdailyemailheader – header of email update messages from agent

q agentdailyemailfooter – footer of email update messages from agent

q agentcompanycode – company’s internal ID for agent

q officecompanycode – company’s internal ID for agent’s office

q modbio_yn – Enables agent to modify own bio page

q moduserpass_yn – Enables agent to change own username & password

q modlistings_yn yn – Enables agent to enhance own listings

q modsubscribers_yn yn – Enables agent to manage own subscribers

q mlscode1 & mlsid1 – MLS code* and agent’s MLS ID for primary MLS board

q mlscode2 & mlsid2 – MLS code* and agent’s MLS ID for secondary MLS board

q mlscode3 & mlsid3 – MLS code* and agent’s MLS ID for tertiary MLS board

*MLS codes are strings used to identify MLS boards, such as: SANDICOR, SOCAL, GSBR, DESERT, MRMLS

· deleteAgents - deletes agent info based on client's internal agent codes.

Argument List:

o uid – company’s iHomefinder client ID number.

o sid - company’s iHomefinder password.

o XmlDataString - an XML string that specifies the data values for update. The XmlDataString must be formatted as XML, must have a root element of "agentlist", and must contain the child element agentcompanycode (company's internal agent code).

An example that consumes the webservice using Cold Fusion is:

<cfinvoke webservice="https://secure.idxre.com/ihws/AgentWebService.cfc?wsdl"

  method="updateAgents" uid="1" sid="password"

  XmlDataString="XML_Data"

  returnVariable="UpdateAgents">

</cfinvoke>

Where the clientid is 1, the password is “password”, and XML_Data is the XML data.

An example XML data file can be viewed here.