Web Service

v3.4.5-1.0.3

Authentication

The web service uses an API key. Ensure that the following header is included in all your requests. The API key starts with alk_ (aios listing key).

This can be generated on the backend via AIOS Listings > Settings > API Settings.

AIOS-LISTINGS-API-KEY: alk_xxxxxxxxxxx

Errors

Response	Description
`403` - Access is forbidden	If API key header is missing or incorrect
`403` - Insufficient permissions	If the API key is correct but no permissions to execute the request method

Endpoints

GET `/listing`

URL: http://domain.com/wp-json/aios-listings/v1/listing
This allows you to pull the data for all listings on the Agent Image website.

Request

Field	Required?	Type	Description
`post_status`	No	String	Accepted values follow. Default: `publish` Other options: `pending` `draft` `private`
`posts_per_page`	No	Integer	Accepted values follow. Default: `-1` Other options: Any whole number.
`order`	No	String	Accepted values follow. Default: `DESC` Other options: `ASC` `DESC`
`orderby`	No	String	Accepted values follow. Default: `DATE` Other options: `TITLE` `DATE` `MENU_ORDER` `RAND` `ID` `MODIFIED`
`search`	No	String	This will search for text on the listing title and listing description.

Response

html


{
    "id": 37,
    "title": "Dev Testing",
    "author": "Agentimage",
    "date_created": "May 10, 2024",
    "url": "http://genstonerealtycom-new.rs5.aios-staging.com/listings/devtest/",
    "featured_image": "http://genstonerealtycom-new.rs5.aios-staging.com/wp-content/uploads/2024/05/3729-3.jpg",
    "listing_details": {
        "temporary_status": "1",
        "featured_property": "1",
        "address_street_number": "16150 N",
        "address_street_name": "Arrowhead Fountain Center Dr Suite",
        "address_unit_number": "400",
        "address_city": "Peoria",
        "address_state": "AZ",
        "address_zip_code": "85382",
        "map_latitude": "33.92873511210546",
        "map_longitude": "-118.39774847030641",
        "map_zoom": "17",
        "full_address": "16150 N Arrowhead Fountain Center Dr Suite 400 Peoria AZ 85382",
        "details_mls_number": "RX-10960478",
        "details_date_listed": "2024-5-13",
        "details_bedrooms": "4",
        "details_bathrooms": "4",
        "details_garage_spaces": "4",
        "details_architectural_styles": "Modern",
        "details_year_built": "2016",
        "details_condition_status": "New",
        "details_lot_area": "",
        "details_flooring_size": "2149",
        "details_appx_living_area": "2149",
        "details_lot_area_units": "acres",
        "details_flooring_size_units": "sq. ft",
        "details_appx_living_area_units": "acres",
        "property_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent luctus elementum nisi, eu bibendum massa consectetur sed. Vestibulum cursus scelerisque mi eget pulvinar. Etiam lacinia at massa sed faucibus.",
        "price_currency": "Dollar",
        "price_arrangement": "N/A",
        "list_price": "4950000",
        "sold_price": "",
        "display_sold": "",
        "price": "4950000",
        "others_website_title": "Open Website",
        "others_website_link": "https://www.agentimage.com",
        "others_virtual_tour_title": "Open Virtual Tour",
        "others_virtual_tour_link": "https://www.agentimage.com/virtual-tour",
        "others_pdf_title": "Open PDF File",
        "others_pdf_link": "https://www.agentimage.com/sample.pdf",
        "aios_neighborhoods": [],
        "more_location_information": {
            "details_country": "United States",
            "details_subdivision": "ES Ville",
            "details_mls_area": "El Segundo",
            "details_region": "CA"
        },
        "more_interior_features": {
            "details_heating": "Heat pumps",
            "details_rooms": "Suite",
            "details_cooling": "Central cooling",
            "details_floors": "Tiles",
            "details_interior_additionals": null
        },
        "more_exterior_features": {
            "details_style": "Portico",
            "details_stories": "2",
            "details_zoning": "2100",
            "details_exterior_additionals": ""
        },
        "more_schools": {
            "details_school_district": "El Segundo Unified School District",
            "details_js_high_school": "El Segundo Unified Jr. High School",
            "details_high_school": "El Segundo Unified High School",
            "details_college": ""
        },
        "more_additional_information": {
            "details_apn": "4139-006-063",
            "details_short_sale": "4.38 M",
            "details_hoa_fee": "400",
            "details_hoa_frequency": "Monthly"
        }
    },
    "property_features": [
        {
            "id": 3,
            "name": "Central Air Conditioning"
        },
        {
            "id": 4,
            "name": "Fireplace"
        },
        {
            "id": 5,
            "name": "Garage"
        },
        {
            "id": 6,
            "name": "Pool"
        }
    ],
    "property_types": [
        {
            "id": 13,
            "name": "Residential"
        },
        {
            "id": 14,
            "name": "Single Family"
        }
    ],
    "property_statuses": [
        {
            "id": 18,
            "name": "For Sale"
        }
    ],
    "property_images": [
    "http://genstonerealtycom-new.rs5.aios-staging.com/wp-content/uploads/2024/05/1667-2.jpg",
        "http://genstonerealtycom-new.rs5.aios-staging.com/wp-content/uploads/2024/05/1667-3.jpg",
        "http://genstonerealtycom-new.rs5.aios-staging.com/wp-content/uploads/2024/05/1667-4.jpg"
    ]
}

