Sierra Interactive - API Sample

This sample demonstrates how to send Sierra Interactive API requests from javascript programs. Pelease refer the API documentation for details.

General notes

Work with Lead API Methods

Test leads API methods below:

• Pressing the Add Lead button will call the Add Lead API method by passing preset values in the addNewLead javascript function. On success, id of the newly added lead will be populated in the Lead ID text field
• Pressing the Update Lead will call the Update Lead API method. It will update the lead identified by lead-id or lead-email value specified in the text field. The lead will be updated by passing pre-set values in the updateExistingLead javascript function.
• Pressing the Get Lead will call the Get Lead API method. It will retrive the details of lead identified by lead-id or lead-email value specified in the text field. And, populate them in the Lead API Response text area. Please check the getLead javascript function.
• Pressing the Find Leads will call the Find Lead API method. It will retrive the leads matching the search criteria specified in the findLeads javascript function. The matching lead records will be populated in the Lead API Response text area.

Lead Id or Email

Add Lead Update Lead Get Lead Find Leads

• Pressing the Get Lead & Validate Password will call the Get Lead API method. It will retrive the details of lead identified by lead-id or lead-email value specified in the text field and compare lead's password with the value specified in the Password to validate field.

Lead Id or Email Password to validate

Get Lead & Validate Password

Work with Saved Listings API Methods

• Pressing the Add Saved Listing button will call the Add Saved Listing API method by passing the values specified in the text fields. Please check the savedListingsApi.add javascript function.
• Pressing the Remove Saved Listing button will call the Remove Saved Listing API method by passing the values specified in the text fields. Please check the savedListingsApi.remove javascript function.
• Pressing the Get Saved Listings button will call the Get Saved Listings API method. It will retrive the saved listings for the lead identified by lead-id or lead-email value specified in the text field. And, populate them in the Saved Listing API Response text area. Please check the savedListingsApi.get javascript function.

Lead Id or Email

MLS Number

MLS Region

Add Saved Listing Remove Saved Listing Get Saved Listings

Work with Hidden Listings API Methods

• Pressing the Add Hidden Listing button will call the Add Hidden Listing API method by passing the values specified in the text fields. Please check the hiddenListingsApi.add javascript function.
• Pressing the Remove Hidden Listing button will call the Remove Hidden Listing API method by passing the values specified in the text fields. Please check the hiddenListingsApi.remove javascript function.
• Pressing the Get Hidden Listings button will call the Get Hidden Listings API method. It will retrive the hidden listings for the lead identified by lead-id or lead-email value specified in the text field. And, populate them in the Hidden Listing API Response text area. Please check the hiddenListingsApi.get javascript function.

Lead Id or Email

MLS Number

MLS Region

Add Hidden Listing Remove Hidden Listing Get Hidden Listings

Work with Listings API Methods

• Pressing the Price Changes button will call the Retrieve Listing Price Change History API method by passing the values specified in the text fields. Please check the listings.priceChanges javascript function.
• Pressing the More Info button will call the Submit More Info Request API method by passing the preset values in the requestInfo javascript function. Please check the listings.requestInfo javascript function.
• Pressing the Schedule Showing button will call the Submit Schedule a Showing Request API method by passing the preset values in the scheduleShowing javascript function. Please check the listings.scheduleShowing javascript function.

MLS Region

MLS Number

Price Changes More Info Schedule Showing

Work with Agent API Method

Test Agent API method below:

• Pressing the Find Agents will call the Find Agent API method. It will retrive the agents matching the search criteria specified in the findAgents javascript function. The matching agent records will be populated in the Agent API Response text area.

Find Agents

Work with Saved Search API Methods

Test saved search API methods below:

• Pressing the Add Saved Search button will call the Add Saved Search API method by passing preset values in the savedSearchApi.add javascript function. On success, id of the newly added saved search will be populated in the Saved Search ID text field
• Pressing the Update Saved Search will call the Update Saved Search API method. It will update the saved search identified by saved-search id value specified in the text field. The saved search will be updated by passing pre-set values in the savedSearchApi.update javascript function.
• Pressing the Get Saved Search will call the Get Saved Search API method. It will retrive the details of saved search identified by saved search id value specified in the text field. And, populate them in the Saved Search API Response text area. Please check the savedSearchApi.get javascript function.
• Pressing the Find Saved Searches will call the Find Saved Search API method. It will retrive the saved-searches matching the search criteria specified in the savedSearchApi.find javascript function. The matching saved-search records will be populated in the Saved Search API Response text area.
• Pressing the Remove Saved Search button will call the Remove Saved Search API method by passing the values specified in the text field. Please check the savedSearchApi.remove javascript function.

Lead Id

Saved Search ID

MLS Regions

Add Saved Search Update Saved Search Get Saved Search Find Saved Searchs Remove Saved Searchs

Work with Office API Method

Test Office API method below:

• Pressing the Find Offices will call the Find Office API method. It will retrive the offices matching the search criteria specified in the findOffices javascript function. The matching office records will be populated in the Office API Response text area.

Office Type

Office Name

Office MLS ID

Office Email

Find Offices

Work with Phone Call API Methods

Test phone call API methods below:

• Pressing the Get Phone Call will call the Get Phone Call API method. It will retrive the details of phone call identified by phone call id value specified in the text field. And, populate them in the Phone Call API Response text area. Please check the phoneCallAPi.get javascript function.

Phone Call Id

Get Phone Call

Work with WebHook API Methods

Test WebHook API methods below:

• Pressing the Add Subscription button will call the Add Subscription API method by passing preset values in the addNewWebHookSubscription javascript function and the URL taken from the URL input. Use optional Except System Name input to filter out events. On success, subscription details will be shown in the WebHook API Response text area.
• Pressing the Remove Subscriptions will call the Remove Subscription API method. It will remove the subscriptions configured with the URL taken from the URL input. Uses the same Except System Name input to filter out the subscriptions from the list. On success, matching subscriptions will be removed and their count will be shown in the WebHook API Response text area.
• Pressing the List Subscriptions will call the Find Subscriptions API method. All subscriptions will be populated in the WebHook API Response text area.

URL

Except System Name

AutoDelete HTTP Statuses

Add Subscription Remove Subscriptions Find Subscriptions

Work with Lead Tags API Method

Test Lead Tags API method below:

• Pressing the Find Tags will call the Find Lead Tags API method. It will retrive the tags matching the search criteria specified in the below input fields. The matching tags records will be populated in the Lead Tags API Response text area.

Name Contains

Tag Names (comma separated)

Tag Ids (comma separated)

Find Lead Tags

Work with Users API Method

Test Users API method below:

• Pressing the Get User will call the Get User API method. It will retrieve the details of lead identified by user-id value specified in the text field. And, populate them in the User API Response text area. Please check the getUser javascript function.
• Pressing the Find Users will call the Find Users API method. It will retrieve the users matching the search criteria specified in the findUsers javascript function. The matching users records will be populated in the Users API Response text area.

User Id

Get User

User Name

Email

User Ids

Pond Id

Find Users

Work with Lead Ponds API Method

Test Ponds API method below:

• Pressing the Get Pond will call the Get Lead Pond API method. It will retrieve the details of lead pond identified by pond-id value specified in the text field. And, populate them in the Lead Ponds API Response text area. Please check the getLeadPond javascript function.
• Pressing the Find Ponds will call the Find Lead Ponds API method. It will retrieve the ponds matching the search criteria specified in the findLeadPonds javascript function. The matching lead pond records will be populated in the Lead Ponds API Response text area.

Pond Id

Get Pond

Name

Pond Ids

Find Ponds

Work with Lead Site Visit API Method

Test Lead Site Visit API method below:

• Pressing the Add Site Visit button will call the Add Site Visit API method. It will add a site visit for the specified lead with the data passed in addLeadSiteVisit javascript function.

Lead Id or Email

Site URL

Visit Date/Time

Add Site Visit