ac_get_property

ac_get_property

Description

Returns a list of properties and their details that match the given search criteria. Each detail structure contains the “id”, “name” and any extra information requested.

Version

Available from version 5.5.0.

Access

Read-only, master access not required, available to all users.

Parameters

Number	Name	O/R	Version	Usage
1	Auth	Required	5.5.0+	Authentication structure.*
2	Search	Optional	5.5.0+	Search for specific property names. This search may use * or % as wildcard characters.
3	Extra	Optional	5.20.0+	An array specifying extra information to return about each property: see table below.

*See call structure explanation.

Array key	Structure key	Description
	calendar_note	If not empty add the calendar note.
1	document_note	If not empty add the document note.
2	gps_coords	If not empty add the GPS coordinates.
3	social_links	If not empty add the social media links.
4	images	If not empty add the property images.
5	property_url	If not empty add the property web address.

Example

{

    "method": "ac_get_property",

    "params": [

        {

            "bridge_username":"username",

            "bridge_password":"password",

            "link_id":"4"

        },

        "",

        {

            "calendar_note":"0",

            "document_note":"0",

            "gps_coords":"0",

            "social_links":"1",

            "images":"0",

            "property_url":"1"

        }

    ],

    "id": 1

}

Response

{
    "id": 1,
    "error": null,
    "result": [
        {
            "id": "WB2",
            "name": "Mara River Lodge",
            "social_links": [],
            "property_url": "www.mararivertest.com"
        },
        {
            "id": "WB3",
            "name": "Beach Lodge",
            "social_links": [],
            "property_url": "www.beachlodgetest.com"
        },
        {
            "id": "WB5",
            "name": "Island Lake",
            "social_links": [],
            "property_url": "www.islandlaketest.co.za"
        },
        {
            "id": "WB6",
            "name": "Robben Island",
            "social_links": [],
            "property_url": "www.robbenislandtest.com"
        },
        {
            "id": "WB277",
            "name": "Staff Account",
            "social_links": [],
            "property_url": ""
        }
    ]
}

ac_get_property

Description

Version

Access

Parameters

Example

Keep up to date with us

Menu

Visit our website

ResRequest Modules