Authentication token for either an application or session.
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.
View of session object you would like returned.
Id of record being requested.
Street address of property.
The view attribute controls what data is returned about the requested record.
Secondary street address of property.
City of property.
ISO code of property's province or state.
Postal code of property. Please note that this is a string to account for postal codes with leading 0s.
MLS Number of property, this is also used a unique identifier for some properties.
Bedrooms on property.
Bathrooms on property.
Square Footage of property.
Listing price of property.
Option to hide or show the sqft of property on marketing material.
Option to hide or show the price of property on marketing material.
Description of property type. Active property types can be found at https://planocore.planomatic.com/documentation/list_items/property_type.
Latitude of tour's address.
Longitude of tour's address.
Public faceing description of property.
Greeting that shows up on a tour's PhotoPlan
Custom domain that directs to tour.
Status that marks tour as public or private.
Request Body Example:
This status indicates that the request was successful. If the request returns data, it can be found in the data key.
This status is returned when the authentication token passed is invalid.
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.
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.
This status is returned when a required param was not passed with the request.
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.
This status is returned when there is an internal server error. Please try again later.
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.
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.
Response returned when HTTP route does not exist.
The responses below are not very common.
This status is returned the request body was decoded, but no params where found.
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.
This status is returned when the route record being requested hasn't been deployed yet.
This status is returned when there is an internal server error before the route could be identified. Please try again later.
This status is returned when the route's API service record being requested hasn't been deployed yet.