Shoot

Each Tenant is allowed a collection of Shoots.

These act as a grouping of 360 media, typically corresponding to a photoshoot session.

Get Shoot

get

Get an individual shoot by id

Authorizations

bearerapi_key

Path parameters

shootIdstringRequired

Unique shoot id

Example: 683606ee-9788-4d88-adb8-77119de4c6a2

tenantIdstringRequired

Unique tenant id

Example: f700d27e-64ed-4571-ae2e-8c948c1c296e

Responses

200

success

application/json

401

unauthorized

application/json

404

not found

application/json

get

HTTPcURLJavaScriptPython

GET /api/tenant/{tenantId}/shoot/{shootId} HTTP/1.1
Host: api.orb360.tech
Accept: */*

{
  "shoot": {
    "id": "683606ee-9788-4d88-adb8-77119de4c6a2",
    "version": 123,
    "createdBy": "auth0|dd5e21fb23efe45d1761ddce",
    "name": "Black Cat",
    "tenant": "fdb67f2e-219d-4771-b14f-a2ddc24b812b",
    "dateCreated": 1594988393066,
    "dateUpdated": 1594988393066,
    "published": true,
    "integrations": {
      "findByTag": {
        "enabled-apiKey": true,
        "enabled-public": true
      },
      "findById": {
        "enabled-apiKey": true,
        "enabled-public": true
      }
    },
    "generatedMediaPresets": {
      "360_V2": {
        "jpg": null,
        "gif": null,
        "mp4": null
      },
      "SINGLE_IMAGE": {
        "jpg": null
      },
      "VIDEO": {
        "m3u8": null
      }
    },
    "mediaNameFormat": "{tag:StyleNumber}",
    "mediaTagKeys": [
      "StyleNumber"
    ]
  }
}

List Shoots

get

List available Shoots within the requested Tenant

Authorizations

bearerapi_key

Path parameters

tenantIdstringRequired

Unique tenant id

Example: f700d27e-64ed-4571-ae2e-8c948c1c296e

Responses

200

success

application/json

401

unauthorized

application/json

get

HTTPcURLJavaScriptPython

GET /api/tenant/{tenantId}/shoot HTTP/1.1
Host: api.orb360.tech
Accept: */*

{
  "shoots": null
}