Knowledge Base & Support Center

API Specification

CloudIDX Bulk Data API Specification

The following methods are available in the Bulk Data API. The syntax below follows Java conventions. Developers should adapt these method signatures to their particular client-side implementation language. Each function can throw an exception that can be caught and examined.

/**
* login() - Login to the web service. 
*
* @param username - Username
* @param password - Password
* @return context (used in subsequent method calls) 
*/
Integer login( String username, String password )

/**
* logoff() - Logoff from the web service. 
*
* @param context - Context to logoff from 
*/
boolean logoff( Integer context )

/**
* getBoards() - Get list of all authorized MLS System boards. 
*
* @param context - Context for which to get list of boards
* @return array of board identifiers 
*/
Integer[] getBoards( Integer context )

/**
* getBoardData() - Get board data for a specific board. 
*
* @param context - Context to get board data for
* @param boardID - Board ID
* @return board data for specified board as XML 
*/
String getBoardData( Integer context, Integer boardID )

/**
* getHeaders() - Get array of data field headers that are used in listings. 
*
* @param context - Context to get header list for
* @return array of headers 
*/
String[] getHeaders( Integer context )

/**
* getAllListings() - Get all listings for a specific board. Returns up to the first 1000 active listings. Call
* getListingsSince()following a call to this function to get the next 1000 listings (or however many remain if 
* less than 1000). You may need to call getListingsSince() multiple times to retrieve all listings. 
*
* @param context - Context
* @param boardID - Board ID
* @return listings for the specified board as CSV in XML 
*/
String getAllListings( Integer context, Integer boardID )

/**
* getListingsSince() - Get all listings since a specified date for a board. This can be called with or without a sinceDate. 
* If not provided, then newly active and changed listings since your last call are returned. Returns up to the first 1000 
* active or changed listings. You may need to call this function multiple times to get all updated listings since your last 
* refresh. 
*
* @param context - Context
* @param boardID - Board ID
* @param sinceDate - Date (formatted as YYYYMMDD HH:mm:SS sss GMT)
* @return listings added or modified since specified date 
*/
String getListingsSince( Integer context, Integer boardID, sinceDate )

/**
* getListingsSinceWithListingNumber() - Get all listings since a specified date or listing number for a board. This can be 
* called with a sinceDate or sinceListingNumber. If neither is provided, then newly active and changed listings since your 
* last call are returned. 
*
* @param context - Context
* @param boardID - Board ID
* @param sinceDate - Date (formatted as YYYYMMDD HH:mm:SS sss GMT - can be null)
* @param sinceListingNumber - last listing number (within sinceDate - can be null)
* @return listings added or modified since specified date as CSV in XML
*/
String getListingsSinceWithListingNumber( Integer context, Integer boardID, String sinceDate, String sinceListingNumber )

/**
* getListingsInRange() - Get all listings in a specified date range for a board. 
*
* @param context - Context
* @param boardID - Board ID
* @param startDate - Start Date (formatted as YYYYMMDD HH:mm:SS sss GMT)
* @param endDate - End Date (formatted as YYYYMMDD HH:mm:SS sss GMT)
* @return listings added or modified within specified date range as CSV in XML 
*/
String getListingsInRange( Integer context, Integer boardID, String startDate, String endDate )

/**
* getListingsInRangeWithListingNumber() - Get all listings in a specified date range for a board. 
*
* @param context - Context
* @param boardID - Board ID
* @param startDate - Start Date (YYYYMMDD HH:mm:SS sss GMT)
* @param endDate - End Date (YYYYMMDD HH:mm:SS sss GMT)
* @param startListingNumber - starting listing number (within startDate - can be null)
* @return listings added or modified within specified date range 
*/
String getListingsInRangeWithListingNumber( Integer context, Integer boardID, String startDate, String endDate, String startListingNumber )

/**
* getPhotos() - Get all photos for a specified listing and board. 
*
* @param context - Context
* @param boardID - Board ID
* @param listingNumber - Listing Number
* @return all photos for the specified listing and board as XML 
*/
String getPhotos( Integer context, Integer boardID, String listingNumber )

/**
* getPhotosForMultipleListings() - Get all photos for multiple listings in a board. 
*
* @param context - Context
* @param boardID - Board ID
* @param listingNumbers - Array of Listing Numbers
* @return all photos for the specified listing and board as XML 
*/
String getPhotosForMultipleListings( Integer context, Integer boardID, String[] listingNumbers )

/**
* getOpenHomeInfoForBoard() - Get all open home information for a specified board. 
*
* @param context - Context
* @param boardID - Board ID
* @param sinceDate - Date (YYYYMMDD HH:mm:SS sss GMT) (can be null)
* @return all open home information for the specified board which was added or modified since specified date, as XML (not CSV in XML) 
*/
String getOpenHomeInfoForBoard( Integer context, Integer boardID, String sinceDate )

/**
* getOpenHomeInfoForMultipleListings() - Get all open home information for a specified board and list of listings. 
*
* @param context - Context
* @param boardID - Board ID
* @param listingNumbers - Array of Listing Numbers
* @return all open home information for the specified board and list of listings as XML (not CSV in XML) */
String getOpenHomeInfoForMultipleListings( Integer context, Integer boardID, String[] listingNumbers )

/**
* getOpenHomeInfo() - Get all open home information for a specified board and listing.
* Warning: deprecated! Not recommended for use. 
*
* @param context - Context
* @param boardID - Board ID
* @param listingNumber - Listing Number
* @return all open home information for listing as XML (not CSV in XML) 
*/
String getOpenHomeInfo( Integer context, listingNumber )

Did you find this article helpful?