Sign in

v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB
Property Claim

Attach uploaded media

post/v1/property_claims/{property_claim_id}/media

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Request body

upload_idstring uuid required

Used for attaching media to an object. They are created via POST /upload and expire after 24 hours since being issued.

A RFC 4122 compliant UUID in lowercase hexadecimal.

filenamestring required

Suggested filename for this media file.

content_typestring required

The MIME type of this media file.

Example request

{
  "upload_id": "f81d4fae-7dec-11d0-a765-00a0c91e6bf6",
  "filename": "Picture-1.jpg",
  "content_type": "image/jpeg"
}

Response

The Media was attached successfully.

filenamestring required

Suggested filename for this media file.

content_typestring required

The MIME type of this media file.

download_uristring required

A URI that can be used to download this media file.

Download links are valid for 24 hours.

labelsstring[] required
primary_server_createdstring date-time required

primary refers to the initial media creation.

server_created is the timestamp at which Encircle servers created the model. It is typically later than the client_created timestamp (unless the client had provided an inaccurate timestamp). This unbounded delay depends on how long the client took to sync with the server.

The Encircle mobile app allows users to work offline, which means that a client can create a model, wait a day, then go online and sync with Encircle servers. The server's timestamp would be delayed by about a day after the model's creation on the client.

Refer to client_created for the client provided timestamp.

A RFC 3339 compliant date-time string.

primary_client_createdstring date-time nullable required

primary refers to the initial media creation.

client_created is the timestamp at which a user's client created the model. It is typically earlier than the server_created timestamp, but since this timestamp is provided by the client and not verified, it could have been altered to any time in the past or future.

The Encircle mobile app allows users to work offline. This timestamp captures the time that the model was created locally, regardless of when the client goes back online.

Encircle web and mobile applications typically display the earlier of the client_created and server_created timestamps.

Refer to server_created for the timestamp recorded by Encircle servers.

A RFC 3339 compliant date-time string.

secondary_server_createdstring date-time

secondary refers to each time the same media is generated or edited. It only exists on report and export media.

server_created is the timestamp at which Encircle servers created the model. It is typically later than the client_created timestamp (unless the client had provided an inaccurate timestamp). This unbounded delay depends on how long the client took to sync with the server.

The Encircle mobile app allows users to work offline, which means that a client can create a model, wait a day, then go online and sync with Encircle servers. The server's timestamp would be delayed by about a day after the model's creation on the client.

Refer to client_created for the client provided timestamp.

A RFC 3339 compliant date-time string.

secondary_client_createdstring date-time nullable

secondary refers to each time the same media is generated or edited. It only exists on report and export media.

client_created is the timestamp at which a user's client created the model. It is typically earlier than the server_created timestamp, but since this timestamp is provided by the client and not verified, it could have been altered to any time in the past or future.

The Encircle mobile app allows users to work offline. This timestamp captures the time that the model was created locally, regardless of when the client goes back online.

Encircle web and mobile applications typically display the earlier of the client_created and server_created timestamps.

Refer to server_created for the timestamp recorded by Encircle servers.

A RFC 3339 compliant date-time string.

Example response

{
  "filename": "Picture-1.jpg",
  "content_type": "image/jpeg",
  "labels": [
    "Exterior"
  ],
  "primary_server_created": "1969-07-20T20:17:40Z",
  "primary_client_created": "1969-07-20T20:17:40Z",
  "secondary_server_created": "1969-07-20T20:17:40Z",
  "secondary_client_created": "1969-07-20T20:17:40Z",
  "source": {
    "type": "ClaimRoomAfterPicture",
    "primary_id": "1",
    "secondary_id": "1"
  }
}