Errors

Message	Description
`500` - Failed to get listing. Please try again later.	The request triggered an unexpected error which will be logged and investigated.

GET `/listing/<listing_id>`

URL: http://domain.com/wp-json/aios-listings/v1/listing/<listing_id>
This allows you to pull the data of a specific listing.

Request

This endpoint does not accept any parameter.

Response

html


{
    "id": 37,
    "title": "Dev Testing",
    "author": "Agentimage",
    "date_created": "May 10, 2024",
    "url": "http://genstonerealtycom-new.rs5.aios-staging.com/listings/devtest/",
    "featured_image": "http://genstonerealtycom-new.rs5.aios-staging.com/wp-content/uploads/2024/05/3729-3.jpg",
    "listing_details": {
        "temporary_status": "1",
        "featured_property": "1",
        "address_street_number": "16150 N",
        "address_street_name": "Arrowhead Fountain Center Dr Suite",
        "address_unit_number": "400",
        "address_city": "Peoria",
        "address_state": "AZ",
        "address_zip_code": "85382",
        "map_latitude": "33.92873511210546",
        "map_longitude": "-118.39774847030641",
        "map_zoom": "17",
        "full_address": "16150 N Arrowhead Fountain Center Dr Suite 400 Peoria AZ 85382",
        "details_mls_number": "RX-10960478",
        "details_date_listed": "2024-5-13",
        "details_bedrooms": "4",
        "details_bathrooms": "4",
        "details_garage_spaces": "4",
        "details_architectural_styles": "Modern",
        "details_year_built": "2016",
        "details_condition_status": "New",
        "details_lot_area": "",
        "details_flooring_size": "2149",
        "details_appx_living_area": "2149",
        "details_lot_area_units": "acres",
        "details_flooring_size_units": "sq. ft",
        "details_appx_living_area_units": "acres",
        "property_description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent luctus elementum nisi, eu bibendum massa consectetur sed. Vestibulum cursus scelerisque mi eget pulvinar. Etiam lacinia at massa sed faucibus.",
        "price_currency": "Dollar",
        "price_arrangement": "N/A",
        "list_price": "4950000",
        "sold_price": "",
        "display_sold": "",
        "price": "4950000",
        "others_website_title": "Open Website",
        "others_website_link": "https://www.agentimage.com",
        "others_virtual_tour_title": "Open Virtual Tour",
        "others_virtual_tour_link": "https://www.agentimage.com/virtual-tour",
        "others_pdf_title": "Open PDF File",
        "others_pdf_link": "https://www.agentimage.com/sample.pdf",
        "aios_neighborhoods": [],
        "more_location_information": {
            "details_country": "United States",
            "details_subdivision": "ES Ville",
            "details_mls_area": "El Segundo",
            "details_region": "CA"
        },
        "more_interior_features": {
            "details_heating": "Heat pumps",
            "details_rooms": "Suite",
            "details_cooling": "Central cooling",
            "details_floors": "Tiles",
            "details_interior_additionals": null
        },
        "more_exterior_features": {
            "details_style": "Portico",
            "details_stories": "2",
            "details_zoning": "2100",
            "details_exterior_additionals": ""
        },
        "more_schools": {
            "details_school_district": "El Segundo Unified School District",
            "details_js_high_school": "El Segundo Unified Jr. High School",
            "details_high_school": "El Segundo Unified High School",
            "details_college": ""
        },
        "more_additional_information": {
            "details_apn": "4139-006-063",
            "details_short_sale": "4.38 M",
            "details_hoa_fee": "400",
            "details_hoa_frequency": "Monthly"
        }
    },
    "property_features": [
        {
            "id": 3,
            "name": "Central Air Conditioning"
        },
        {
            "id": 4,
            "name": "Fireplace"
        },
        {
            "id": 5,
            "name": "Garage"
        },
        {
            "id": 6,
            "name": "Pool"
        }
    ],
    "property_types": [
        {
            "id": 13,
            "name": "Residential"
        },
        {
            "id": 14,
            "name": "Single Family"
        }
    ],
    "property_statuses": [
        {
            "id": 18,
            "name": "For Sale"
        }
    ],
    "property_images": [
        "http://genstonerealtycom-new.rs5.aios-staging.com/wp-content/uploads/2024/05/1667-2.jpg",
        "http://genstonerealtycom-new.rs5.aios-staging.com/wp-content/uploads/2024/05/1667-3.jpg",
        "http://genstonerealtycom-new.rs5.aios-staging.com/wp-content/uploads/2024/05/1667-4.jpg"
    ]
}

