Skip to content

Instantly share code, notes, and snippets.

@ahmadrosid

ahmadrosid/example-json-schema.json

Created May 3, 2021 13:50
Show Gist options
  • Save ahmadrosid/bae2dcd6332201990e058324bd290aac to your computer and use it in GitHub Desktop.
Save ahmadrosid/bae2dcd6332201990e058324bd290aac to your computer and use it in GitHub Desktop.
Download ZIP
Example listing json schema
Raw
example-json-schema.json
{
"version": "2.0.0",
"deprecatedDate": "Not defined",
"schemaDefinition": {
"type": "object",
"keys": {
"list_type": {
"type": "string",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"presence": "required",
"default": "Prospective",
"description": "Listing type is used to label the listing for usage purposes and identify how the listing should be handled."
},
"allow": [
null,
""
],
"examples": [
"MLS Listing"
]
},
"mls_name": {
"type": "string",
"flags": {
"default": "Keller Williams Realty",
"description": "Name of the Originating record provider. Most commonly the name of the MLS."
},
"allow": [
null,
""
],
"examples": [
"San Antonio Board of Realtors"
]
},
"mls_id": {
"type": "string",
"flags": {
"presence": "required",
"default": "KWLS",
"description": "Unique identifier of the Originating record provider. Most commonly the UID of the MLS."
},
"examples": [
"SABORTX"
]
},
"source_system_name": {
"type": "string",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"presence": "required",
"default": "KW Sourced",
"only": true,
"description": "System name for the source of the data."
},
"allow": [
null,
"",
"kw_CAMPAIGNS",
"kw_COMPLIANCE",
"kw_CONNECT",
"kw_CONSUMER",
"kw_CONTACTS",
"kw_DESIGNS",
"kw_FRONT_DOOR",
"kw_INCOMING",
"kw_INSIGHTS",
"kw_KPA",
"kw_KWW",
"kw_LEADS_DIGEST",
"kw_LEAD_ROUTING",
"kw_LISTINGCONSULT",
"kw_LISTINGS",
"kw_OPPORTUNITIES",
"kw_PNO",
"kw_REFERRALS",
"kw_REPORTS",
"kw_SITES",
"kw_SMARTPLANS",
"kw_SMARTPLANS_MC",
"kw_SYSTEM_NOTIFICATION",
"kw_TASKS",
"kw_TEAM_MANAGEMENT",
"kw_WEBRAND"
],
"examples": [
"SA"
]
},
"kw_mc": {
"type": "boolean",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null
]
},
"presence": "required",
"default": true,
"description": "Flag used by KW to indicate the listing is owned by a KW Market Center / Office"
},
"allow": [
null
],
"examples": [
"true"
]
},
"kw_listing": {
"type": "boolean",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null
]
},
"default": true,
"presence": "required",
"description": "Flag used by KW to indicate the listing is a KW listing"
},
"allow": [
null
],
"examples": [
"true"
]
},
"is_kww_listing": {
"type": "boolean",
"flags": {
"default": false,
"description": "Flag used by KW to indicate the listing is a Worldwide listing"
},
"allow": [
null
],
"examples": [
"false"
]
},
"kww_region": {
"type": "number",
"flags": {
"default": null,
"description": "Specific to KWW. Used for identifying the region from where the listing originated"
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
1001
]
},
"co_list_kw_uid": {
"type": "number",
"flags": {
"default": null,
"description": "UniqueId for the CoListing agent associated with the listing."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
789452
]
},
"sell_kw_uid": {
"type": "number",
"flags": {
"default": null,
"description": "UniqueId for the Selling agent associated with the listing."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
654321
]
},
"is_deleted": {
"type": "boolean",
"flags": {
"default": false,
"presence": "required"
},
"allow": [
null
],
"examples": [
"true"
]
},
"version": {
"type": "string",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": "2.0.0",
"presence": "required"
},
"allow": [
null,
""
],
"examples": [
"2.0.0"
]
},
"list_id": {
"type": "number",
"flags": {
"presence": "required",
"description": "Autogenerated field"
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
}
},
"list_key": {
"type": "string",
"flags": {
"presence": "required"
},
"examples": [
"SABORTX-1220171"
]
},
"prop_id": {
"type": "number",
"flags": {
"default": null
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
4578920
]
},
"neighborhood_id": {
"type": "number",
"flags": {
"default": null
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
2342123
]
},
"kwls_status": {
"type": "string",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": "Initiated",
"presence": "required",
"description": "Status for the MC approval process to accept or return manually entered listings in KWLS."
},
"allow": [
null,
""
],
"examples": [
"Initiated"
]
},
"manual_entry": {
"type": "boolean",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null
]
},
"default": true,
"presence": "required",
"description": "Flag used by KW to indicate a manually entered listing."
},
"allow": [
null
],
"examples": [
"false"
]
},
"mls_number": {
"type": "string",
"flags": {
"presence": "required",
"default": null,
"description": "The unique identifier for the listing provided by the MLS or other record provider."
},
"allow": [
null,
""
],
"examples": [
"TCH1220171"
]
},
"mls_source_id": {
"type": "number",
"flags": {
"default": null
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
201
]
},
"list_kw_uid": {
"type": "number",
"flags": {
"default": null,
"description": "UniqueId for the KW agent who is the listing agent."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
556397
]
},
"kw_agent": {
"type": "boolean",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null
]
},
"default": true,
"presence": "required",
"description": "Flag used by KW to indicate the listing is owned by a KW agent"
},
"allow": [
null
],
"examples": [
"true"
]
},
"list_uuid": {
"type": "string",
"flags": {
"presence": "required",
"description": "The unique identifier for the listing provided by the KWLS system."
},
"examples": [
"0bbee3b0-4f3e-4e11-9b45-1e0078e10269"
]
},
"market_center": {
"type": "number",
"flags": {
"default": null,
"description": "ID of the Market Center tied to the listing."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
101
]
},
"syndicate": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Zillow"
]
}
]
},
"list_address": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"street_number": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"6545"
]
},
"street_direction": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"W"
]
},
"street_name": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Cameron"
]
},
"street_suffix": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Rd."
]
},
"street_post_dir": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"NW"
]
},
"full_street_address": {
"type": "string",
"flags": {
"default": null,
"description": "The Listing Address is a text representation of the address with the full civic location as a single entity (Number and Street). Unchanged from the source (MLS or other listing source)."
},
"allow": [
null,
""
],
"examples": [
"5850 Dripping Rock Ln Unit: 201"
]
},
"unit_number": {
"type": "string",
"flags": {
"default": null,
"description": "Text field containing the number or portion of a larger building or complex. Unit Number should appear following the street suffix or, if it exists, the street suffix direction, in the street address. Examples are: \"APT G\", \"55\", etc."
},
"allow": [
null,
""
],
"examples": [
"201"
]
},
"city": {
"type": "string",
"flags": {
"presence": "required",
"description": "The city or town of listing address."
},
"examples": [
"Fort Collins"
]
},
"state_prov": {
"type": "string",
"flags": {
"default": null,
"description": "Text field containing the accepted postal abbreviation for the state or province."
},
"allow": [
null,
""
],
"examples": [
"CO"
]
},
"postal_code": {
"type": "string",
"flags": {
"default": null,
"description": "The postal code portion of the listing address."
},
"allow": [
null,
""
],
"examples": [
"80528"
]
},
"zip_4": {
"type": "string",
"flags": {
"default": null,
"description": "The +4 postal code portion of the listing address."
},
"allow": [
null,
""
],
"examples": [
"8561"
]
},
"country": {
"type": "string",
"flags": {
"default": null,
"description": "The country of the listing address."
},
"allow": [
null,
""
],
"examples": [
"US"
]
},
"address": {
"type": "string",
"flags": {
"default": null,
"description": "The Listing Address is a text representation of the address with the full civic location as a single entity (Number and Street). Unchanged from the source (MLS or other listing source)."
},
"allow": [
null,
""
],
"examples": [
"414 REBA"
]
},
"coordinates_gp": {
"type": "object",
"flags": {
"description": "Geolocation of the listing."
},
"allow": [
null,
""
],
"keys": {
"lat": {
"type": "number",
"flags": {
"default": 0
},
"preferences": {
"convert": false
}
},
"lon": {
"type": "number",
"flags": {
"default": 0
},
"preferences": {
"convert": false
}
}
}
},
"coordinates_gs": {
"type": "object",
"flags": {
"description": "Geolocation of the listing."
},
"allow": [
null,
""
],
"keys": {
"coordinates": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "number",
"preferences": {
"convert": false
}
},
{
"type": "number",
"preferences": {
"convert": false
}
}
]
},
"type": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
]
}
}
}
}
},
"property_address": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"full_street_address": {
"type": "string",
"flags": {
"default": null,
"description": "The standardized Property Address is a text representation of the address with the full civic location as a single entity."
},
"allow": [
null,
""
],
"examples": [
"5850 Dripping Rock Ln."
]
},
"street_number": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"5850"
]
},
"street_number_low": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"1700"
]
},
"street_number_high": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"1800"
]
},
"street_long": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Dripping Rock Lane"
]
},
"street_short": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Dripping Rock Ln."
]
},
"street_suffix_long": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Lane"
]
},
"street_suffix_short": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Ln."
]
},
"street_unit": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"32D"
]
},
"unit_number": {
"type": "string",
"flags": {
"default": null,
"description": "Text field containing the standardized number or portion of a larger building or complex. Unit Number should appear following the street suffix or, if it exists, the street suffix direction, in the street address. Examples are: \"APT G\", \"55\", etc."
},
"allow": [
null,
""
],
"examples": [
"201D"
]
},
"unit_type": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Flat"
]
},
"city_long": {
"type": "string",
"flags": {
"default": null,
"description": "The standardized city in listing address."
},
"allow": [
null,
""
],
"examples": [
"Fort Collins"
]
},
"city_short": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Ft. Collins"
]
},
"state_prov_long": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Colorado"
]
},
"state_prov_short": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"CO"
]
},
"country_long": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"United States"
]
},
"country_short": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"US"
]
},
"county": {
"type": "string",
"flags": {
"default": null,
"description": "Travis"
},
"allow": [
null,
""
]
},
"county_fips": {
"type": "string",
"flags": {
"default": null,
"description": "The fips code of county."
},
"allow": [
null,
""
]
},
"postal_code_long": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"80528-2343"
]
},
"postal_code_short": {
"type": "string",
"flags": {
"default": null,
"description": "The standardized postal code portion of a street or mailing address."
},
"allow": [
null,
""
],
"examples": [
"80528"
]
},
"zip_4": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"2343"
]
},
"address": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"<AUTOMATIC SYSTEM GENERATED> Full_Street_Address Unit_Number City State_Prov Country Postal_Code Zip_4"
]
},
"habitation_name": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Caversheim House"
]
},
"level_number": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"12"
]
},
"street_direction": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"East"
]
},
"rural_address": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"^RD [0-9]{1"
]
},
"coordinates_gp": {
"type": "object",
"flags": {
"default": null,
"description": "Geolocation of the listing."
},
"allow": [
null
],
"keys": {
"lat": {
"type": "number",
"flags": {
"default": null
},
"preferences": {
"convert": false
},
"allow": [
null
]
},
"lon": {
"type": "number",
"flags": {
"default": null
},
"preferences": {
"convert": false
},
"allow": [
null
]
}
}
},
"coordinates_gs": {
"type": "object",
"flags": {
"default": null,
"description": "Geolocation of the listing."
},
"allow": [
null
],
"keys": {
"coordinates": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "number",
"preferences": {
"convert": false
}
},
{
"type": "number",
"preferences": {
"convert": false
}
}
]
},
"type": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
]
}
}
}
}
},
"currency_code": {
"type": "string",
"flags": {
"default": null,
"only": true,
"description": "Currency code used for all monetary values associated with the listing."
},
"rules": [
{
"name": "length",
"args": {
"limit": 3
}
}
],
"allow": [
null,
"",
"AED",
"AFN",
"ALL",
"AMD",
"ANG",
"AOA",
"ARS",
"AUD",
"AWG",
"AZN",
"BAM",
"BBD",
"BDT",
"BGN",
"BHD",
"BIF",
"BMD",
"BND",
"BOB",
"BOV",
"BRL",
"BSD",
"BTN",
"BWP",
"BYN",
"BZD",
"CAD",
"CDF",
"CHE",
"CHF",
"CHW",
"CLF",
"CLP",
"CNY",
"COP",
"COU",
"CRC",
"CUC",
"CUP",
"CVE",
"CZK",
"DJF",
"DKK",
"DOP",
"DZD",
"EGP",
"ERN",
"ETB",
"EUR",
"FJD",
"FKP",
"GBP",
"GEL",
"GHS",
"GIP",
"GMD",
"GNF",
"GTQ",
"GYD",
"HKD",
"HNL",
"HRK",
"HTG",
"HUF",
"IDR",
"ILS",
"INR",
"IQD",
"IRR",
"ISK",
"JMD",
"JOD",
"JPY",
"KES",
"KGS",
"KHR",
"KMF",
"KPW",
"KRW",
"KWD",
"KYD",
"KZT",
"LAK",
"LBP",
"LKR",
"LRD",
"LSL",
"LYD",
"MAD",
"MDL",
"MGA",
"MKD",
"MMK",
"MNT",
"MOP",
"MRU",
"MUR",
"MVR",
"MWK",
"MXN",
"MXV",
"MYR",
"MZN",
"NAD",
"NGN",
"NIO",
"NOK",
"NPR",
"NZD",
"OMR",
"PAB",
"PEN",
"PGK",
"PHP",
"PKR",
"PLN",
"PYG",
"QAR",
"RON",
"RSD",
"RUB",
"RWF",
"SAR",
"SBD",
"SCR",
"SDG",
"SEK",
"SGD",
"SHP",
"SLL",
"SOS",
"SRD",
"SSP",
"STN",
"SVC",
"SYP",
"SZL",
"THB",
"TJS",
"TMT",
"TND",
"TOP",
"TRY",
"TTD",
"TWD",
"TZS",
"UAH",
"UGX",
"USD",
"USN",
"UYI",
"UYU",
"UYW",
"UZS",
"VES",
"VND",
"VUV",
"WST",
"XAF",
"XAG",
"XAU",
"XBA",
"XBB",
"XBC",
"XBD",
"XCD",
"XDR",
"XOF",
"XPD",
"XPF",
"XPT",
"XSU",
"XTS",
"XUA",
"XXX",
"YER",
"ZAR",
"ZMW",
"ZWL"
],
"examples": [
"USD"
]
},
"current_list_price": {
"type": "number",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": 0,
"presence": "required",
"description": "The current price of the property as determined by the seller and the seller s broker. For auctions this is the minimum or reserve price. For Coming Soon this is Estimated Price."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null,
""
],
"examples": [
490000
]
},
"lease_price": {
"type": "number",
"flags": {
"default": null,
"description": "The lease amount."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
1500
]
},
"close_price": {
"type": "number",
"flags": {
"default": null,
"description": "The amount of money paid by the purchaser to the seller for the property under the agreement."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
485000
]
},
"original_list_price": {
"type": "number",
"flags": {
"default": null,
"description": "The original price of the property on the initial agreement between the seller and the seller s broker."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
500000
]
},
"price_tax_suffix": {
"type": "boolean",
"flags": {
"default": false,
"description": "Status to indicate if \"+Taxes\" should be displayed after price (Canada only)"
},
"allow": [
null
],
"examples": [
"true"
]
},
"price_history": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"current_list_price": {
"type": "number",
"flags": {
"default": null
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
495000
]
},
"previous_list_price": {
"type": "number",
"flags": {
"default": null
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
500000
]
},
"price_updated_at": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"in_use": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"percent_change": {
"type": "number",
"flags": {
"default": null
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
0.02
]
}
}
}
]
},
"list_dt": {
"type": "string",
"flags": {
"default": null,
"description": "Date the property was listed. For Coming Soon listings, enter the expected date of when listing will be Active on market."
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2]\\d|3[0-1])/"
}
}
],
"allow": [
null,
""
],
"examples": [
"2017-01-17"
]
},
"kw_expiry_dt": {
"type": "string",
"flags": {
"default": null,
"description": "This date determines the time period for which a listing will be syndicated (externally and to other KW agents). Limit is 180 days in the future."
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2]\\d|3[0-1])/"
}
}
],
"allow": [
null,
""
],
"examples": [
"2018-02-02"
]
},
"kw_expiry_dt_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Locks the KW Expiry Date for the syndication expiration to not override this date."
},
"allow": [
null
],
"examples": [
"false"
]
},
"contract_expiry_dt": {
"type": "string",
"flags": {
"default": null,
"description": "This is the date at which the listing contract ends."
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2]\\d|3[0-1])/"
}
}
],
"allow": [
null,
""
],
"examples": [
"2018-10-02"
]
},
"contract_expiry_dt_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Locks the Expiry Date for the contract to not override this field upon import."
},
"allow": [
null
],
"examples": [
"true"
]
},
"close_dt": {
"type": "string",
"flags": {
"default": null,
"description": "Close date for sold listing."
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/\\d{4}-(?:0[1-9]|1[0-2])-(?:0[1-9]|[1-2]\\d|3[0-1])/"
}
}
],
"allow": [
null,
""
],
"examples": [
"2017-12-01"
]
},
"list_status": {
"type": "string",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": "Draft",
"presence": "required",
"description": "Local or regional status that are well known by business users, indicating the state that the listing is currently in."
},
"allow": [
null,
""
],
"examples": [
"Active"
]
},
"list_status_id": {
"type": "number",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": 0,
"presence": "required"
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null,
""
],
"examples": [
1
]
},
"list_status_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Enable this lock if you prefer to manage the Listing Status via KW applications. Enabling this lock will disregard any import updates for Listing Status (from MLS or other provider). All other data in the listing will be updated."
},
"allow": [
null
],
"examples": [
"false"
]
},
"list_category": {
"type": "string",
"flags": {
"presence": "required",
"default": null,
"description": "Identifies the category of the listing: \"Sale\" or \"Rental\""
},
"allow": [
null,
""
],
"examples": [
"Sale"
]
},
"list_category_id": {
"type": "number",
"flags": {
"presence": "required",
"default": null,
"description": "Identifies the category of the listing: \"Sale\" or \"Rental\""
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
1
]
},
"luxury_home": {
"type": "boolean",
"flags": {
"default": false,
"description": "Flag used by KW to indicate a luxury listing."
},
"allow": [
null
],
"examples": [
"true"
]
},
"prop_type": {
"type": "string",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": "default",
"presence": "required",
"description": "Main cetegory for the type of listing. Includes categories such as Residential, Lease, Income, Land, Mobile, Commercial Sale, etc..."
},
"allow": [
null,
""
],
"examples": [
"Residential"
]
},
"prop_type_id": {
"type": "number",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": 0,
"presence": "required"
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null,
""
],
"examples": [
1
]
},
"prop_type_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Enable this lock if you prefer to manage the Property Type via KW applications. Enabling this lock will disregard any import updates for Property Type (from MLS or other provider). All other data in the listing will be updated."
},
"allow": [
null
],
"examples": [
"false"
]
},
"prop_subtype": {
"type": "string",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": "default",
"presence": "required",
"description": "Sub category for the type of listing. Includes sub categories such as Apartment, Single Family Detached, Condo, etc."
},
"allow": [
null,
""
],
"examples": [
"Single Family Residence"
]
},
"prop_subtype_id": {
"type": "number",
"flags": {
"empty": {
"type": "any",
"flags": {
"only": true
},
"allow": [
null,
""
]
},
"default": 0,
"presence": "required",
"description": "ID for the sub category for the type of listing. Includes sub categories such as Apartment, Single Family Detached, Condo, etc."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null,
""
],
"examples": [
2
]
},
"prop_subtype_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Enable this lock if you prefer to manage the Property Sub Type via KW applications. Enabling this lock will disregard any import updates for Property Sub Type (from MLS or other provider). All other data in the listing will be updated."
},
"allow": [
null
],
"examples": [
"false"
]
},
"special_list_condition": {
"type": "string",
"flags": {
"default": null,
"description": "A list of options that describe the type of sale. i.e. Standard, REO, Short Sale, Probate, Auction, NOD, etc., at the time of listing."
},
"allow": [
null,
""
],
"examples": [
"REO - Bank owned"
]
},
"year_built": {
"type": "number",
"flags": {
"default": null,
"description": "The year that an occupancy permit is first granted for the house or other local measure of initial habitability of the build."
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
2015
]
},
"living_area": {
"type": "number",
"flags": {
"default": null,
"description": "The total livable area within the structure."
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
2300
]
},
"living_area_units": {
"type": "string",
"flags": {
"default": null,
"description": "A pick list of the unit of measurement for the area. i.e. Square Feet, Square Meters, Acres, etc."
},
"allow": [
null,
""
],
"examples": [
"Square Feet"
]
},
"lot_size_area": {
"type": "number",
"flags": {
"default": null,
"description": "The total area of the lot. See Lot Size Units for the units of measurement (Square Feet, Square Meters, Acres, etc.)."
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
0.21
]
},
"lot_size_units": {
"type": "string",
"flags": {
"default": null,
"description": "A pick list of the unit of measurement for the area. i.e. Square Feet, Square Meters, Acres, etc."
},
"allow": [
null,
""
],
"examples": [
"Acres"
]
},
"lot_front_area": {
"type": "string",
"flags": {
"default": null,
"description": "The linear measurement across the front of the lot - facing the street"
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/^\\d+$/"
}
}
],
"allow": [
null,
""
],
"examples": [
"102"
]
},
"lot_front_units": {
"type": "string",
"flags": {
"default": null,
"description": "A pick list of the unit of measurement for the area. i.e. Feet, Meters, etc."
},
"allow": [
null,
""
],
"examples": [
"Feet"
]
},
"lot_depth_area": {
"type": "string",
"flags": {
"default": null,
"description": "The linear measurement between the front and back of the lot"
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/^\\d+$/"
}
}
],
"allow": [
null,
""
],
"examples": [
"210"
]
},
"lot_depth_units": {
"type": "string",
"flags": {
"default": null,
"description": "A pick list of the unit of measurement for the area. i.e. Feet, Meters, etc."
},
"allow": [
null,
""
],
"examples": [
"Feet"
]
},
"office_size": {
"type": "string",
"flags": {
"default": null,
"description": "The total area of office space."
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/^\\d+$/"
}
}
],
"allow": [
null,
""
],
"examples": [
"2300"
]
},
"office_size_units": {
"type": "string",
"flags": {
"default": null,
"description": "Units of measurement for the total area of office space."
},
"allow": [
null,
""
],
"examples": [
"Square Feet"
]
},
"warehouse_size": {
"type": "string",
"flags": {
"default": null,
"description": "The total area of warehouse space."
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/^\\d+$/"
}
}
],
"allow": [
null,
""
],
"examples": [
"2300"
]
},
"warehouse_size_units": {
"type": "string",
"flags": {
"default": null,
"description": "Units of measurement for the total area of warehouse space."
},
"allow": [
null,
""
],
"examples": [
"Square Feet"
]
},
"retail_size": {
"type": "string",
"flags": {
"default": null,
"description": "The total area of retail space."
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/^\\d+$/"
}
}
],
"allow": [
null,
""
],
"examples": [
"2300"
]
},
"retail_size_units": {
"type": "string",
"flags": {
"default": null,
"description": "Units of measurement for the total area of retail space."
},
"allow": [
null,
""
],
"examples": [
"Square Feet"
]
},
"other_area_size": {
"type": "string",
"flags": {
"default": null,
"description": "The total area of other space."
},
"rules": [
{
"name": "pattern",
"args": {
"regex": "/^\\d+$/"
}
}
],
"allow": [
null,
""
],
"examples": [
"2300"
]
},
"other_area_size_units": {
"type": "string",
"flags": {
"default": null,
"description": "Units of measurement for the total area of other space."
},
"allow": [
null,
""
],
"examples": [
"Square Feet"
]
},
"total_bed": {
"type": "number",
"flags": {
"default": null,
"description": "The total number of bedrooms in the dwelling."
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
3
]
},
"total_bath": {
"type": "number",
"flags": {
"default": null,
"description": "The total number of bathrooms in the dwelling."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
3
]
},
"full_bath": {
"type": "number",
"flags": {
"default": null,
"description": "A room containing all 4 of the 4 elements constituting a bath, which are; Toilet, Sink, Bathtub or Shower Head."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
2
]
},
"half_bath": {
"type": "number",
"flags": {
"default": null,
"description": "A room containing 2 of the 4 elements constituting a bath, which are; Toilet, Sink, Bathtub or Shower Head. A Half Bath will typically contain a Sink and Toilet."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
1
]
},
"one_quarter_bath": {
"type": "number",
"flags": {
"default": null,
"description": "A room containing 1 of the 4 elements constituting a bath which are; Toilet, Sink, Bathtub or Shower Head. Examples are a vanity with a sink or a WC (Water Closet, which is a room with only a toilet)."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
0
]
},
"three_quarter_bath": {
"type": "number",
"flags": {
"default": null,
"description": "A room containing 3 of the 4 elements constituting a bath, which are; Toilet, Sink, Bathtub or Shower Head. A typical Three Quarter Bath will contain Sink, Toilet and Shower. Some may considered a Sink, Toilet and Tub (without a shower) a Three Quarter Bath, others consider this to be a Full Bath."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
0
]
},
"partial_bath": {
"type": "number",
"flags": {
"default": null,
"description": "The number of partial bathrooms in the property being sold/leased. When used in combination with the BathroomsFull field, this replaces (or is the sum of) all Half and One Quarter bathrooms; and in the event BathroomsThreeQuarter is not used, BathroomsFull replaces (or is the sum of) all Full and Three Quarter baths. This field should not be used in combination with the BathroomsOneQuarter or the BathroomsHalf."
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
1
]
},
"list_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Text remarks intended for public display. In an MLS, it is the field where info is entered for the public. This information is intended to be visible on-line and should be public info only."
},
"allow": [
null,
""
],
"examples": [
"Location Location Location!! Minutes from schools"
]
},
"list_desc_en": {
"type": "string",
"flags": {
"default": null,
"description": "Text remarks intended for public display. In an MLS, it is the field where info is entered for the public. This information is intended to be visible on-line and should be public info only."
},
"allow": [
null,
""
],
"examples": [
"Abe what was this again?"
]
},
"list_desc_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Enable this lock if you prefer to manage the Listing Description via KW applications. Enabling this lock will disregard any import updates for Listing Description (from MLS or other provider). All other data in the listing will be updated."
},
"allow": [
null
],
"examples": [
"false"
]
},
"brokerage": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"name": {
"type": "string",
"flags": {
"presence": "required"
},
"examples": [
"Keller Williams Heritage"
]
},
"email": {
"type": "string",
"flags": {
"default": null,
"description": "The email for the brokerage representing the seller of the listing."
},
"allow": [
null,
""
],
"examples": [
"[email protected]"
]
},
"phone": {
"type": "string",
"flags": {
"default": null,
"description": "The phone for the brokerage representing the seller of the listing."
},
"allow": [
null,
""
],
"examples": [
"(210) 493-3030"
]
}
}
},
"list_agent_office": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"list_agent_mls_id": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the member."
},
"allow": [
null,
""
],
"examples": [
"523504"
]
},
"list_agent_mls_id_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"523504"
]
},
"list_agent_key": {
"type": "string",
"flags": {
"default": null,
"description": "ListAgentKey is the system unique identifier from the system that the record was retrieved."
},
"allow": [
null,
""
],
"examples": [
"SABORTX-523504"
]
},
"list_agent_key_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"SABORTX-523504"
]
},
"list_agent_first_name": {
"type": "string",
"flags": {
"default": null,
"description": "The first name of the listing agent."
},
"allow": [
null,
""
],
"examples": [
"Tina"
]
},
"list_agent_last_name": {
"type": "string",
"flags": {
"default": null,
"description": "The last name of the listing agent."
},
"allow": [
null,
""
],
"examples": [
"Morris"
]
},
"list_agent_full_name": {
"type": "string",
"flags": {
"presence": "required",
"description": "The full name of the listing agent."
},
"examples": [
"Tina Morris"
]
},
"list_agent_preferred_phone": {
"type": "string",
"flags": {
"default": null,
"description": "Preferred or direct phone number of the listing agent."
},
"allow": [
null,
""
],
"examples": [
"2102626485"
]
},
"list_agent_office_phone": {
"type": "string",
"flags": {
"default": null,
"description": "Office phone number of the listing agent."
},
"allow": [
null,
""
],
"examples": [
"2104933030"
]
},
"list_agent_fax": {
"type": "string",
"flags": {
"default": null,
"description": "Fax number of the listing agent."
},
"allow": [
null,
""
],
"examples": [
"2103256856"
]
},
"list_agent_email": {
"type": "string",
"flags": {
"default": null,
"description": "Email address of the listing agent."
},
"allow": [
null,
""
],
"examples": [
"[email protected]"
]
},
"list_agent_url": {
"type": "string",
"flags": {
"default": null,
"description": "Website of the listing agent."
},
"allow": [
null,
""
],
"examples": [
"http://www.mykwsa.com"
]
},
"list_agent_license": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"lal_jurisdiction": {
"type": "string",
"flags": {
"default": null,
"description": "A string representing the location for the jurisdiction of the agent s license."
},
"allow": [
null,
""
],
"examples": [
"WI"
]
},
"lal_license_number": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"82441-94"
]
},
"lal_license_category": {
"type": "string",
"flags": {
"default": null,
"description": "The type of professional license the listing agent holds. This will vary based on the local types and jurisdictions."
},
"allow": [
null,
""
],
"examples": [
"Unknown"
]
},
"lal_state_prov": {
"type": "string",
"flags": {
"default": null,
"description": "The state or province for the jurisdiction of the listing agent s license."
},
"allow": [
null,
""
],
"examples": [
"WI"
]
}
}
}
]
},
"list_office_mls_id": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the listing office. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system."
},
"allow": [
null,
""
],
"examples": [
"KLWM00"
]
},
"list_office_mls_id_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"KLWM00"
]
},
"list_office_key": {
"type": "string",
"flags": {
"default": null,
"description": "The local, unique identifier for the listing office. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system."
},
"allow": [
null,
""
],
"examples": [
"SABORTX-KLWM00"
]
},
"list_office_key_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"SABORTX-KLWM00"
]
},
"list_office_name": {
"type": "string",
"flags": {
"default": null,
"description": "The legal name of the office representing the seller of the listing."
},
"allow": [
null,
""
],
"examples": [
"Keller Williams Heritage"
]
},
"list_office_address": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"full_street_address": {
"type": "string",
"flags": {
"default": null,
"description": "Address of the listing office."
},
"allow": [
null,
""
],
"examples": [
"2338 N Loop 1604 W Ste 120"
]
},
"unit_number": {
"type": "string",
"flags": {
"default": null,
"description": "Address line 2 or Unit number of the listing office."
},
"allow": [
null,
""
]
},
"city": {
"type": "string",
"flags": {
"default": null,
"description": "City of the listing office."
},
"allow": [
null,
""
],
"examples": [
"San Antonio"
]
},
"state_prov": {
"type": "string",
"flags": {
"default": null,
"description": "State or Province of the listing office."
},
"allow": [
null,
""
],
"examples": [
"TX"
]
},
"postal_code": {
"type": "string",
"flags": {
"default": null,
"description": "Postal Code of the listing office."
},
"allow": [
null,
""
],
"examples": [
"78248"
]
},
"country": {
"type": "string",
"flags": {
"default": null,
"description": "Country of the listing office."
},
"allow": [
null,
""
],
"examples": [
"US"
]
},
"address": {
"type": "string",
"flags": {
"default": null,
"description": "Complete address for the listing office."
},
"allow": [
null,
""
],
"examples": [
"2338 N Loop 1604 W Ste 120"
]
}
}
},
"list_office_phone": {
"type": "string",
"flags": {
"default": null,
"description": "Phone number of the listing office."
},
"allow": [
null,
""
],
"examples": [
"(210) 493-3030"
]
},
"list_office_fax": {
"type": "string",
"flags": {
"default": null,
"description": "Fax number of the listing office."
},
"allow": [
null,
""
],
"examples": [
"2103256856"
]
},
"list_office_email": {
"type": "string",
"flags": {
"default": null,
"description": "Email address of the listing office."
},
"allow": [
null,
""
],
"examples": [
"[email protected]"
]
},
"list_office_url": {
"type": "string",
"flags": {
"default": null,
"description": "Website of the listing office."
},
"allow": [
null,
""
],
"examples": [
"http://www.mykwsa.com"
]
}
}
},
"co_list_agent_office": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"co_list_agent_mls_id": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the CoListing member."
},
"allow": [
null,
""
],
"examples": [
"4585263"
]
},
"co_list_agent_mls_id_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"4585263"
]
},
"co_list_agent_key": {
"type": "string",
"flags": {
"default": null,
"description": "CoListAgentKey is the system unique identifier from the system that the record was retrieved."
},
"allow": [
null,
""
],
"examples": [
"SABORTX-4585263"
]
},
"co_list_agent_key_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"SABORTX-4585263"
]
},
"co_list_agent_first_name": {
"type": "string",
"flags": {
"default": null,
"description": "The first name of the CoListing agent."
},
"allow": [
null,
""
],
"examples": [
"Some"
]
},
"co_list_agent_last_name": {
"type": "string",
"flags": {
"default": null,
"description": "The last name of the CoListing agent."
},
"allow": [
null,
""
],
"examples": [
"One"
]
},
"co_list_agent_full_name": {
"type": "string",
"flags": {
"default": null,
"description": "The full name of the CoListing agent."
},
"allow": [
null,
""
],
"examples": [
"Some One"
]
},
"co_list_agent_preferred_phone": {
"type": "string",
"flags": {
"default": null,
"description": "Preferred or direct phone number of the CoListing agent."
},
"allow": [
null,
""
],
"examples": [
"2102626485"
]
},
"co_list_agent_office_phone": {
"type": "string",
"flags": {
"default": null,
"description": "Office phone number of the CoListing agent."
},
"allow": [
null,
""
],
"examples": [
"2104933030"
]
},
"co_list_agent_fax": {
"type": "string",
"flags": {
"default": null,
"description": "Fax number of the CoListing agent."
},
"allow": [
null,
""
],
"examples": [
"2103256856"
]
},
"co_list_agent_email": {
"type": "string",
"flags": {
"default": null,
"description": "Email address of the CoListing agent."
},
"allow": [
null,
""
],
"examples": [
"[email protected]"
]
},
"co_list_agent_url": {
"type": "string",
"flags": {
"default": null,
"description": "Website of the CoListing agent."
},
"allow": [
null,
""
],
"examples": [
"http://www.mykwsa.com"
]
},
"co_list_office_mls_id": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the CoListing office."
},
"allow": [
null,
""
],
"examples": [
"KLWM01"
]
},
"co_list_office_key": {
"type": "string",
"flags": {
"default": null,
"description": "The local, unique identifier for the CoListing office. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system."
},
"allow": [
null,
""
],
"examples": [
"0yd-SABORTX-KLWM00"
]
},
"co_list_office_name": {
"type": "string",
"flags": {
"default": null,
"description": "The legal name of the CoListing office representing the seller."
},
"allow": [
null,
""
],
"examples": [
"Keller Williams Ames"
]
},
"co_list_office_phone": {
"type": "string",
"flags": {
"default": null,
"description": "Phone number of the CoListing office representing the seller."
},
"allow": [
null,
""
],
"examples": [
"(210) 493-3030"
]
}
}
},
"sell_agent_office": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"sell_agent_mls_id": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the seller."
},
"allow": [
null,
""
],
"examples": [
"4585263"
]
},
"sell_agent_mls_id_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"4585263"
]
},
"sell_agent_key": {
"type": "string",
"flags": {
"default": null,
"description": "The local, unique identifier for the CoListing office. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system."
},
"allow": [
null,
""
],
"examples": [
"0yd-SABORTX-KLWM00"
]
},
"sell_agent_key_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"0yd-SABORTX-KLWM00"
]
},
"sell_agent_full_name": {
"type": "string",
"flags": {
"default": null,
"description": "Name of the selling agent."
},
"allow": [
null,
""
],
"examples": [
"Some One"
]
},
"sell_office_mls_id": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the selling office."
},
"allow": [
null,
""
],
"examples": [
"4585263"
]
},
"sell_office_mls_id_2": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the selling office."
},
"allow": [
null,
""
],
"examples": [
"KLWM01"
]
},
"sell_office_key": {
"type": "string",
"flags": {
"default": null,
"description": "The local, unique identifier for the CoListing office. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system."
},
"allow": [
null,
""
],
"examples": [
"0yd-SABORTX-KLWM00"
]
},
"sell_office_key_2": {
"type": "string",
"flags": {
"default": null,
"description": "The local, unique identifier for the CoListing office. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system."
},
"allow": [
null,
""
],
"examples": [
"SABORTX-KLWM01"
]
},
"sell_office_name": {
"type": "string",
"flags": {
"default": null,
"description": "Name of the selling office."
},
"allow": [
null,
""
],
"examples": [
"Keller Williams Ames"
]
}
}
},
"co_sell_agent_office": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"co_sell_agent_mls_id": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the co-selling agent."
},
"allow": [
null,
""
],
"examples": [
"4585263"
]
},
"co_sell_agent_mls_id_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"4585263"
]
},
"co_sell_agent_key": {
"type": "string",
"flags": {
"default": null,
"description": "The local, unique identifier for the CoListing office. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system."
},
"allow": [
null,
""
],
"examples": [
"0yd-SABORTX-KLWM00"
]
},
"co_sell_agent_key_2": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"0yd-SABORTX-KLWM00"
]
},
"co_sell_agent_full_name": {
"type": "string",
"flags": {
"default": null,
"description": "Name of the selling agent."
},
"allow": [
null,
""
],
"examples": [
"Bob Elroy"
]
},
"co_sell_office_mls_id": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the co-selling office."
},
"allow": [
null,
""
],
"examples": [
"2345"
]
},
"co_sell_office_key": {
"type": "string",
"flags": {
"default": null,
"description": "The local, unique identifier for the CoListing office. This value may not be unique, specifically in the case of aggregation systems, this value should be the identifier from the original system."
},
"allow": [
null,
""
],
"examples": [
"0yd-SABORTX-KLWM00"
]
},
"co_sell_office_name": {
"type": "string",
"flags": {
"default": null,
"description": "The local, well-known identifier for the co-selling agent."
},
"allow": [
null,
""
],
"examples": [
"KW West"
]
}
}
},
"location": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"county": {
"type": "string",
"flags": {
"default": null,
"description": "The County, Parish or other regional authority"
},
"allow": [
null,
""
],
"examples": [
"Monongalia"
]
},
"township": {
"type": "string",
"flags": {
"default": null,
"description": "A subdivision of the county."
},
"allow": [
null,
""
],
"examples": [
"Chicago-Portage Park"
]
},
"region": {
"type": "string",
"flags": {
"default": null,
"description": "A sub-section or area of a defined state or province. Examples would be the Keys in FL or Hudson Valley in NY."
},
"allow": [
null,
""
],
"examples": [
"Zilker Park"
]
},
"subdivision": {
"type": "string",
"flags": {
"default": null,
"description": "A neighborhood, community, complex or builder tract."
},
"allow": [
null,
""
],
"examples": [
"Cheat Crossings"
]
},
"elevation": {
"type": "string",
"flags": {
"default": null,
"description": "The elevation of the property in relation to sea level."
},
"allow": [
null,
""
],
"examples": [
"Sea Level 1"
]
},
"zoning": {
"type": "string",
"flags": {
"default": null,
"description": "A division of the city or county into areas of different permissible land uses."
},
"allow": [
null,
""
],
"examples": [
"SINGL"
]
},
"schools": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"school_name": {
"type": "string",
"flags": {
"default": null,
"description": "Name of the school."
},
"allow": [
null,
""
],
"examples": [
"Valley View"
]
},
"school_district": {
"type": "string",
"flags": {
"default": null,
"description": "Name of the school district (if applicable)."
},
"allow": [
null,
""
],
"examples": [
"Monongalia"
]
},
"school_category": {
"type": "string",
"flags": {
"default": null,
"description": "Category for the school (High, Junior High, Middle, Elementary, etc.)"
},
"allow": [
null,
""
],
"examples": [
"Elementary"
]
}
}
}
]
},
"neighborhoods": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"neigh_name": {
"type": "string",
"flags": {
"default": null,
"description": "Name of the area in which the property is located."
},
"allow": [
null,
""
],
"examples": [
"Downtown"
]
},
"neigh_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Description of the area in which the property is located."
},
"allow": [
null,
""
],
"examples": [
"Fabulous Downtown Morgantown"
]
}
}
}
]
},
"prop_directions": {
"type": "string",
"flags": {
"default": null,
"description": "Directions to the location of the listing."
},
"allow": [
null,
""
],
"examples": [
"Down the road"
]
}
}
},
"structure": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"builder_name": {
"type": "string",
"flags": {
"default": null,
"description": "Name of the builder of the property or builder s tract."
},
"allow": [
null,
""
],
"examples": [
"Standard Pacific"
]
},
"stories": {
"type": "number",
"flags": {
"default": null,
"description": "The number of floors in the property being sold."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
2
]
},
"total_units": {
"type": "number",
"flags": {
"default": null,
"description": "Total number of units for a property/building"
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
1
]
},
"total_buildings": {
"type": "number",
"flags": {
"default": null,
"description": "Total number of buildings on property"
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
1
]
},
"unit_level": {
"type": "string",
"flags": {
"default": null,
"description": "Level/Story where the unit resides in the building"
},
"allow": [
null,
""
],
"examples": [
"one"
]
},
"building_name": {
"type": "string",
"flags": {
"default": null,
"description": "Name of the building on the property"
},
"allow": [
null,
""
],
"examples": [
"Some Name"
]
},
"has_garage": {
"type": "boolean",
"flags": {
"default": false,
"description": "A flag indicating that the listing has a garage."
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_parking": {
"type": "boolean",
"flags": {
"default": false,
"description": "A flag indicating that the listing has a parking."
},
"allow": [
null
],
"examples": [
"true"
]
},
"parking_total": {
"type": "number",
"flags": {
"default": null,
"description": "The total number of parking spaces included in the sale."
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
2
]
},
"parking_features": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"flags": {
"description": "A list of features or description of the parking included in the sale/lease. Items separated by commas."
},
"examples": [
"Garage"
]
}
]
},
"appliances": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Dishwasher"
]
}
]
},
"architectural_styles": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Cape Cod"
]
}
]
},
"architectural_design": {
"type": "string",
"flags": {
"default": null,
"description": "Description of the architectural design of the property listed"
},
"allow": [
null,
""
],
"examples": [
"Ranch"
]
},
"interior_features": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"has_fireplace": {
"type": "boolean",
"flags": {
"default": false,
"description": "A flag indicating that the listing has a fireplace."
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_ceiling_fan": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_jetted_bath_tub": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_mother_in_law": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_sauna": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_security_system": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_skylight": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_vaulted_ceiling": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_wet_bar": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"is_cable_ready": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"is_wired": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
}
}
},
"exterior_features": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"has_hot_tub_spa": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_barbecue_area": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_deck": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_disabled_access": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_dock": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_garden": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_gated_entry": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_green_house": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_patio": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_pond": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_pool": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_porch": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_rv_parking": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"has_sports_court": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"has_sprinkler_system": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"is_water_front": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
}
}
},
"views": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Airport"
]
}
]
},
"roof_types": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Composition Single"
]
}
]
},
"foundation_details": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Pier & Beam"
]
}
]
},
"construction_materials": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Brick"
]
}
]
},
"heating_cooling": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Central A/C"
]
}
]
},
"floorings": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Carpet"
]
}
]
},
"basement_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Description of information and features about the master bedroom. i.e. None/Slab, Finished, Partially Finished, Crawl Space, Dirt, Outside Entrance, Radon Mitigation"
},
"allow": [
null,
""
],
"examples": [
"A list of information and features about the basement. i.e. None/Slab"
]
},
"master_bedroom_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Description of information and features about the master bedroom."
},
"allow": [
null,
""
],
"examples": [
"A list of information and features about the Master Bedroom."
]
},
"family_room_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Description of information and features about the family room."
},
"allow": [
null,
""
],
"examples": [
"A list of information and features about the Family Room."
]
},
"dining_room_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Description of information and features about the dining room."
},
"allow": [
null,
""
],
"examples": [
"A list of information and features about the Dining Room."
]
},
"living_room_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Description of information and features about the living room."
},
"allow": [
null,
""
],
"examples": [
"A list of information and features about the Living Room"
]
},
"fireplace_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Description or list of information and features about the fireplace(s)."
},
"allow": [
null,
""
],
"examples": [
"A list of features or description of the fireplace(s) included in the sale/lease."
]
},
"utilities": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Electricity Available"
]
}
]
},
"water_source": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"flags": {
"description": "A list of the source(s) of water for the property. Items separated by commas."
},
"examples": [
"Private - Well"
]
}
]
},
"rooms_total": {
"type": "number",
"flags": {
"default": null,
"description": "The number of rooms in the dwelling."
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
8
]
},
"fireplaces_total": {
"type": "number",
"flags": {
"default": null,
"description": "The number of fireplaces in the dwelling."
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
2
]
},
"is_new_construction": {
"type": "boolean",
"flags": {
"presence": "required",
"description": "A flag indicating that the property is newly constructed and has not been previously occupied."
},
"examples": [
"false"
]
}
}
},
"green_home": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"indoor_air_quality": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Moisture Control"
]
}
]
},
"water_conservation": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Gray Water System"
]
}
]
},
"energy_efficient": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Insulation"
]
}
]
},
"energy_generation": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"Solar"
]
}
]
},
"building_verification_type": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"examples": [
"ENERGY STAR Certified Homes"
]
}
]
},
"energy_grade_level": {
"type": "string",
"flags": {
"default": null,
"description": "Energy grade level of the structure on property."
},
"allow": [
null,
""
],
"examples": [
"A"
]
},
"co2_class": {
"type": "string",
"flags": {
"default": null,
"description": "CO2 class of the structure on property."
},
"allow": [
null,
""
],
"examples": [
"G"
]
}
}
},
"expenses": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"expense_value": {
"type": "number",
"flags": {
"default": null,
"description": "Money or value of expense with an optional currency period."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
200
]
},
"expense_freq": {
"type": "string",
"flags": {
"default": null,
"description": "The frequency the expense is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time, etc."
},
"allow": [
null,
""
],
"examples": [
"Quarterly"
]
},
"expense_category": {
"type": "string",
"flags": {
"default": null,
"description": "A type of monetary expense."
},
"allow": [
null,
""
],
"examples": [
"Trash Fee"
]
}
}
}
]
},
"hoa": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"has_assoc": {
"type": "boolean",
"flags": {
"default": false,
"description": "Status of the HOA requirements (Ex. Mandatory, Optional, etc.)"
},
"allow": [
null
],
"examples": [
"true"
]
},
"assoc_req": {
"type": "string",
"flags": {
"default": null,
"description": "Status of the HOA requirements (Ex. Mandatory, Optional, etc.)"
},
"allow": [
null,
""
],
"examples": [
"Mandatory"
]
},
"assoc_fee": {
"type": "number",
"flags": {
"default": null,
"description": "A fee paid by the homeowner to the Home Owners Association which is used for the upkeep of the common area, neighborhood or other association related benefits."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
200
]
},
"assoc_fee_freq": {
"type": "string",
"flags": {
"default": null,
"description": "The frequency the association fee is paid. For example, Weekly, Monthly, Annually, Bi-Monthly, One Time, etc."
},
"allow": [
null,
""
],
"examples": [
"Monthly"
]
},
"assoc_amenities": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"PROVIDE DESCRIPTION HERE"
]
}
]
},
"assoc_fee_includes": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Water"
]
}
]
}
}
}
]
},
"taxes": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"tax_amt": {
"type": "number",
"flags": {
"default": null,
"description": "The annual property tax amount as of the last assessment made by the taxing authority."
},
"rules": [
{
"name": "min",
"args": {
"limit": 0
}
},
{
"name": "precision",
"args": {
"limit": 2
}
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
4820
]
},
"tax_id": {
"type": "string",
"flags": {
"default": null,
"description": "ID of the taxes for the listing."
},
"allow": [
null,
""
],
"examples": [
"abh-4587526"
]
},
"tax_year": {
"type": "string",
"flags": {
"default": null,
"description": "The year in with the last assessment of the property value/tax was made."
},
"allow": [
null,
""
],
"examples": [
"16-17"
]
}
}
}
]
},
"marketing_info": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"display_listing": {
"type": "boolean",
"flags": {
"default": false,
"description": "The Display_listing Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"display_address": {
"type": "boolean",
"flags": {
"default": false,
"description": "A yes/no field that states the seller has allowed the listing address to be displayed on Internet sites."
},
"allow": [
null
],
"examples": [
"true"
]
},
"display_internet": {
"type": "boolean",
"flags": {
"default": false,
"description": "A yes/no field that states the seller has allowed the listing to be displayed on Internet sites."
},
"allow": [
null
],
"examples": [
"true"
]
},
"display_list_price": {
"type": "boolean",
"flags": {
"default": false,
"description": "Indicates if listing price is allowed to be displayed."
},
"allow": [
null
],
"examples": [
"true"
]
},
"display_photo": {
"type": "boolean",
"flags": {
"default": false,
"description": "Indicates if photos are allowed to be displayed."
},
"allow": [
null
],
"examples": [
"true"
]
},
"courtesy_location": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"BOTTOM"
]
},
"courtesy_label": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"Courtesy of"
]
},
"courtesy_of_list": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"North West Brokerage"
]
},
"courtesy_of_detail": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"North West Brokerage is an affiliate of Michigan Real Estate Coalition"
]
},
"photo_courtesy_required": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"false"
]
},
"vow": {
"type": "boolean",
"flags": {
"default": false
},
"allow": [
null
],
"examples": [
"true"
]
},
"legal_exclusive_rights": {
"type": "boolean",
"flags": {
"default": false
},
"examples": [
"false"
]
},
"legal_accept_disclaimer": {
"type": "boolean",
"flags": {
"default": false
},
"examples": [
"false"
]
}
}
},
"virtual_tours": {
"type": "array",
"flags": {
"default": null
},
"rules": [
{
"name": "min",
"args": {
"limit": 1
}
}
],
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"vt_url": {
"type": "string",
"flags": {
"default": null,
"description": "URL for virtual tour to market listing."
},
"allow": [
null,
""
],
"examples": [
"http://videos.listhub.com/listing/vt6564/1"
]
},
"vt_short_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Short description of virtual tour."
},
"allow": [
null,
""
],
"examples": [
"Awesome View"
]
},
"vt_updated_at": {
"type": "string",
"flags": {
"default": null,
"description": "Last updated"
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"vt_url_branded": {
"type": "boolean",
"flags": {
"default": false,
"description": "URL for branded virtual tour to market listing."
},
"allow": [
null
],
"examples": [
"false"
]
}
}
}
]
},
"virtual_tours_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Enable this lock if you prefer to manage the Virtual Tours via KW applications. Enabling this lock will disregard any import updates for Listing Status (from MLS or other provider). All other data in the listing will be updated."
},
"allow": [
null
],
"examples": [
"false"
]
},
"open_houses": {
"type": "array",
"flags": {
"default": null
},
"rules": [
{
"name": "min",
"args": {
"limit": 1
}
}
],
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"oh_start_dt": {
"type": "string",
"flags": {
"default": null,
"description": "The time the open house begins."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"oh_end_dt": {
"type": "string",
"flags": {
"default": null,
"description": "The time the open house ends."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"oh_updated_at": {
"type": "string",
"flags": {
"default": null,
"description": "Modification timestamp for open house."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"oh_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Description for the open house."
},
"allow": [
null,
""
],
"examples": [
"Come out and see this lovely property!"
]
},
"oh_status": {
"type": "string",
"flags": {
"default": null,
"description": "Status of the open house, i.e. Active, Cancelled, Ended."
},
"allow": [
null,
""
],
"examples": [
"Active"
]
},
"oh_appt_req": {
"type": "boolean",
"flags": {
"default": false,
"description": "Indicates whether or not the OpenHouse requires an appointment."
},
"allow": [
null
],
"examples": [
"false"
]
},
"virtual_oh_url": {
"type": "string",
"flags": {
"description": "Virtual open house URL"
},
"allow": [
null,
""
],
"examples": [
"https://www.facebook.com/RinaldiRealEstate/live/"
]
},
"is_oh_virtual": {
"type": "boolean",
"flags": {
"default": false,
"description": "Flag identifier for virtual open house"
},
"allow": [
null
],
"examples": [
"false"
]
}
}
}
]
},
"open_houses_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Enable this lock if you prefer to manage the Open Houses via KW applications. Enabling this lock will disregard any import updates for Listing Status (from MLS or other provider). All other data in the listing will be updated."
},
"allow": [
null
],
"examples": [
"false"
]
},
"photos": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"ph_order": {
"type": "number",
"flags": {
"description": "Integer used to indicate photo s sequence for a list of photos. Only a positive integer to be used."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"examples": [
1
]
},
"kw_ph_url": {
"type": "string",
"flags": {
"default": null,
"description": "KW URL for listing photo."
},
"allow": [
null,
""
],
"examples": [
"ourURL"
]
},
"ph_url": {
"type": "string",
"flags": {
"default": null,
"description": "Data provider URL for listing photo."
},
"allow": [
null,
""
],
"examples": [
"http://photos.listhub.net/SABORTX/1220171/1?lm=20170513T115831"
]
},
"ph_short_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Short description of photo."
},
"allow": [
null,
""
],
"examples": [
"Awesome View"
]
},
"ph_updated_at": {
"type": "string",
"flags": {
"default": null,
"description": "Last updated"
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"ph_tags": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"tag_name": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"wooden floors"
]
},
"tag_score": {
"type": "number",
"flags": {
"default": null
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
0.89
]
}
}
}
]
},
"ph_label": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"name": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"master bedroom"
]
},
"score": {
"type": "number",
"flags": {
"default": null
},
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
0.9
]
}
}
}
}
}
]
},
"photos_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Enable this lock if you prefer to manage the photos via KW applications. Enabling this lock will disregard any import updates for Listing Status (from MLS or other provider). All other data in the listing will be updated."
},
"allow": [
null
],
"examples": [
"false"
]
},
"links": {
"type": "array",
"flags": {
"default": null
},
"rules": [
{
"name": "min",
"args": {
"limit": 1
}
}
],
"allow": [
null
],
"items": [
{
"type": "object",
"keys": {
"link_url": {
"type": "string",
"flags": {
"default": null,
"description": "URL for video to market listing."
},
"allow": [
null,
""
],
"examples": [
"http://videos.listhub.com/listing/vt6564/1"
]
},
"link_short_desc": {
"type": "string",
"flags": {
"default": null,
"description": "Short description of link."
},
"allow": [
null,
""
],
"examples": [
"Awesome View"
]
},
"link_updated_at": {
"type": "string",
"flags": {
"default": null,
"description": "Modification timestamp for link."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
}
}
}
]
},
"links_lock": {
"type": "boolean",
"flags": {
"default": false,
"description": "Enable this lock if you prefer to manage the Links via KW applications. Enabling this lock will disregard any import updates for Links (from MLS or other provider). All other data in the listing will be updated."
},
"allow": [
null
],
"examples": [
"false"
]
},
"con_expiry_dt": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"publish_dt": {
"type": "string",
"flags": {
"default": null
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"mls_updated_at": {
"type": "string",
"flags": {
"default": null,
"description": "Last modification timestamp for listing as indicated by MLS."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"kw_updated_at": {
"type": "string",
"flags": {
"default": null,
"description": "Last modification timestamp for listing within KWLS."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"kw_created_at": {
"type": "string",
"flags": {
"default": null,
"description": "created timestamp for listing within KWLS."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"kw_updated_by": {
"type": "string",
"flags": {
"default": null,
"description": "User that made the last modification for listing within KWLS."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"raw": {
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"signature_id": {
"type": "number",
"flags": {
"default": null,
"description": "Raw signature_id."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
198
]
},
"market_center": {
"type": "string",
"flags": {
"default": null,
"description": "Raw market_center."
},
"allow": [
null,
""
],
"examples": [
"NC301-051"
]
},
"list_kw_uid": {
"type": "string",
"flags": {
"default": null,
"description": "Raw list_kw_uid."
},
"allow": [
null,
""
],
"examples": [
"373989"
]
},
"co_list_market_center": {
"type": "string",
"flags": {
"default": null,
"description": "Raw co_list_market_center."
},
"allow": [
null,
""
],
"examples": [
"NC301-051"
]
},
"co_list_kw_uid": {
"type": "string",
"flags": {
"default": null,
"description": "Raw co_list_kw_uid."
},
"allow": [
null,
""
],
"examples": [
"373988"
]
},
"lambda_updated_at": {
"type": "string",
"flags": {
"default": null,
"description": "Raw Modification timestamp added by Smarter Agent."
},
"allow": [
null,
""
],
"examples": [
"2017-12-14T00:54:00.000Z"
]
},
"display_listing": {
"type": "boolean",
"flags": {
"default": false,
"description": "Raw display_listing."
},
"allow": [
null
],
"examples": [
"false"
]
},
"list_status": {
"type": "string",
"flags": {
"default": null,
"description": "Raw List_status."
},
"allow": [
null,
""
],
"examples": [
"Active"
]
},
"list_status_id": {
"type": "number",
"flags": {
"default": null,
"presence": "required",
"description": "Raw List_status_id."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
10
]
},
"prop_type": {
"type": "string",
"flags": {
"default": null,
"description": "Raw Prop_type."
},
"allow": [
null,
""
],
"examples": [
"Single Family Residence"
]
},
"prop_type_id": {
"type": "number",
"flags": {
"default": null,
"description": "Raw Prop_type_id."
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
1
]
},
"source_list_id": {
"type": "string",
"flags": {
"default": null,
"description": "Raw Source_list_id."
},
"allow": [
null,
""
],
"examples": [
"173_2139217490"
]
},
"parking_total": {
"type": "string",
"flags": {
"default": null,
"description": "Raw Parking_total"
},
"allow": [
null,
""
],
"examples": [
"4+ Stalls"
]
},
"trace_id": {
"type": "string",
"flags": {
"default": null,
"description": "OpenTrace trace_id to preserve the data lineage from originating source to destination sources"
},
"allow": [
null,
""
],
"examples": [
"5396874466546068000"
]
}
}
},
"history": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"flags": {
"default": null
},
"allow": [
null
],
"keys": {
"other": {
"type": "boolean",
"flags": {
"default": false,
"description": "The Other Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"photo": {
"type": "boolean",
"flags": {
"default": false,
"description": "The Photo Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"price": {
"type": "number",
"flags": {
"default": null,
"description": "The Price Schema"
},
"rules": [
{
"name": "integer"
}
],
"preferences": {
"convert": false
},
"allow": [
null
],
"examples": [
4587612
]
},
"status": {
"type": "string",
"flags": {
"default": null,
"description": "The Status Schema"
},
"allow": [
null,
""
],
"examples": [
"For Sale"
]
},
"timestamp": {
"type": "string",
"flags": {
"default": null,
"description": "The Timestamp Schema"
},
"allow": [
null,
""
],
"examples": [
"2019-09-09T11:05:09.949Z"
]
},
"open_house": {
"type": "boolean",
"flags": {
"default": false,
"description": "The Open house Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"new_listing": {
"type": "boolean",
"flags": {
"default": false,
"description": "The New listing Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"virtual_tour": {
"type": "boolean",
"flags": {
"default": false,
"description": "The Virtual tour Schema"
},
"allow": [
null
],
"examples": [
"true"
]
}
}
}
]
},
"kw_attribute": {
"type": "object",
"flags": {
"default": null,
"description": "kw specific attributes for branding purposes."
},
"allow": [
null
],
"keys": {
"kw_active": {
"type": "boolean",
"flags": {
"default": false,
"description": "The kw_active Schema"
},
"allow": [
null
],
"examples": [
"false"
]
},
"membership": {
"type": "object",
"flags": {
"default": null,
"description": "Information of various kw membership."
},
"allow": [
null
],
"keys": {
"luxury": {
"type": "boolean",
"flags": {
"default": false,
"description": "The luxury Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"commercial": {
"type": "boolean",
"flags": {
"default": false,
"description": "The commercial Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"land": {
"type": "boolean",
"flags": {
"default": false,
"description": "The land Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"kwyp": {
"type": "boolean",
"flags": {
"default": false,
"description": "The kwyp Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"gps": {
"type": "boolean",
"flags": {
"default": false,
"description": "The gps Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"maps_client": {
"type": "boolean",
"flags": {
"default": false,
"description": "The maps_client Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"maps_coach": {
"type": "boolean",
"flags": {
"default": false,
"description": "The maps_coach Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"maps_mastery_client": {
"type": "boolean",
"flags": {
"default": false,
"description": "The maps_mastery_client Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"keller_mortgage": {
"type": "boolean",
"flags": {
"default": false,
"description": "The keller_mortgage Schema"
},
"allow": [
null
],
"examples": [
"true"
]
},
"kww": {
"type": "boolean",
"flags": {
"default": false,
"description": "The kww Schema"
},
"allow": [
null
],
"examples": [
"true"
]
}
}
}
}
},
"pipeline_metadata": {
"type": "object",
"flags": {
"default": null,
"description": "Generated during pipeline execution to track log information"
},
"allow": [
null
],
"keys": {
"lib_version": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"allow": [
null,
""
],
"examples": [
"1.0.0"
]
},
"list_key": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"allow": [
null,
""
],
"examples": [
"TXSABOR-12324"
]
},
"list_id": {
"type": "number",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"allow": [
null,
""
],
"examples": [
"123"
]
},
"source_name": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"examples": [
"smartagent"
]
},
"function_log": {
"type": "array",
"flags": {
"default": null
},
"allow": [
null
],
"items": [
{
"type": "object",
"flags": {
"default": null
},
"keys": {
"func": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"allow": [
null,
""
],
"examples": [
"convert_listing"
]
},
"version": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"allow": [
null,
""
],
"examples": [
"someversion"
]
},
"start": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"examples": [
"2017-08-21T15:26:24.000Z"
]
},
"end": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"examples": [
"2017-08-21T15:26:24.000Z"
]
},
"bucket": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"allow": [
null,
""
],
"examples": [
"kwls_raw"
]
},
"file": {
"type": "string",
"flags": {
"default": null,
"description": "An explanation about the purpose of this instance."
},
"allow": [
null,
""
],
"examples": [
"102/102_2153866609_1584584007000"
]
}
}
}
]
}
}
}
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment