- Providers

  • ES cluster: config.rets.ci
  • ES path: https://config.rets.ci:dnqpgakfyqdbbyxr@api.wpcloud.io:19100/
  • ES index/type: provider/provider

Object:

_id:{MD5 hash of url field}

{
  // MD5 Hash of url field
  "item_id": "53f046133acc697e33b7ca9b085bec12",
  // Login field, which is used to generate MD5 identification number for Provider
  "url": "http://matrixrets.hicentralmls.com/rets/login.ashx",
  // Is generated automatically by [RETS API](RETS API) service
  "name": "Hicentral-MLS-RETS",
  "created": "2017-01-12T12:40:32",
  "modified": "2017-01-13T12:35:32",
  // Puller Options
  "options": {
    // Time Zone which is used by particular Provider.
    // It's used for search updates
    "timeZoneOffset": 0,
    // How many seconds Poller should add to last modified date time to search for updates
    // In some cases we have to set it up to 30 seconds
    "secondsOffset": 1
  },
  // Mapping for Media and Property data. It's required to define default Query and system fields, etc
  "schema": {
    // Media data mapping. Required for images
    "media": {
      "object_type": "LargePhoto",
      // Defines if provider returns CDN link or base64 object
      "enabled_location": false
    },
    // Listing mapping
    "property": {
      "resource_id": "Property",
      // List of all available Classes for Property resource.
      // Every Class may have their own mapping schema. In other case, default schema is used.
      "classes": [
        {
          "class": "RESI",
          "desc": "Residential",
          "query": {
            "OriginalEntryTimestamp": "2010-01-01+"
          },
          // System fields matches
          // It must be set manually
          "mapping": {
            "uniqueID": "Matrix_Unique_ID",
            "mlsID": "MLSNumber",
            "entryDateTime": "OriginalEntryTimestamp",
            "modifiedDateTime": "MatrixModifiedDT",
            "latitude": "",
            "longitude": "",
            "streetNumber": "StreetNumber",
            "streetDirPrefix": "StreetDirPrefix",
            "streetPrefix": "",
            "streetDirSuffix": "StreetDirSuffix",
            "streetSuffix": "StreetSuffix",
            "streetName": "StreetName",
            "city": "City",
            "stateOrProvince": "StateOrProvince",
            "postalCode": "PostalCode"
          }
        },
        {
          "class": "LAND",
          "desc": "Lots/Land/Farm"
        },
        {
          "class": "MULT",
          "desc": "Multi-Family"
        },
        {
          "class": "COMM",
          "desc": "Commercial"
        }
      ],
      // Default Query for all Classes
      // It may be overwritten by class settings
      "query": {
        "OriginalEntryTimestamp": "2010-01-01+"
      },
      // Default Mapping for system fields.
      // It may be overwritten by class settings
      "mapping": {
        "uniqueID": "Matrix_Unique_ID",
        "mlsID": "MLSNumber",
        "entryDateTime": "OriginalEntryTimestamp",
        "modifiedDateTime": "MatrixModifiedDT",
        "latitude": "",
        "longitude": "",
        "streetNumber": "StreetNumber",
        "streetDirPrefix": "StreetDirPrefix",
        "streetPrefix": "",
        "streetDirSuffix": "StreetDirSuffix",
        "streetSuffix": "StreetSuffix",
        "streetName": "StreetName",
        "city": "City",
        "stateOrProvince": "StateOrProvince",
        "postalCode": "PostalCode"
      }
    }
  }
}

Feedback and Knowledge Base