Errors

Message	Description
`404` - ID does not exist.	The requested `<listing_id>` does not exist.
`404` - Listing does not exist.	The requested `<listing_id>` has been removed.
`500` - Failed to fetch the listing. Please try again later.	The request triggered an unexpected error which will be logged and investigated.

POST `/listing/`

URL: http://domain.com/wp-json/aios-listings/v1/listing/<listing_id>
This allows you to upload a single listing to the Agent Image website.

Request

Field	Required?	Type	Description
`featured_property`	No	Boolean	Option to set the property as Featured. Default: `0`
`temporary_status`	No	Boolean	Option to set the property temporary status to Coming Soon Default: `0`
`address_street_number`	No	String	The Street Number of the property
`address_street_name`	No	String	The Street Name of the property
`address_unit_number`	No	String	The Unit Number of the property
`address_city`	No	String	The City of the property
`address_state`	No	Integer	The State of the property should be integer matched to their respective number. Accepted values follow. `23` - Alabama `24` - Alaska `25` - Arizona `26` - Arkansas `27` - California `28` - Colorado `29` - Connecticut `30` - Delaware `31` - District of Columbia `32` - Florida `33` - Georgia `34` - Hawaii `35` - Idaho `36` - Illinois `37` - Indiana `38` - Iowa `39` - Kansas `40` - Kentucky `41` - Louisiana `42` - Maine `43` - Maryland `44` - Massachusetts `45` - Michigan `46` - Minnesota `47` - Mississippi `48` - Missouri `49` - Montana `50` - Nebr /aska `51` - Nevada `52` - New Hampshire `53` - New Jersey `54` - New Mexico `55` - New York `56` - North Carolina `57` - North Dakota `58` - Ohio `59` - Oklahoma `60` - Oregon `61` - Pennsylvania `62` - Rhode Island `63` - South Carolina `64` - South Dakota `65` - Tennessee `66` - Texas `67` - Utah `68` - Vermont `69` - Virginia `70` - Washington `71` - West Virginia `72` - Wisconsin `73` - Wyoming
`address_zip_code`	No	String	The Zip Code of the property
`map_latitude`	No	String	The Latitude of the property
`map_longitude`	No	String	The Longitude of the property
`map_zoom`	No	Integer	The Zoom ratio of the Map Default: `17` Other options: Any whole number between `1 to 20`
`details_mls_number`	No	String	The MLS Number of the property
`details_date_listed`	No	Date	Date Listed Format: YYYY-MM-DD `2024-5-10`
`details_bedrooms`	No	Integer	Number of Bedrooms of the property Default: `0` Other Options: Any whole number between `0 to 25`
`details_bathrooms`	No	Integer/Float	Number of Bedrooms of the property Default: `0` Other Options: Decimal Numbers by `.5; - 0.5 to 25.5`
`details_garage_spaces`	No	Integer	Number of Garage Spaces on the property Default: `0` Other Options: Whole Numbers `0 to 25`
`details_architectural_styles`	No	String	Architectural Styles of the property Default: `–` Other Options: `Adobe Revival` `Beach` `Bungalow` `Cape Cod` `Colonial` `Contemporary` `Contemporary Craftsman` `Country` `Craftsman` `English Cottage` `Farmhouse` `Federal Colonial` `Florida` `French` `Georgian` `Greek Revival` `Log / Chalet` `Mediterranean` `Mid-Century Modern` `Modern` `Mountain` `Northwest` `Prairie` `Ranch` `Shingle` `Spanish` `Southern` `Southwest` `Traditional` `Tudor` `Tuscan` `Victorian`
`details_year_built`	No	String	The Year Built of the property
`details_condition_status`	No	String	The Condition Status of the property
`details_lot_area`	No	Float	The Lot Area of the property
`details_flooring_size`	No	Float	The Flooring Size of the property
`details_appx_living_area`	No	Float	The Approximate Living Area of the property
`details_lot_area_units`	No	String	Lot Area Size Unit of the property Default:`acres` Other options: `acres` `sq. ft` `sq. m.` `hectares`
`details_flooring_size_units`	No	String	Floor Size Unit of the property Default: `acres` Other options: `acres` `sq. ft` `sq. m.` `hectares`
`details_appx_living_area_units`	No	String	Approx Living Area Size Unit of the property Default: `acres` Other options: `acres` `sq. ft` `sq. m.` `hectares`
`price_currency`	No	String	Price Currency of the property Default: `Dollar` Other Option: Dollar Australian Dollar Pound Yen Euro Lira
`price_arrangement`	No	String	Price arrangement of the property Default: `N/A` Other Options: `N/A` `Monthly`
`list_price`	No	Float	The List Price of the property
`sold_price`	No	Float	The Sold Price of the property
`display_sold`	No	Boolean	Option to show Sold Price instead of the List Price Default: `0`
`others_website_title`	No	String	The Website Title of the property
`others_website_link`	No	String	The Website Link of the property
`others_virtual_tour_title`	No	String	The Virtual Tour Title of the property
`others_virtual_tour_link`	No	String	The Virtual Tour Link of the property
`others_pdf_title`	No	String	The PDF Title of the property
`others_pdf_link`	No	String	The PDF Link of the property
`details_country`	No	String	The property’s Country
`details_subdivision`	No	String	The property’s Subdivision
`details_mls_area`	No	String	The property’s MLS Area
`details_region`	No	String	The property’s region
`details_heating`	No	String	The Heating of the property
`details_rooms`	No	String	The Rooms of the property
`details_cooling`	No	String	The Cooling of the property
`details_floors`	No	String	The Floors of the property
`details_style`	No	String	The Style of the property
`details_stories`	No	String	The Stories of the property
`details_zoning`	No	String	The Zoning of the property
`details_school_district`	No	String	The School District near of the property
`details_jr_high_school`	No	String	The Jr High School near the property
`details_high_school`	No	String	The High school near the property
`details_college`	No	String	The College near the property
`details_apn`	No	String	The APN of the property
`details_short_sale`	No	String	The Shorty Sale of the property
`details_hoa_fee`	No	String	The HOA Fee of the property
`details_hoa_frequency`	No	String	The HOA Frequency of the property
`open_house_display_1`	No	Boolean	Property’s Open House 1 Display Default:`0`
`open_house_datestart_1`	No	Date	Property’s Open House 1 Date Start
`open_house_dateend_1`	No	Date	Property’s Open House 1 Date End
`open_house_timestart_1`	No	String	Property’s Open House 1 Time Start
`open_house_timeend_1`	No	String	Property’s Open House 1 Time End
`open_house_title_1`	No	String	Property’s Open House 1 Title
`open_house_description_1`	No	String	Property’s Open House 1 Description
`open_house_display_2`	No	Boolean	Property’s Open House 2 Display Default:`0`
`open_house_datestart_2`	No	Date	Property’s Open House 2 Date Start
`open_house_dateend_2`	No	Date	Property’s Open House 2 Date End
`open_house_timestart_2`	No	String	Property’s Open House 2 Time Start
`open_house_timeend_2`	No	String	Property’s Open House 2 Time End
`open_house_title_2`	No	String	Property’s Open House 2 Title
`open_house_description_2`	No	String	Property’s Open House 2 Description
`open_house_display_3`	No	Boolean	Property’s Open House 3 Display Default:`0`
`open_house_datestart_3`	No	Date	Property’s Open House 3 Date Start
`open_house_dateend_3`	No	Date	Property’s Open House 3 Date End
`open_house_timestart_3`	No	String	Property’s Open House 3 Time Start
`open_house_timeend_3`	No	String	Property’s Open House 3 Time End
`open_house_title_3`	No	String	Property’s Open House 3 Title
`open_house_description_3`	No	String	Property’s Open House 3 Description
`property_features`	No	Array	The Property Features of the property should be integer-matched to their respective number. Accepted values follow: `2` - Basement `3` - Central Air Conditioning `4` - Fireplace `5` - Garage `6` - Pool `7` - Water Front
`property_types`	No	Array	The Property Types of the Property should be integer-matched to their respective number. Accepted values follow: `8` - Commercial `9` - Condo/coop `10` - Investment `11` - Land `12` - Mobile/manufactured `13` - Residential `14` - Single Family `15` - Townhouse `16` - Vacation
`property_statuses`	No	Array	The Property Statuses of the property should be integer-matched to their respective number. Accepted values follow: `17` - For Lease `18` - For Sale `19` - Open House `20` - Pending `21` - Sold

Response

html


{
    "success": true,
    "message": "Listing created successfully.",
    "post_id": <listing_id>
}

Errors

Message	Description
`400` - The State should be an integer, Please refer to the documentation.	The parameter `<address_state>` should be an integer and exist on the option
`400` - The Date Listed should follow the correct format; Please refer to the documentation.	The parameter `<details_date_listed>` should be followed the correct format (yyyy-mm-dd)
`400` - The Sold Date should follow the correct format; Please refer to the documentation.	The parameter `<sold_date>` should be followed the correct format (yyyy-mm-dd)
`400` - The Bedroom should be integer; Please refer to the documentation.	The parameter `<details_bedrooms>` should be followed the correct format.
`400` - The Bathroom should be integer or float; Please refer to the documentation.	The parameter `<details_bathrooms>` should be followed the correct format.
`400` - The Property Features should be an array that contains an integer/s, Please refer to the documentation.	The parameter `<property_features>` should be an integer and exist on the option
`400` - The Property Types should be an array that contains an integer/s, Please refer to the documentation.	The parameter `<property_types>` should be an integer and exist on the option
`400` - The Property Statuses should be an array that contains an integer/s, Please refer to the documentation.	The parameter `<property_statuses>` should be an integer and exist on the option
`400` - The Open House Date Start 1 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_datestart_1>` should be followed the correct format (yyyy-mm-dd)
`400` - The Open House Date End 1 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_dateend_1>` should be followed the correct format (yyyy-mm-dd)
`400` - The Open House Date Start 2 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_datestart_2>` should be followed the correct format (yyyy-mm-dd)
`400` - The Open House Date End 2 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_dateend_2>` should be followed the correct format (yyyy-mm-dd)
`400` - The Open House Date Start 3 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_datestart_3>` should be followed the correct format (yyyy-mm-dd)
`400` - The Open House Date End 3 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_dateend_3>` should be followed the correct format (yyyy-mm-dd)
`500` - Failed to create the listing. Please try again later.	The request triggered an unexpected error which will be logged and investigated.

