Caches Photo API

  1. API
  2. v1
  3. caches
  4. photo
    5. Check out List Item docs

Route

GET

Purpose


Parameters

id integer 1 required
Id of photo that cache is being requested for.
width integer 2
Width, in pixels, of cache being requested. The max width that can be requested is 1920px.
height integer 3
Height, in pixels, of cache being requested. The max height that can be requested is 1280px. If a width and height is passed, the width will take the priority.
aspect_ratio string 4
The aspect_ratio param can be used to customize the aspect ratio of the image.
Possible values
  • 4_3
  • 3_1
cw boolean 5
If the photos branding entity has a company watermark uploaded, true can be passed in the cw param to display this watermark on the south-east corner of the photo. If the branding entity doesn't have a watermark to inherit this parameter will be ignored.
vw boolean 6
If the photos vendor (PlanOmatic) has a vendor watermark uploaded, true can be passed in the vw param to display this watermark on the south-west corner of the photo. If the vendor doesn't have a watermark this parameter will be ignored.

Request Body Example: application/json

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.

planoworker-failed 400

This status indicates that PlanoWorker failed when trying to create the photo's cache.

invalid-token 401

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

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.

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.

missing-param 400

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

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.

application-crash 500

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

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.

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.

route-non-existent 500

Response returned when HTTP route does not exist.

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.

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.

route-not-found Uncommon

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

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.

service-not-found Uncommon

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