v1

latestOpenAPI 3.0.02026-07-24622596.0 KB

Projects

Add Photo

post/projects/{project_id}/photos

Path parameters

project_idstring id required

ID of the Project

Headers

X-CompanyCam-Userstring

Email of CompanyCam user to be designated as the creator

Request body

Example request

{
  "photo": {
    "coordinates": {
      "lat": 28.425852468018288,
      "lon": -81.47155671113255
    },
    "captured_at": 1637770053
  }
}

Response

The created project photo

idstring required

The unique ID for the photo

company_idstring

A unique identifier for the Company the Photo belongs to

creator_idstring

The id of the entity that created the Photo

creator_typestring

The type of the entity that created the Photo

creator_namestring

The display name of the entity that created the Photo

project_idstring

The unique ID of the project the Photo was captured at

processing_status'pending' | 'processing' | 'processed' | 'processing_error' | 'duplicate'

Indicates the Photo’s processing status.

status'active' | 'deleted'

The status of the Photo

hashstring

The MD5 hash of the photo

descriptionstring

A description of the photo

internalboolean

Indicates whether the photo is for internal use only and should not be used in marketing or other public materials

photo_urlstring

The link to the photo in the web app

captured_atinteger

Timestamp when the Photo was captured

created_atinteger

Timestamp when the photo was created on the server. This may differ from the captured_at field

updated_atinteger

Timestamp when the photo was last updated

Example response

{
  "id": "4782987471",
  "company_id": "8292212",
  "creator_id": "2789583992",
  "creator_type": "User",
  "creator_name": "Shawn Spencer",
  "project_id": "94772883",
  "processing_status": "processed",
  "status": "active",
  "coordinates": {
    "lat": 28.425852468018288,
    "lon": -81.47155671113255
  },
  "uris": [
    {
      "type": "original",
      "url": "https://static.companycam.com/VuS0rPvrnNA1490797262.jpg"
    },
    {
      "type": "web",
      "url": "https://static.companycam.com/VuS0rPvrnNA1490797262web.jpg"
    },
    {
      "type": "thumbnail",
      "url": "https://static.companycam.com/VuS0rPvrnNA1490797262small.jpg"
    }
  ],
  "hash": "00ab337b7399151e5d4aa3bd4226e8dd",
  "description": "The front of the house",
  "photo_url": "https://app.companycam.com/photos/8675309",
  "captured_at": 1152230396,
  "created_at": 1152230608,
  "updated_at": 1152230400
}