POST `/listing/update/<listing_id>`

URL: http://domain.com/wp-json/aios-listings/v1/listing/update/<listing_id>
This allows you to update a single listing on the Agent Image website.

Request

Field	Required?	Type	Description
`featured_property`	No	Boolean	Option to set the property as Featured. Default: `0`
`temporary_status`	No	Boolean	Option to set the property temporary status to ”Coming Soon”
`address_street_number`	No	String	The Street Number of the property
`address_street_name`	No	String	The Street Name of the property
`address_unit_number`	No	String	The Unit Number of the property
`address_city`	No	String	The City of the property
`address_state`	No	Integer	The State of the property should be integer matched to their respective number. Accepted values follow: `23` - Alabama `24` - Alaska `25` - Arizona `26` - Arkansas `27` - California `28` - Colorado `29` - Connecticut `30` - Delaware `31` - District of Columbia `32` - Florida `33` - Georgia `34` - Hawaii `35` - Idaho `36` - Illinois `37` - Indiana `38` - Iowa `39` - Kansas `40` - Kentucky `41` - Louisiana `42` - Maine `43` - Maryland `44` - Massachusetts `45` - Michigan `46` - Minnesota `47` - Mississippi `48` - Missouri `49` - Montana `50` - Nebr /aska `51` - Nevada `52` - New Hampshire `53` - New Jersey `54` - New Mexico `55` - New York `56` - North Carolina `57` - North Dakota `58` - Ohio `59` - Oklahoma `60` - Oregon `61` - Pennsylvania `62` - Rhode Island `63` - South Carolina `64` - South Dakota `65` - Tennessee `66` - Texas `67` - Utah `68` - Vermont `69` - Virginia `70` - Washington `71` - West Virginia `72` - Wisconsin `73` - Wyoming
`address_zip_code`	No	String	The Zip Code of the property
`map_latitude`	No	String	The Latitude of the property
`map_longitude`	No	String	The Longitude of the property
`map_zoom`	No	Integer	The Zoom ratio of the Map Default: `17` Other options: Any whole number between `1 to 20`
`details_mls_number`	No	String	The MLS Number of the property
`details_date_listed`	No	Date	Date Listed Format: `YYYY-MM-DD` 2024-5-10
`details_bedrooms`	No	Integer	Number of Bedrooms of the property Default: `0` Other Options: Whole Numbers - `0 to 25`
`details_bathrooms`	No	Integer/Float	Number of Bedrooms of the property Default: `0` Other Options: Decimal Numbers by `.5; - 0.5 to 25.5`
`details_garage_spaces`	No	Integer	Number of Garage Spaces on the property Default: `0` Other Options: Whole Numbers - `0 to 25`
`details_architectural_styles`	No	String	Architectural Styles of the property Default - `–` Other Options `Adobe Revival` `Beach` `Bungalow` `Cape Cod` `Colonial` `Contemporary` `Contemporary Craftsman` `Country` `Craftsman` `English Cottage` `Farmhouse` `Federal Colonial` `Florida` `French` `Georgian` `Greek Revival` `Log / Chalet` `Mediterranean` `Mid-Century Modern` `Modern` `Mountain` `Northwest` `Prairie` `Ranch` `Shingle` `Spanish` `Southern` `Southwest` `Traditional` `Tudor` `Tuscan` `Victorian`
`details_year_built`	No	String	The Year Built of the property
`details_condition_status`	No	String	The Condition Status of the property
`details_lot_area`	No	Float	The Lot Area of the property
`details_flooring_size`	No	Float	The Flooring Size of the property
`details_appx_living_area`	No	Float	The Approximate Living Area of the property
`details_lot_area_units`	No	String	Lot Area Size Unit of the property Default: `acres` Other options: `acres` `sq. ft` `sq. m.` `hectares`
`details_flooring_size_units`	No	String	Floor Size Unit of the property Default: `acres` Other options: `acres` `sq. ft` `sq. m.` `hectares`
`details_appx_living_area_units`	No	String	Approx Living Area Size Unit of the property Default: `acres` Other options: `acres` `sq. ft` `sq. m.` `hectares`
`price_currency`	No	String	Price Currency of the property Default: `Dollar` Other Option: `Dollar` `Australian Dollar` `Pound` `Yen` `Euro` `Lira`
`price_arrangement`	No	String	Price arrangement of the property Default: `N/A` Other Options: `N/A` `Monthly`
`list_price`	No	Float	The List Price of the property
`sold_price`	No	Float	The Sold Price of the property
`display_sold`	No	Boolean	Option to show Sold Price instead of the List Price Default: `0`
`others_website_title`	No	String	The Website Title of the property
`others_website_link`	No	String	The Website Link of the property
`others_virtual_tour_title`	No	String	The Virtual Tour Title of the property
`others_virtual_tour_link`	No	String	The Virtual Tour Link of the property
`others_pdf_title`	No	String	The PDF Title of the property
`others_pdf_link`	No	String	The PDF Link of the property
`details_country`	No	String	The property’s Country
`details_subdivision`	No	String	The property’s Subdivision
`details_mls_area`	No	String	The property’s MLS Area
`details_region`	No	String	The property’s region
`details_heating`	No	String	The Heating of the property
`details_rooms`	No	String	The Rooms of the property
`details_cooling`	No	String	The Cooling of the property
`details_floors`	No	String	The Floors of the property
`details_style`	No	String	The Style of the property
`details_stories`	No	String	The Stories of the property
`details_zoning`	No	String	The Zoning of the property
`details_school_district`	No	String	The School District near of the property
`details_jr_high_school`	No	String	The Jr High School near the property
`details_high_school`	No	String	The High school near the property
`details_college`	No	String	The College near the property
`details_apn`	No	String	The APN of the property
`details_short_sale`	No	String	The Shorty Sale of the property
`details_hoa_fee`	No	String	The HOA Fee of the property
`details_hoa_frequency`	No	String	The HOA Frequency of the property
`property_features`	No	Array	The Property Features of the property should be integer-matched to their respective number. Accepted values follow: `2` - Basement `3` - Central Air Conditioning `4` - Fireplace `5` - Garage `6` - Pool `7` - Water Front
`property_types`	No	Array	The Property Types of the Property should be integer-matched to their respective number. Accepted values follow: `8` - Commercial `9` - Condo/coop `10` - Investment `11` - Land `12` - Mobile/manufactured `13` - Residential `14` - Single Family `15` - Townhouse `16` - Vacation
`property_statuses`	No	Array	The Property Statuses of the property should be integer-matched to their respective number. Accepted values follow: `17` - For Lease `18` - For Sale `19` - Open House `20` - Pending `21` - Sold

