{ "description": "Rightmove Realtime Datafeed Json Schema for GetBranchPropertyList response", "type": "object", "properties": { "request_id": { "type": "string", "required": true, "description": "The unique ID of the request which this response is associated with" }, "message": { "type": "string", "required": true, "description": "The message content for the response" }, "success": { "type": "boolean", "required": true, "description": "Indicates whether or not the request was successful" }, "request_timestamp": { "type": "string", "required": true, "description": "The time at which the request was received in the format: dd-MM-yyyy HH:mm:ss" }, "response_timestamp": { "type": "string", "required": true, "description": "The time at which the response was sent in the format: dd-MM-yyyy HH:mm:ss" }, "branch": { "type": ["object","null"], "required": false, "description": "Information about the branch sent in the request", "properties": { "branch_id": { "type": [ "integer", "null" ], "id": "branch_id", "required": true, "description": "Unique Rightmove ID for the branch sent in the request" }, "channel":{ "type":["integer","null"], "id":"channel", "required":false, "enum":[1, 2, null], "description":"For dual branches it allows to retrieve all the properties for a specific channel" } }, "additionalProperties": false }, "property": { "type": [ "array", "null" ], "id": "property_list", "description": "The list of live properties on Rightmove for the branch sent in the request", "required": false, "uniqueItems": true, "items": { "type": "object", "id": "property", "required": true, "description": "The details of an individual property for this branch", "properties": { "rightmove_id": { "type": "integer", "id": "rightmove_id", "required": true, "description": "Rightmove's unique reference for this property" }, "agent_ref": { "type": "string", "id": "agent_ref", "required": true, "description": "The agent's unique reference for this property" }, "update_date": { "type": [ "string", "null" ], "id": "update_date", "required": false, "description": "The last update date provided for this property in the format: dd-MM-yyyy HH:mm:ss" }, "channel":{ "type": "integer", "id":"channel", "required":true, "enum":[1, 2], "description":"The channel for this property" } }, "additionalProperties": false } }, "errors": { "type": [ "array", "null" ], "required": false, "description": "The errors causing the request to fail", "minItems": 0, "items": { "type": [ "object", "null" ], "required": false, "properties": { "error_code": { "type": "string", "id": "error_code", "required": true, "description": "The unique Rightmove code for the error causing the request to fail" }, "error_description":{ "type":"string", "id":"error_description", "required":true, "description": "The full description of the error associated with the error code which has been generated" }, "error_value":{ "type":["string", "null"], "id":"error_value", "required":false, "description": "The value that caused this error" } }, "additionalProperties": false }, "additionalProperties": false }, "warnings": { "type": [ "array", "null" ], "required": false, "description": "The warning generated by the request", "minItems": 0, "items": { "type": [ "object", "null" ], "required": false, "properties": { "warning_code": { "type": "string", "id": "warning_code", "required": true, "description": "The unique Rightmove warning code generated due to failure to pass all of the business rules" }, "warning_description":{ "type":"string", "id":"warning_description", "required":true, "description": "The full description of the warning associated with the warning code which has been generated" }, "warning_value":{ "type":["string", "null"], "id":"warning_value", "required":false, "description": "The value that caused this warning" } }, "additionalProperties": false }, "additionalProperties": false } }, "additionalProperties": false }