Tours Update API

Route

PUT

Purpose

Parameters

token string 100 required

Authentication token for either an application or session.

application string 200

Slug of application being requested. This is used to determine the role being used to make the request and therefore evaluate if the requester has the correct permissions.

Possible values

planoauth
planoorder
planox2

session_view string 300

View of session object you would like returned.

id integer 400 required

Id of record being requested.

address string 400

Street address of property.

view string 500

The view attribute controls what data is returned about the requested record.

Possible values

default
planox_tour_photos
planox_tour_floor_plans
planox_tour_property_info
planox_tour_preferences
planox_tour_brochures
planox_tour_download
planox_side_menu

address2 string 500

Secondary street address of property.

city string 600

City of property.

province_iso string 700

ISO code of property's province or state.

postal_code string 800

Postal code of property. Please note that this is a string to account for postal codes with leading 0s.

mls_number string 900

MLS Number of property, this is also used a unique identifier for some properties.

bedrooms string 1000

Bedrooms on property.

bathrooms string 1100

Bathrooms on property.

sqft string 1200

Square Footage of property.

price string 1300

Listing price of property.

hide_sqft boolean 1400

Option to hide or show the sqft of property on marketing material.

Possible values

true
false

hide_price boolean 1500

Option to hide or show the price of property on marketing material.

Possible values

true
false

property_type string 1600

Description of property type. Active property types can be found at https://planocore.planomatic.com/documentation/list_items/property_type.

Possible values

single_family
condo_townhouse
duplex_townhouse
commercial
land

map_x float 1700

Latitude of tour's address.

map_y float 1800

Longitude of tour's address.

property_description string 1900

Public faceing description of property.

greeting string 2000

Greeting that shows up on a tour's PhotoPlan

custom_domain string 2100

Custom domain that directs to tour.

public_status string 2200

Status that marks tour as public or private.

Possible values

active
private

Request Body Example: application/json

          {"token": "Sw543vdfgswWg98", "application": "planoauth", "session_view": null, "id": 6495, "address": "2911 Walnut St.", "view": "default", "address2": "Suite A", "city": "Denver", "province_iso": "us_co", "postal_code": "80205", "mls_number": "p7754842", "bedrooms": "3", "bathrooms": "3.5", "sqft": "2,500", "price": "$300,000", "hide_sqft": true, "hide_price": true, "property_type": "single_family", "map_x": "40.2341", "map_y": "-74.6604", "property_description": "3 bedroom, 2 full bath Raised Ranch with super curb appeal in a desirable Candlewood Lake area neighborhood.", "greeting": "Welcome home...", "custom_domain": "2911walnutst.com", "public_status": "active"}

Responses

action-successful 200

This status indicates that the request was successful. If the request returns data, it can be found in the data key.

  {"code": 200, "data": {}, "status": "action-successful", "message": "..."}

invalid-token 401

This status is returned when the authentication token passed is invalid.

  {"code": 401, "status": "invalid-token", "message": "..."}

session-expired 401

This status is returned a session is older than seven days or hasn't been used in 72 hours. The user will need to reauthenticate. We allow our users to save a remember_me preference which will make there sessions last indefinitely.

  {"code": 401, "status": "session-expired", "message": "..."}

client-required 401

This status is returned when the user makeing the request doesn't have a client, employee or liaison record. This means that they don't have any roles or permissions. Because we only allow our clients to register as a client, the user should be redirected to the PlanoAuth clients registration page where they can use the `/api/v1/users/client_register` API to register as a client. Eventhough the request will not be successful, this status will still return a `session` object because a session token is needed to register as a user.

  {"code": 401, "status": "client-required", "message": "...", "session": {}}

missing-param 400

This status is returned when a required param was not passed with the request.

  {"code": 400, "status": "missing-param", "message": "...", "missing_param": "email"}

invalid-param 400

This status is returned when a param was invalid when passed. For example, passing an id that doesn't exist or passing an invalid email address.

  {"code": 400, "status": "invalid-param", "message": "...", "invalid_param": "email"}

application-crash 500

This status is returned when there is an internal server error. Please try again later.

  {"code": 500, "errors": "...", "status": "application-crash", "message": "..."}

mandrill-email-failed 500

This status is returned when there was an issue using Mandrill to send an email. Any time this response is returned, there will be a notification in the production notifications tab so the dev team will be away of the failure. These errors will most likely correlate with a data issue and will need to be invesigated.

  {"code": 500, "errors": "...", "status": "mandrill-email-failed", "message": "..."}

invalid-content-type 400

This status is returned if the request was made with the incorrect content-type so the request params could not be read. For more infromation on content-type, please refer to https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Type.

  {"code": 400, "status": "invalid-content-type", "message": "...", "content_type_passed": "application/json", "content_type_required": "text/plain"}

route-non-existent 500

Response returned when HTTP route does not exist.

  {"code": 500, "status": "route-non-existent", "message": "..."}

Uncommon Responses

The responses below are not very common.

no-params-decoded Uncommon

This status is returned the request body was decoded, but no params where found.

  {"code": 400, "status": "no-params-decoded", "message": "..."}

invalid-encoded-params Uncommon

This status is returned when the request body could not be decoded properly. This generally means that you are requesting a sensative_params API and your request body was not base64 encoded.

  {"code": 400, "errors": "...", "status": "invalid-encoded-params"}

route-not-found Uncommon

This status is returned when the route record being requested hasn't been deployed yet.

  {"code": 404, "path": "...", "status": "route-not-found", "message": "...", "http_method": "..."}

identify-request-error Uncommon

This status is returned when there is an internal server error before the route could be identified. Please try again later.

  {"code": 500, "errors": "...", "status": "identify-request-error", "message": "..."}

service-not-found Uncommon

This status is returned when the route's API service record being requested hasn't been deployed yet.

  {"code": 404, "status": "service-not-found", "message": "...", "route_id": "...", "api_service_key": "..."}