Response

html


{
    "success": true,
    "message": "Listing updated successfully.",
    "post_id": <listing_id>
}

Errors

Message	Description
`404` - ID does not exist.	The requested `<listing_id>` does not exist.
`404` - Listing does not exist.	The requested `<listing_id>` has been removed.
`400` - The State should be an integer, Please refer to the documentation.	The parameter `<address_state>` should be an integer and exist on the option
`400` - The Bedroom should be integer; Please refer to the documentation.	The parameter `<details_bedrooms>` should be followed the correct format.
`400` - The Bathroom should be integer or float; Please refer to the documentation.	The parameter `<details_bathrooms>` should be followed the correct format.
`400` - The Date Listed should follow the correct format; Please refer to the documentation.	The parameter `<details_date_listed>` should be followed the correct
`400` - The Sold Date should follow the correct format; Please refer to the documentation.	The parameter `<sold_date>` should be followed the correct format
`400` - The Property Features should be an array that contains an integer/s, Please refer to the documentation.	The parameter `<property_features>` should be an
`400` - The Property Types should be an array that contains an integer/s, Please refer to the documentation.	The parameter `<property_types>` should be an integer
`400` - The Property Statuses should be an array that contains an integer/s, Please refer to the documentation.	The parameter `<property_statuses>` should be an
`400` - The Open House Date Start 1 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_datestart_1>` should be
`400` - The Open House Date End 1 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_dateend_1>` should be followed
`400` - The Open House Date Start 2 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_datestart_2>` should be
`400` - The Open House Date End 2 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_dateend_2>` should be followed
`400` - The Open House Date Start 3 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_datestart_3>` should be
`400` - The Open House Date End 3 should follow the correct format; Please refer to the documentation.	The parameter `<open_house_dateend_3>` should be followed
`500` - Failed to update listing. Please try again later.	The request triggered an unexpected error which will be logged and investigated.

POST /listing/delete/`<listing_id>`

URL: http://domain.com/wp-json/aios-listings/v1/listing/delete/<listing_id>
This allows you to delete a listing.

Request

This endpoint does not accept any parameter.

Response

html


{
    "success": true,
    "message": "Listing deleted successfully.",
    "listing_id": <listing_id>
}

Errors

Message	Description
`404` - ID does not exist.	The requested `<listing_id>` does not exist.
`404` - Listing does not exist.	The requested `<listing_id>` has been removed.
`500` - Failed to delete listing. Please try again later.	The request triggered an unexpected error which will be logged and investigated.

POST `/listing/featuredImage/<listing_id>`

URL: http://domain.com/wp-json/aios-listings/v1/listing/featuredImage/<listing_id>
This allows you to upload and set the property’s featured image

Request

Field	Required?	Type	Description
`image_url`	Yes	String	Property Featured Image URL
`hotlinking`	No	Boolean `1 or 0`	Add and use the image’s third-party link instead of uploading it to the server.

Response

shortcode


{
    "success": true,
    "message": "Featured image set successfully.",
    "listing_id": <listing_id>
}

Response if <hotlinking> is 1

html


{
    "success": true,
    "message": "Hotlinking Featured image is added successfully.",
    "listing_id": <listing_id>
}

Errors

Message	Description
`404` - ID does not exist.	The requested `<listing_id>` does not exist.
`404` - Listing does not exist.	The requested `<listing_id>` has been removed.
`400` - The image_url parameter does not exist.	The requested `<image_url>` was not included in the request.
`500` - Failed to set featured image. Please try again later.	The request triggered an unexpected error which will be logged and investigated.

POST `/listing/printableFlyerImage/<listing_id>`

URL: http://domain.com/wp-json/aios-listings/v1/listing/printableFlyerImage/<listing_id>
This allows you to upload the printable flyer image of the listing

Request

Field	Required?	Type	Description
`image_url`	Yes	String	The Property Printable Flyer Image URL

Response

html


{
    "success": true,
    "message": "Printable Flyer image set successfully.",
    "listing_id": <listing_id>
}

Errors

Message	Description
`404` - ID does not exist.	The requested `<listing_id>` does not exist.
`404` - Listing does not exist.	The requested `<listing_id>` has been removed.
`400` - The image_url parameter does not exist.	The requested `<image_url>` was not included in the request.
`500` - Failed to set printable flyer image. Please try again later.	The request triggered an unexpected error which will be logged and investigated.

Web Service

Authentication

Errors

Endpoints

GET /listing

Request

Response

Errors

GET /listing/<listing_id>

Request

Response

Errors

POST /listing/

Request

Response

Errors

POST /listing/update/<listing_id>

Request

Response

Errors

POST /listing/delete/<listing_id>

Request

Response

Errors

POST /listing/featuredImage/<listing_id>

Request

Response

Errors

POST /listing/printableFlyerImage/<listing_id>

Request

Response

Errors

GET `/listing`

GET `/listing/<listing_id>`

POST `/listing/`

POST `/listing/update/<listing_id>`

POST /listing/delete/`<listing_id>`

POST `/listing/featuredImage/<listing_id>`

POST `/listing/printableFlyerImage/<listing_id>`