Skip to content

Instantly share code, notes, and snippets.

@chadwilken
Last active July 9, 2018 15:20
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save chadwilken/37e6204c4eae12c71b176f665133120e to your computer and use it in GitHub Desktop.
Save chadwilken/37e6204c4eae12c71b176f665133120e to your computer and use it in GitHub Desktop.
Photos To Web Payload

Photo Collection

Attribute Type Description
version int The version of the photo collection, will increase as modifications are made
collectionUUID string A unique identifier for the collection, it will remain the same with subsequent versions
title string The title of the collection
subtitle string The subtitle of the collection
description string The long description explaining the project
categories Array<string> A list of categories the user applied to the collection
materials Array<string> A list of materials the user used in the collection
featuredPhoto string A URL to a featured image
photos Array<Photo> A list of photo objects containing a uri to the photo and it's creation time as a Unix timestamp
companyLogo String A logo or null for the company
seoData SeoData SEO data used for the various title and meta tags
Notes

The title should be used for the templates h1 and the subtitle for the h2.

Photo

Attribute Type Description
uri string The URI to the photo
createdAt int The Unix timestamp when the photo was captured
filename string The filename as it should be stored in Wordpress
alt string The text to use for the photos alt text

SeoData

Attribute Type Description
title string The value to be used for the title tag of the page
metaDescription string The value to use for the meta tag with the name "description"
{
"version": 1,
"collectionUUID": "93764b81-382b-4bda-ba14-95833707f882",
"title": "Residential Roofing Project",
"subtitle": "Near 12th & Aberdeen Lincoln NE 68512",
"description": "CompanyCam needed a new roof on their old building, so we took the job and made another happy customer.",
"categories": ["roofing", "reshingle", "flat roof"],
"materials": ["Owens Corning Weather Wood", "Tar Paper"],
"featuredPhoto": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
"companyLogo": "https://static.companycam.com/8/logo/small-a68298d9.png",
"photos": [
{
"uri": "https://static.companycam.com/8/roofing-project-2012501-1527873498-orig-f85140ef.jpg",
"createdAt": 1528406547,
"filename": "residential-roofing-white-castle-roofing-near-12th-aberdeen-lincoln-NE-68516.jpg",
"alt": "Residential Roofing White Castle Roofing Near Cross Streets Lincoln NE 68516"
}
],
"seoData": {
"title": "Residential Roofing Project Near 12th & Aberdeen, Lincoln NE 68516 | White Castle Roofing",
"metaDescription": "Residential Roofing Project Near 12th & Aberdeen, Lincoln NE 68516 | Presented by White Castle Roofing | Materials used: Shingles, Owens Corning, 3 Tab Shingles, Composite Shingles..."
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment