Introduction

Welcome to the SewerAI API (v1). This API enables authorized parties to transmit, store, and retrieve asset inspection information from our system, including data and videos. It also allows you to initiate AI computer vision (“AutoCode”) and retrieve the results of that process.

Quick Start

Optional: Create Organization(s)
Create Asset(s) - (owned by organizations)
Create Project(s)
Loop through inspection videos;
1. Create Inspection (of an asset, connected to a project)
2. Create Video and assign it the inspection from previous
3. Upload Video
Optional: AutoCode individual inspections or all in the project

Authentication

Please request an API token by contacting your point of contact at SewerAI or emailing: info at sewerai.com You must be a registered user to test or utiilize the API.

Swagger Playground

https://api.sewerai.com/api/schema/swagger/

Example Scripts

The following python scripts are examples on how to use the api…

# Test Values
from faker import Faker
fake = Faker()

org_name = fake.company()
asset_name = fake.catch_phrase()
project_name = fake.bs()

import requests

#setup constants
MY_INSPECTIONS_FOLDER = "MyInspections"

API_KEY = "<your-api-key>"

BASE_URL = "https://api.sewerai.com/v1"

headers = {
  'Content-Type': 'application/json',
  'Authorization': f"X-SAI {API_KEY}"
}

def create_organization(org: dict) -> (dict, int):
    payload = json.dumps(org)
    response = requests.post(
        url=f"{BASE_URL}/organizations/",
        headers=headers,
        data=payload
    )
    if response.status_code == 201:
        return json.loads(response.text), 201
    else:
        raise Exception(response.text)

def create_asset(asset: dict) -> (dict, int):
    payload = json.dumps(asset)
    response = requests.post(
        url=f"{BASE_URL}/assets/",
        headers=headers,
        data=payload
    )
    if response.status_code == 201:
        return json.loads(response.text), 201
    else:
        raise Exception(response.text)

def create_project(project: dict) -> (dict, int):
    payload = json.dumps(project)
    response = requests.post(
        url=f"{BASE_URL}/projects/",
        headers=headers,
        data=payload
    )
    if response.status_code == 201:
        return json.loads(response.text), 201
    else:
        raise Exception(response.text)

def create_inspection(inspection: dict) -> (dict, int):
    payload = json.dumps(inspection)
    response = requests.post(
        url=f"{BASE_URL}/inspections/",
        headers=headers,
        data=payload
    )
    if response.status_code == 201:
        return json.loads(response.text), 201
    else:
        raise Exception(response.text)

def get_inspection(inspection_sid: str):
    response = requests.get(
        url=f"{BASE_URL}/inspections/{inspection_sid}/",
        headers=headers
    )
    if response.status_code == 200:
        return json.loads(response.text)
    else:
        raise Exception(response.text)

def list_observations(inspection_sid: str):
    response = requests.get(
        url=f"{BASE_URL}/inspections/{inspection_sid}/observations/",
        headers=headers
    )
    if response.status_code == 200:
        return json.loads(response.text)
    else:
        raise Exception(response.text)

def create_video(video: dict) -> (dict, int):
    payload = json.dumps(video)
    response = requests.post(
        url=f"{BASE_URL}/videos/",
        headers=headers,
        data=payload
    )
    if response.status_code == 201:
        return json.loads(response.text), 201
    else:
        raise Exception(response.text)

def upload_video(name:str, path:str, upload_data: dict):
    url = upload_data['url']
    payload = {
        'key': upload_data['fields']['key'],
        'AWSAccessKeyId': upload_data['fields']['AWSAccessKeyId'],
        'policy': upload_data['fields']['policy'],
        'signature': upload_data['fields']['signature'],
    }
    files = [
        (
            "file",
            (
                name,
                open(path, "rb"),
                "application/octet-stream",
            ),
        )
    ]
    response = requests.post(
        url=url,
        headers={},
        data=payload,
        files=files
    )
#     print(response)
    return

def list_videos(video_sids: list):
    videos = list()
    for sid in video_sids:
        response = requests.get(
            url=f"{BASE_URL}/videos/{sid}/",
            headers=headers
        )
        if response.status_code == 200:
            videos.append(json.loads(response.text))
        else:
            print(response.text)
#             raise Exception(response.text)
    return videos

def run_autocode(inspection_sids: list = None, project_sids: list = None):
    payload = json.dumps({
        'inspections': inspection_sids,
        'projects': project_sids
    })
    response = requests.post(
        url=f"{BASE_URL}/inspections/AutoCode/",
        headers=headers,
        data=payload
    )
    if response.status_code == 200:
        return json.loads(response.text), 200
    else:
        raise Exception(response.text)

Create an Organization (optional)

org_sid = None
try:
    org = {
        'name': org_name,
        'city': 'Calebtown'
    }
    result = create_organization(org)

    org_sid = result[0]['sid']
except Exception as e:
    print(f"error: {e}")

Create an Asset

asset_sid = None
try:
    asset = {
        'name': asset_name,
        'owner': org_sid,
        'kind': 'mainline',  # ['mainline', 'lateral', 'maintenance-hole']
        'city': 'Calebtown'
    }
    result = create_asset(asset)

    asset_sid = result[0]['sid']
except Exception as e:
    print(f"error: {e}")

Create a Project

project_sid = None
try:
    project = {
        'name': project_name,
    }
    result = create_project(project)

    project_sid = result[0]['sid']
except Exception as e:
    print(f"error: {e}")

Create Inspections and Videos from a directory with video files

Folder structure in this example

~/my_inspections
Videos
- video1.mp4
- video2.mp4

import pathlib
import datetime
import uuid

path = pathlib.Path(f"{MY_INSPECTIONS_FOLDER}/Video")

files = [e for e in path.iterdir() if e.is_file()]

videos_list = list()
for file in files:
    inspection_sid = None
    try:
        inspection = {
            'key': str(uuid.uuid4()),  # A unique key for this inspection (if not provided, then a uuid is added),
            'projects': [project_sid, ],
            'asset': asset_sid,  # required
#             'owner': owner_sid,  # (optional)
#             'client': client_sid,  # (optional)
#             'reason': None,  # (optional) [operations-support, infiltation-and-inflow, new-install, etc.
            'city': 'Calebtown',
            'inspection_datetime': datetime.datetime.now().isoformat(),
            'begin_access_point': None,  # Or, create an asset for the beginning access point
            'end_access_point': None,  # Or, create an asset...
        }
        result = create_inspection(inspection)

        inspection_sid = result[0]['sid']

        video_path = str(file.resolve())
        result = create_video({
            'inspection': inspection_sid,
            'path': video_path
        })
        video_sid = result[0]['sid']
        videos_list.append(video_sid)
        upload_data = result[0]['presigned_upload_data']
        upload_video(result[0]['video_name'], video_path, upload_data)
    except Exception as e:
        print(f"error: {e}")

Check for Videos to be Encoded

# Wait at least 5 minutes before trying this example
videos = list_videos(videos_list)
videos_count = len(videos)
for v in videos:
    if v['stage'] == 'uploaded':
        videos_count -= 1
    else:
        print(v['stage'])
assert videos_count == 0, f"A video has not finished uploading. Try again in a bit."

Run AutoCode

inspections_to_autocode = list()
for v in videos:
    inspection_sid = v['inspection'].split('/')[-2]
    if v['stage'] == 'uploaded':
        inspections_to_autocode.append(inspection_sid)
# run_autocode(inspections_to_autocode)  # uncomment to run autocode

Check for Videos to be AutoCoded

# Wait at least 15-20 minutes before trying this example
videos = list_videos(videos_list)
videos_count = len(videos)
for v in videos:
    if v['stage'] == 'autocode_complete':
        videos_count -= 1
    else:
        print(f"{v['video_name']} --- {v['stage']}")
assert videos_count == 0, "A video has not finished autocoding. Try again in a bit."

List Observations

observations = list()
for v in videos:
    inspection_sid = v['inspection'].split('/')[-2]
    observations.append(
        list_observations(inspection_sid)
    )

Retrieve observation Grades for all autocode complete inspections

sid = "<inspection_sid>"
inspection = get_inspection(sid)
if inspection['autocode_complete'] == True:
    result = list_observations(sid)
    observations = result['results']
    for obs in observations:
        print(obs['Grade'])

Initiate and Fetch an Export

base_url = 'api.sewerai.com'
auth_token = 'some-jwt-token'
inspection_sids = ['<inspection_sid>', '<inspection_sid>']
export_name = "my-export"

headers = {
    'Content-Type': 'application/json',
    'Authorization': f'Bearer {auth_token}'
}

response = request.post(
    url=f"{base_url}/v1/exports/",
    headers=headers,
    data=json.dumps({
        "name": export_name,
        "inspection_sids": inspection_sids,
    })
)

export_sid = json.loads(response.text).get('sid')

response = request.get(
    url=f"{base_url}/v1/exports/{export_sid}",
    headers=headers,
)

export_completed = json.loads(response.text).get('completed')
# => if true, use _downloads_ fields in payload to get export files
# => if false, poll until _completed_ is true

SewerAI API v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

SewerAI API

Authentication

HTTP Authentication, scheme: bearer

API Key (tokenAuth)
- Parameter Name: Authorization, in: header. Token-based authentication with required prefix “X-SAI”

accounts

accounts_files_import_test_data_retrieve

Code samples

# You can also use wget
curl -X GET /accounts/{account_sid}/files/{sid}/import-test-data/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /accounts/{account_sid}/files/{sid}/import-test-data/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/accounts/{account_sid}/files/{sid}/import-test-data/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/accounts/{account_sid}/files/{sid}/import-test-data/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/accounts/{account_sid}/files/{sid}/import-test-data/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/accounts/{account_sid}/files/{sid}/import-test-data/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/accounts/{account_sid}/files/{sid}/import-test-data/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/accounts/{account_sid}/files/{sid}/import-test-data/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /accounts/{account_sid}/files/{sid}/import-test-data/

This endpoint is used by the import_test Django admin command to verify that an import has properly executed.

Parameters

Name	In	Type	Required	Description
account_sid	path	string	true	none
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "account": "http://example.com",
  "origin_path": "string",
  "name": "string",
  "kind": 0,
  "location": "string",
  "size": "string",
  "exists": "string",
  "upload_location": "string",
  "meta": {
    "property1": null,
    "property2": null
  }
}

Responses

Status	Meaning	Description	Schema
200	OK	none	File

api

api_schema_retrieve

Code samples

# You can also use wget
curl -X GET /api/schema/ \
  -H 'Accept: application/vnd.oai.openapi' \
  -H 'Authorization: API_KEY'

GET /api/schema/ HTTP/1.1

Accept: application/vnd.oai.openapi


const headers = {
  'Accept':'application/vnd.oai.openapi',
  'Authorization':'API_KEY'
};

fetch('/api/schema/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/vnd.oai.openapi',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/api/schema/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/vnd.oai.openapi',
  'Authorization': 'API_KEY'
}

r = requests.get('/api/schema/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/vnd.oai.openapi',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/api/schema/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/api/schema/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/vnd.oai.openapi"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/api/schema/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /api/schema/

OpenApi3 schema for this API. Format can be selected via content negotiation.

YAML: application/vnd.oai.openapi
JSON: application/vnd.oai.openapi+json

Parameters

Name	In	Type	Required	Description
format	query	string	false	none
lang	query	string	false	none

Enumerated Values

Parameter	Value
format	json
format	yaml
lang	af
lang	ar
lang	ar-dz
lang	ast
lang	az
lang	be
lang	bg
lang	bn
lang	br
lang	bs
lang	ca
lang	cs
lang	cy
lang	da
lang	de
lang	dsb
lang	el
lang	en
lang	en-au
lang	en-gb
lang	eo
lang	es
lang	es-ar
lang	es-co
lang	es-mx
lang	es-ni
lang	es-ve
lang	et
lang	eu
lang	fa
lang	fi
lang	fr
lang	fy
lang	ga
lang	gd
lang	gl
lang	he
lang	hi
lang	hr
lang	hsb
lang	hu
lang	hy
lang	ia
lang	id
lang	ig
lang	io
lang	is
lang	it
lang	ja
lang	ka
lang	kab
lang	kk
lang	km
lang	kn
lang	ko
lang	ky
lang	lb
lang	lt
lang	lv
lang	mk
lang	ml
lang	mn
lang	mr
lang	my
lang	nb
lang	ne
lang	nl
lang	nn
lang	os
lang	pa
lang	pl
lang	pt
lang	pt-br
lang	ro
lang	ru
lang	sk
lang	sl
lang	sq
lang	sr
lang	sr-latn
lang	sv
lang	sw
lang	ta
lang	te
lang	tg
lang	th
lang	tk
lang	tr
lang	tt
lang	udm
lang	uk
lang	ur
lang	uz
lang	vi
lang	zh-hans
lang	zh-hant

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

schemas

schemas_get_condition_schema_retrieve

Code samples

# You can also use wget
curl -X GET /schemas/get_condition_schema/ \
  -H 'Authorization: API_KEY'

GET /schemas/get_condition_schema/ HTTP/1.1


const headers = {
  'Authorization':'API_KEY'
};

fetch('/schemas/get_condition_schema/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/schemas/get_condition_schema/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get('/schemas/get_condition_schema/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/schemas/get_condition_schema/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/schemas/get_condition_schema/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/schemas/get_condition_schema/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /schemas/get_condition_schema/

Responses

Status	Meaning	Description	Schema
200	OK	No response body	None

schemas_get_header_fields_retrieve

Code samples

# You can also use wget
curl -X GET /schemas/get_header_fields/ \
  -H 'Authorization: API_KEY'

GET /schemas/get_header_fields/ HTTP/1.1


const headers = {
  'Authorization':'API_KEY'
};

fetch('/schemas/get_header_fields/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/schemas/get_header_fields/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.get('/schemas/get_header_fields/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/schemas/get_header_fields/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/schemas/get_header_fields/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/schemas/get_header_fields/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /schemas/get_header_fields/

Responses

Status	Meaning	Description	Schema
200	OK	No response body	None

token

token_create

Code samples

# You can also use wget
curl -X POST /token/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /token/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "username": "string",
  "password": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/token/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/token/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/token/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/token/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/token/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/token/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /token/

Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.

Body parameter

{
  "username": "string",
  "password": "string"
}

username: string
password: string

Parameters

Name	In	Type	Required	Description
body	body	CortTokenObtainPairRequest	true	none

Example responses

200 Response

{
  "username": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	CortTokenObtainPair

token_refresh_create

Code samples

# You can also use wget
curl -X POST /token/refresh/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'

POST /token/refresh/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "refresh": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('/token/refresh/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
}

result = RestClient.post '/token/refresh/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('/token/refresh/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/token/refresh/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/token/refresh/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/token/refresh/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /token/refresh/

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

Body parameter

{
  "refresh": "string"
}

refresh: string

Parameters

Name	In	Type	Required	Description
body	body	TokenRefreshRequest	true	none

Example responses

200 Response

{
  "access": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	TokenRefresh

assets

assets_list

Code samples

# You can also use wget
curl -X GET /assets/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /assets/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/assets/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/assets/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/assets/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/assets/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/assets/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/assets/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /assets/

Asset endpoint

Parameters

Name	In	Type	Required	Description
created_after	query	string(date-time)	false	none
created_before	query	string(date-time)	false	none
kind	query	string	false	none
updated_after	query	string(date-time)	false	none
updated_before	query	string(date-time)	false	none

Enumerated Values

Parameter	Value
kind	lateral
kind	mainline
kind	maintenance-hole
kind	other

Example responses

200 Response

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "name": "string",
    "key": "string",
    "owner": "http://example.com",
    "kind": "mainline",
    "geojson": {
      "property1": null,
      "property2": null
    },
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "created": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	PaginatedAssetListList

assets_create

Code samples

# You can also use wget
curl -X POST /assets/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /assets/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/assets/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/assets/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/assets/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/assets/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/assets/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/assets/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /assets/

Create an Asset

Body parameter

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

name: string
key: string
owner: 534359f7-5407-4b19-ba92-c71c370022a5
kind: mainline
geojson:
  ? property1
  ? property2
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
account: f5b54a51-a98c-44cf-bb68-a676332e7d12
category: string
metric: true
shape: string
host_material: string
renewal_method: string
renewal_year: string
length: 0
height: 0
width: 0
joint_distance: 0
rim_to_invert: 0
rim_to_grade: 0

Parameters

Name	In	Type	Required	Description
body	body	AssetRequest	false	none

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Unspecified response body

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

assets_retrieve

Code samples

# You can also use wget
curl -X GET /assets/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /assets/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/assets/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/assets/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/assets/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/assets/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/assets/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/assets/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /assets/{sid}/

Asset endpoint

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Unspecified response body

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

assets_update

Code samples

# You can also use wget
curl -X PUT /assets/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PUT /assets/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/assets/{sid}/',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.put '/assets/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.put('/assets/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/assets/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/assets/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/assets/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /assets/{sid}/

Asset endpoint

Body parameter

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

name: string
key: string
owner: 534359f7-5407-4b19-ba92-c71c370022a5
kind: mainline
geojson:
  ? property1
  ? property2
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
account: f5b54a51-a98c-44cf-bb68-a676332e7d12
category: string
metric: true
shape: string
host_material: string
renewal_method: string
renewal_year: string
length: 0
height: 0
width: 0
joint_distance: 0
rim_to_invert: 0
rim_to_grade: 0

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	AssetRequest	false	none

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Unspecified response body

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

assets_partial_update

Code samples

# You can also use wget
curl -X PATCH /assets/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PATCH /assets/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/assets/{sid}/',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch '/assets/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('/assets/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/assets/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/assets/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/assets/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /assets/{sid}/

Asset endpoint

Body parameter

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

name: string
key: string
owner: 534359f7-5407-4b19-ba92-c71c370022a5
kind: mainline
geojson:
  ? property1
  ? property2
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
account: f5b54a51-a98c-44cf-bb68-a676332e7d12
category: string
metric: true
shape: string
host_material: string
renewal_method: string
renewal_year: string
length: 0
height: 0
width: 0
joint_distance: 0
rim_to_invert: 0
rim_to_grade: 0

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	PatchedAssetRequest	false	none

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Unspecified response body

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

exports

exports_create

Code samples

# You can also use wget
curl -X POST /exports/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /exports/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/exports/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/exports/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/exports/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/exports/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/exports/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/exports/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /exports/

Body parameter

{
  "name": "string"
}

name: string

Parameters

Name	In	Type	Required	Description
body	body	ExportWriteRequest	false	none

Example responses

201 Response

{
  "name": "string",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378"
}

Responses

Status	Meaning	Description	Schema
201	Created	none	ExportWrite

exports_retrieve

Code samples

# You can also use wget
curl -X GET /exports/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /exports/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/exports/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/exports/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/exports/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/exports/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/exports/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/exports/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /exports/{sid}/

View and download exports

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "name": "string",
  "completed": "string",
  "downloads": "string",
  "output_paths": "string",
  "progress": {
    "property1": null,
    "property2": null
  },
  "total_size": 0
}

Responses

Status	Meaning	Description	Schema
200	OK	none	ExportRead

exports_destroy

Code samples

# You can also use wget
curl -X DELETE /exports/{sid}/ \
  -H 'Authorization: API_KEY'

DELETE /exports/{sid}/ HTTP/1.1


const headers = {
  'Authorization':'API_KEY'
};

fetch('/exports/{sid}/',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete '/exports/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete('/exports/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/exports/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/exports/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/exports/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /exports/{sid}/

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Responses

Status	Meaning	Description	Schema
204	No Content	No response body	None

inspections

inspections_list

Code samples

# You can also use wget
curl -X GET /inspections/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /inspections/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/inspections/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/inspections/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/inspections/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/inspections/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /inspections/

Inspection endpoint

Parameters

Name	In	Type	Required	Description
created_after	query	string(date-time)	false	none
created_before	query	string(date-time)	false	none
inspection_datetime_after	query	string(date-time)	false	none
inspection_datetime_before	query	string(date-time)	false	none
inspection_type	query	string	false	none
key	query	string	false	none
project	query	string	false	The SID or Name of a project
updated_after	query	string(date-time)	false	none
updated_before	query	string(date-time)	false	none

Enumerated Values

Parameter	Value
inspection_type	lacp
inspection_type	lateral
inspection_type	macp
inspection_type	mainline
inspection_type	maintenance-hole
inspection_type	pacp

Example responses

200 Response

[
  {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "url": "http://example.com",
    "key": "string",
    "asset": "http://example.com",
    "owner": "http://example.com",
    "client": "http://example.com",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "autocode_complete": true,
    "autocode_complete_date": "2019-08-24T14:15:22Z",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "projects": [
      {
        "url": "http://example.com",
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "account": "http://example.com",
        "name": "string",
        "description": "string",
        "client": "http://example.com",
        "date_due": "2019-08-24T14:15:22Z",
        "date_started": "2019-08-24T14:15:22Z",
        "date_finished": "2019-08-24T14:15:22Z",
        "active": true,
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z",
        "created_by": "http://example.com",
        "updated_by": "http://example.com",
        "deleted": "2019-08-24T14:15:22Z",
        "deleted_by": "http://example.com"
      }
    ],
    "video": "http://example.com",
    "validate": true,
    "created_by": "http://example.com",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	PaginatedInspectionListList

inspections_create

Code samples

# You can also use wget
curl -X POST /inspections/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /inspections/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/inspections/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/inspections/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/inspections/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/inspections/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /inspections/

Create an Inspection

Body parameter

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

key: string
asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
owner: 534359f7-5407-4b19-ba92-c71c370022a5
client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
reason: operations-support
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
inspection_datetime: 2019-08-24T14:15:22Z
inspection_type: mainline
distance:
  ? property1
  ? property2
metadata:
  ? property1
  ? property2
projects:
  - 497f6eca-6276-4993-bfeb-53cbbbba6f08
validate: true
account: f5b54a51-a98c-44cf-bb68-a676332e7d12
year_built: string
pipe_category: string
shape: string
direction: string
renewal_method: string
renewal_year: string
notes: string
result: string
location_type: string
purchase_order: string
work_order: string
weather: string
temperature: string
captured_by: string
certification: string
reviewed_by: string
capture_method: string
height: 0
joint_distance: 0
length_inspected: 0
length: 0
width: 0
metric: true
pre_cleaning: string
pre_cleaning_date: string
flow_condition: string
begin_rim_to_invert: 0
begin_rim_to_grade: 0
end_rim_to_invert: 0
end_rim_to_grade: 0
begin_access_point: string
end_access_point: string

Parameters

Name	In	Type	Required	Description
body	body	InspectionRequest	false	none

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Unspecified response body

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

inspections_observations_list

Code samples

# You can also use wget
curl -X GET /inspections/{inspection_sid}/observations/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /inspections/{inspection_sid}/observations/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/{inspection_sid}/observations/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/inspections/{inspection_sid}/observations/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/inspections/{inspection_sid}/observations/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/inspections/{inspection_sid}/observations/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/{inspection_sid}/observations/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/inspections/{inspection_sid}/observations/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /inspections/{inspection_sid}/observations/

Observations endpoint

Parameters

Name	In	Type	Required	Description
created_after	query	string(date-time)	false	none
created_before	query	string(date-time)	false	none
inspection_created_after	query	string(date-time)	false	none
inspection_created_before	query	string(date-time)	false	none
inspection_datetime_after	query	string(date-time)	false	none
inspection_datetime_before	query	string(date-time)	false	none
inspection_sid	path	string	true	none
inspection_updated_after	query	string(date-time)	false	none
inspection_updated_before	query	string(date-time)	false	none
project	query	string	false	The SID or Name of a project
updated_after	query	string(date-time)	false	none
updated_before	query	string(date-time)	false	none

Example responses

200 Response

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "video_frame": -2147483648,
    "Distance": 0,
    "code": "string",
    "description": "string",
    "Continuous": "string",
    "Joint": true,
    "Clock_At_From": 0,
    "Clock_To": 0,
    "Value_1st_Dimension": 0,
    "Value_2nd_Dimension": 0,
    "Value_Percent": 0,
    "Grade": "string",
    "Remarks": "string",
    "snapshot_url": "string",
    "bounding_boxes": "string",
    "created": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	PaginatedObservationReadList

inspections_observations_create

Code samples

# You can also use wget
curl -X POST /inspections/{inspection_sid}/observations/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /inspections/{inspection_sid}/observations/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "video_frame": -2147483648,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/{inspection_sid}/observations/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/inspections/{inspection_sid}/observations/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/inspections/{inspection_sid}/observations/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/inspections/{inspection_sid}/observations/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/{inspection_sid}/observations/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/inspections/{inspection_sid}/observations/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /inspections/{inspection_sid}/observations/

Observations endpoint

Body parameter

{
  "video_frame": -2147483648,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

video_frame: -2147483648
account: f5b54a51-a98c-44cf-bb68-a676332e7d12

Parameters

Name	In	Type	Required	Description
inspection_sid	path	string	true	none
body	body	ObservationWriteRequest	false	none

Example responses

201 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_frame": -2147483648,
  "Distance": 0,
  "code": "string",
  "description": "string",
  "Continuous": "string",
  "Joint": true,
  "Clock_At_From": 0,
  "Clock_To": 0,
  "Value_1st_Dimension": 0,
  "Value_2nd_Dimension": 0,
  "Value_Percent": 0,
  "Remarks": "string",
  "snapshot_url": "string",
  "bounding_boxes": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

Responses

Status	Meaning	Description	Schema
201	Created	none	ObservationWrite

inspections_observations_retrieve

Code samples

# You can also use wget
curl -X GET /inspections/{inspection_sid}/observations/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /inspections/{inspection_sid}/observations/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/{inspection_sid}/observations/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/inspections/{inspection_sid}/observations/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/inspections/{inspection_sid}/observations/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/inspections/{inspection_sid}/observations/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/{inspection_sid}/observations/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/inspections/{inspection_sid}/observations/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /inspections/{inspection_sid}/observations/{sid}/

Observations endpoint

Parameters

Name	In	Type	Required	Description
inspection_sid	path	string	true	none
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_frame": -2147483648,
  "Distance": 0,
  "code": "string",
  "description": "string",
  "Continuous": "string",
  "Joint": true,
  "Clock_At_From": 0,
  "Clock_To": 0,
  "Value_1st_Dimension": 0,
  "Value_2nd_Dimension": 0,
  "Value_Percent": 0,
  "Grade": "string",
  "Remarks": "string",
  "snapshot_url": "string",
  "bounding_boxes": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	ObservationRead

inspections_retrieve

Code samples

# You can also use wget
curl -X GET /inspections/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /inspections/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/inspections/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/inspections/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/inspections/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/inspections/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /inspections/{sid}/

Inspection endpoint

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Unspecified response body

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

inspections_update

Code samples

# You can also use wget
curl -X PUT /inspections/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PUT /inspections/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/{sid}/',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.put '/inspections/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.put('/inspections/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/inspections/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/inspections/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /inspections/{sid}/

Inspection endpoint

Body parameter

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

key: string
asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
owner: 534359f7-5407-4b19-ba92-c71c370022a5
client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
reason: operations-support
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
inspection_datetime: 2019-08-24T14:15:22Z
inspection_type: mainline
distance:
  ? property1
  ? property2
metadata:
  ? property1
  ? property2
projects:
  - 497f6eca-6276-4993-bfeb-53cbbbba6f08
validate: true
account: f5b54a51-a98c-44cf-bb68-a676332e7d12
year_built: string
pipe_category: string
shape: string
direction: string
renewal_method: string
renewal_year: string
notes: string
result: string
location_type: string
purchase_order: string
work_order: string
weather: string
temperature: string
captured_by: string
certification: string
reviewed_by: string
capture_method: string
height: 0
joint_distance: 0
length_inspected: 0
length: 0
width: 0
metric: true
pre_cleaning: string
pre_cleaning_date: string
flow_condition: string
begin_rim_to_invert: 0
begin_rim_to_grade: 0
end_rim_to_invert: 0
end_rim_to_grade: 0
begin_access_point: string
end_access_point: string

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	InspectionRequest	false	none

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Unspecified response body

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

inspections_partial_update

Code samples

# You can also use wget
curl -X PATCH /inspections/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PATCH /inspections/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/{sid}/',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch '/inspections/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('/inspections/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/inspections/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/inspections/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /inspections/{sid}/

Inspection endpoint

Body parameter

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

key: string
asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
owner: 534359f7-5407-4b19-ba92-c71c370022a5
client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
reason: operations-support
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
inspection_datetime: 2019-08-24T14:15:22Z
inspection_type: mainline
distance:
  ? property1
  ? property2
metadata:
  ? property1
  ? property2
projects:
  - 497f6eca-6276-4993-bfeb-53cbbbba6f08
validate: true
account: f5b54a51-a98c-44cf-bb68-a676332e7d12
year_built: string
pipe_category: string
shape: string
direction: string
renewal_method: string
renewal_year: string
notes: string
result: string
location_type: string
purchase_order: string
work_order: string
weather: string
temperature: string
captured_by: string
certification: string
reviewed_by: string
capture_method: string
height: 0
joint_distance: 0
length_inspected: 0
length: 0
width: 0
metric: true
pre_cleaning: string
pre_cleaning_date: string
flow_condition: string
begin_rim_to_invert: 0
begin_rim_to_grade: 0
end_rim_to_invert: 0
end_rim_to_grade: 0
begin_access_point: string
end_access_point: string

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	PatchedInspectionRequest	false	none

Example responses

200 Response

{
  "property1": null,
  "property2": null
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Inline

Response Schema

Status Code 200

Unspecified response body

Name	Type	Required	Restrictions	Description
» additionalProperties	any	false	none	none

inspections_AutoCode_create

Code samples

# You can also use wget
curl -X POST /inspections/AutoCode/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /inspections/AutoCode/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/inspections/AutoCode/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/inspections/AutoCode/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/inspections/AutoCode/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/inspections/AutoCode/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/inspections/AutoCode/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/inspections/AutoCode/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /inspections/AutoCode/

Inspection endpoint

Body parameter

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

key: string
asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
owner: 534359f7-5407-4b19-ba92-c71c370022a5
client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
reason: operations-support
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
inspection_datetime: 2019-08-24T14:15:22Z
inspection_type: mainline
distance:
  ? property1
  ? property2
metadata:
  ? property1
  ? property2
projects:
  - 497f6eca-6276-4993-bfeb-53cbbbba6f08
validate: true
account: f5b54a51-a98c-44cf-bb68-a676332e7d12
year_built: string
pipe_category: string
shape: string
direction: string
renewal_method: string
renewal_year: string
notes: string
result: string
location_type: string
purchase_order: string
work_order: string
weather: string
temperature: string
captured_by: string
certification: string
reviewed_by: string
capture_method: string
height: 0
joint_distance: 0
length_inspected: 0
length: 0
width: 0
metric: true
pre_cleaning: string
pre_cleaning_date: string
flow_condition: string
begin_rim_to_invert: 0
begin_rim_to_grade: 0
end_rim_to_invert: 0
end_rim_to_grade: 0
begin_access_point: string
end_access_point: string

Parameters

Name	In	Type	Required	Description
inspection	query	array[UUID]	false	A list of inspection SIDs
project	query	array[UUID]	false	A list of project SIDs
body	body	MainlineInspectionWriteRequest	true	none

Example responses

200 Response

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "url": "http://example.com",
  "key": "string",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "video": "http://example.com",
  "validate": true,
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	MainlineInspectionWrite

observations

observations_list

Code samples

# You can also use wget
curl -X GET /observations/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /observations/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/observations/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/observations/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/observations/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/observations/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/observations/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/observations/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /observations/

Observations endpoint

Parameters

Name	In	Type	Required	Description
created_after	query	string(date-time)	false	none
created_before	query	string(date-time)	false	none
inspection_created_after	query	string(date-time)	false	none
inspection_created_before	query	string(date-time)	false	none
inspection_datetime_after	query	string(date-time)	false	none
inspection_datetime_before	query	string(date-time)	false	none
inspection_updated_after	query	string(date-time)	false	none
inspection_updated_before	query	string(date-time)	false	none
project	query	string	false	The SID or Name of a project, can be used multiple times.
updated_after	query	string(date-time)	false	none
updated_before	query	string(date-time)	false	none

Example responses

200 Response

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "video_frame": -2147483648,
    "Distance": 0,
    "code": "string",
    "description": "string",
    "Continuous": "string",
    "Joint": true,
    "Clock_At_From": 0,
    "Clock_To": 0,
    "Value_1st_Dimension": 0,
    "Value_2nd_Dimension": 0,
    "Value_Percent": 0,
    "Grade": "string",
    "Remarks": "string",
    "snapshot_url": "string",
    "bounding_boxes": "string",
    "created": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	PaginatedObservationReadList

observations_retrieve

Code samples

# You can also use wget
curl -X GET /observations/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /observations/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/observations/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/observations/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/observations/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/observations/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/observations/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/observations/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /observations/{sid}/

Observations endpoint

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_frame": -2147483648,
  "Distance": 0,
  "code": "string",
  "description": "string",
  "Continuous": "string",
  "Joint": true,
  "Clock_At_From": 0,
  "Clock_To": 0,
  "Value_1st_Dimension": 0,
  "Value_2nd_Dimension": 0,
  "Value_Percent": 0,
  "Grade": "string",
  "Remarks": "string",
  "snapshot_url": "string",
  "bounding_boxes": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	ObservationRead

organizations

organizations_list

Code samples

# You can also use wget
curl -X GET /organizations/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /organizations/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/organizations/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/organizations/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/organizations/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/organizations/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/organizations/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/organizations/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /organizations/

List Organizations

Parameters

Name	In	Type	Required	Description
created_after	query	string(date-time)	false	none
created_before	query	string(date-time)	false	none
updated_after	query	string(date-time)	false	none
updated_before	query	string(date-time)	false	none

Example responses

200 Response

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "name": "string",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "phone_number": "string",
    "account": "http://example.com",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	PaginatedOrganizationReadList

organizations_create

Code samples

# You can also use wget
curl -X POST /organizations/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /organizations/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/organizations/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/organizations/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/organizations/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/organizations/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/organizations/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/organizations/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /organizations/

Organization endpoint

Body parameter

{
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

name: string
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
phone_number: string
account: f5b54a51-a98c-44cf-bb68-a676332e7d12

Parameters

Name	In	Type	Required	Description
body	body	OrganizationWriteRequest	true	none

Example responses

201 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "http://example.com",
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
201	Created	none	OrganizationRead

organizations_retrieve

Code samples

# You can also use wget
curl -X GET /organizations/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /organizations/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/organizations/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/organizations/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/organizations/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/organizations/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/organizations/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/organizations/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /organizations/{sid}/

Organization endpoint

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "http://example.com",
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	OrganizationRead

organizations_update

Code samples

# You can also use wget
curl -X PUT /organizations/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PUT /organizations/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/organizations/{sid}/',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.put '/organizations/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.put('/organizations/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/organizations/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/organizations/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/organizations/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /organizations/{sid}/

Organization endpoint

Body parameter

{
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

name: string
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
phone_number: string
account: f5b54a51-a98c-44cf-bb68-a676332e7d12

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	OrganizationWriteRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "http://example.com",
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	OrganizationRead

organizations_partial_update

Code samples

# You can also use wget
curl -X PATCH /organizations/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PATCH /organizations/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/organizations/{sid}/',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch '/organizations/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('/organizations/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/organizations/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/organizations/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/organizations/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /organizations/{sid}/

Organization endpoint

Body parameter

{
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

name: string
city: string
city_area: string
country_area: string
country_code: string
postal_code: string
sorting_code: string
street_address: string
phone_number: string
account: f5b54a51-a98c-44cf-bb68-a676332e7d12

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	PatchedOrganizationWriteRequest	false	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "http://example.com",
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	OrganizationRead

projects

projects_list

Code samples

# You can also use wget
curl -X GET /projects/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /projects/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/projects/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/projects/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/projects/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/projects/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/projects/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/projects/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /projects/

Projects endpoint

Parameters

Name	In	Type	Required	Description
created_after	query	string(date-time)	false	none
created_before	query	string(date-time)	false	none
project	query	string	false	The SID or Name of a project
updated_after	query	string(date-time)	false	none
updated_before	query	string(date-time)	false	none

Example responses

200 Response

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "account": "http://example.com",
    "name": "string",
    "description": "string",
    "client": "http://example.com",
    "date_due": "2019-08-24T14:15:22Z",
    "date_started": "2019-08-24T14:15:22Z",
    "date_finished": "2019-08-24T14:15:22Z",
    "active": true,
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	PaginatedProjectReadList

projects_create

Code samples

# You can also use wget
curl -X POST /projects/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /projects/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "name": "string",
  "description": "string",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/projects/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/projects/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/projects/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/projects/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/projects/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/projects/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /projects/

Projects endpoint

Body parameter

{
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "name": "string",
  "description": "string",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true
}

account: f5b54a51-a98c-44cf-bb68-a676332e7d12
name: string
description: string
client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
date_due: 2019-08-24T14:15:22Z
date_started: 2019-08-24T14:15:22Z
date_finished: 2019-08-24T14:15:22Z
active: true

Parameters

Name	In	Type	Required	Description
body	body	ProjectWriteRequest	true	none

Example responses

201 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "account": "http://example.com",
  "name": "string",
  "description": "string",
  "client": "http://example.com",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true,
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
201	Created	none	ProjectRead

projects_retrieve

Code samples

# You can also use wget
curl -X GET /projects/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /projects/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/projects/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/projects/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/projects/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/projects/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/projects/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/projects/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /projects/{sid}/

Projects endpoint

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "account": "http://example.com",
  "name": "string",
  "description": "string",
  "client": "http://example.com",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true,
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	ProjectRead

projects_update

Code samples

# You can also use wget
curl -X PUT /projects/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PUT /projects/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "name": "string",
  "description": "string",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/projects/{sid}/',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.put '/projects/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.put('/projects/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/projects/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/projects/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/projects/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /projects/{sid}/

Projects endpoint

Body parameter

{
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "name": "string",
  "description": "string",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true
}

account: f5b54a51-a98c-44cf-bb68-a676332e7d12
name: string
description: string
client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
date_due: 2019-08-24T14:15:22Z
date_started: 2019-08-24T14:15:22Z
date_finished: 2019-08-24T14:15:22Z
active: true

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	ProjectWriteRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "account": "http://example.com",
  "name": "string",
  "description": "string",
  "client": "http://example.com",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true,
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	ProjectRead

projects_partial_update

Code samples

# You can also use wget
curl -X PATCH /projects/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PATCH /projects/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "name": "string",
  "description": "string",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/projects/{sid}/',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch '/projects/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('/projects/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/projects/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/projects/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/projects/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /projects/{sid}/

Projects endpoint

Body parameter

{
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "name": "string",
  "description": "string",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true
}

account: f5b54a51-a98c-44cf-bb68-a676332e7d12
name: string
description: string
client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
date_due: 2019-08-24T14:15:22Z
date_started: 2019-08-24T14:15:22Z
date_finished: 2019-08-24T14:15:22Z
active: true

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	PatchedProjectWriteRequest	false	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "account": "http://example.com",
  "name": "string",
  "description": "string",
  "client": "http://example.com",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true,
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	ProjectRead

users

users_list

Code samples

# You can also use wget
curl -X GET /users/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /users/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/users/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/users/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/users/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/users/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/users/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/users/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/

Parameters

Name	In	Type	Required	Description
created_after	query	string(date-time)	false	none
created_before	query	string(date-time)	false	none
updated_after	query	string(date-time)	false	none
updated_before	query	string(date-time)	false	none

Example responses

200 Response

[
  {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "url": "http://example.com",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	PaginatedUserListList

users_retrieve

Code samples

# You can also use wget
curl -X GET /users/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /users/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/users/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/users/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/users/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/users/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/users/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/users/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /users/{sid}/

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "url": "http://example.com",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "permission_level": "string",
  "projects": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	UserRead

videos

videos_list

Code samples

# You can also use wget
curl -X GET /videos/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/

Video endpoint

Parameters

Name	In	Type	Required	Description
created_after	query	string(date-time)	false	none
created_before	query	string(date-time)	false	none
inspection_datetime_after	query	string(date-time)	false	none
inspection_datetime_before	query	string(date-time)	false	none
project	query	string	false	The SID or Name of a project
updated_after	query	string(date-time)	false	none
updated_before	query	string(date-time)	false	none

Example responses

200 Response

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "video_name": "string",
    "inspection": "http://example.com",
    "path": "string",
    "stage": "string",
    "presigned_upload_data": {
      "property1": null,
      "property2": null
    },
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	none	PaginatedVideoReadList

videos_create

Code samples

# You can also use wget
curl -X POST /videos/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": "382346be-f083-4b69-b8d0-1c54192c69c9",
  "payouts": "string",
  "path": "string",
  "stage": 0,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/

Video endpoint

Body parameter

{
  "inspection": "382346be-f083-4b69-b8d0-1c54192c69c9",
  "payouts": "string",
  "path": "string",
  "stage": 0,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

inspection: 382346be-f083-4b69-b8d0-1c54192c69c9
payouts: string
path: string
stage: 0
account: f5b54a51-a98c-44cf-bb68-a676332e7d12

Parameters

Name	In	Type	Required	Description
body	body	VideoWriteRequest	true	none

Example responses

201 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_name": "string",
  "inspection": "http://example.com",
  "path": "string",
  "stage": "string",
  "presigned_upload_data": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
201	Created	none	VideoRead

videos_retrieve

Code samples

# You can also use wget
curl -X GET /videos/{sid}/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/{sid}/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/{sid}/

Video endpoint

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_name": "string",
  "inspection": "http://example.com",
  "path": "string",
  "stage": "string",
  "presigned_upload_data": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	VideoRead

videos_update

Code samples

# You can also use wget
curl -X PUT /videos/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PUT /videos/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": "382346be-f083-4b69-b8d0-1c54192c69c9",
  "payouts": "string",
  "path": "string",
  "stage": 0,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.put '/videos/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.put('/videos/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PUT','/videos/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/videos/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PUT /videos/{sid}/

Video endpoint

Body parameter

{
  "inspection": "382346be-f083-4b69-b8d0-1c54192c69c9",
  "payouts": "string",
  "path": "string",
  "stage": 0,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

inspection: 382346be-f083-4b69-b8d0-1c54192c69c9
payouts: string
path: string
stage: 0
account: f5b54a51-a98c-44cf-bb68-a676332e7d12

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	VideoWriteRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_name": "string",
  "inspection": "http://example.com",
  "path": "string",
  "stage": "string",
  "presigned_upload_data": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	VideoRead

videos_partial_update

Code samples

# You can also use wget
curl -X PATCH /videos/{sid}/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PATCH /videos/{sid}/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": "382346be-f083-4b69-b8d0-1c54192c69c9",
  "payouts": "string",
  "path": "string",
  "stage": 0,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch '/videos/{sid}/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('/videos/{sid}/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/videos/{sid}/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/videos/{sid}/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /videos/{sid}/

Video endpoint

Body parameter

{
  "inspection": "382346be-f083-4b69-b8d0-1c54192c69c9",
  "payouts": "string",
  "path": "string",
  "stage": 0,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

inspection: 382346be-f083-4b69-b8d0-1c54192c69c9
payouts: string
path: string
stage: 0
account: f5b54a51-a98c-44cf-bb68-a676332e7d12

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	PatchedVideoWriteRequest	false	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_name": "string",
  "inspection": "http://example.com",
  "path": "string",
  "stage": "string",
  "presigned_upload_data": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	VideoRead

videos_change_inspection_create

Code samples

# You can also use wget
curl -X POST /videos/{sid}/change-inspection/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/{sid}/change-inspection/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/change-inspection/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/{sid}/change-inspection/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/{sid}/change-inspection/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/{sid}/change-inspection/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/change-inspection/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/{sid}/change-inspection/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/{sid}/change-inspection/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_url_retrieve

Code samples

# You can also use wget
curl -X GET /videos/{sid}/url/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/{sid}/url/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/url/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/{sid}/url/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/{sid}/url/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/{sid}/url/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/url/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/{sid}/url/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/{sid}/url/

Video endpoint

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

"https://content.sewerai.com/training/video/..."

Responses

Status	Meaning	Description	Schema
200	OK	none	string

videos_GetMetashapeFiles_retrieve

Code samples

# You can also use wget
curl -X GET /videos/{sid}/GetMetashapeFiles/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/{sid}/GetMetashapeFiles/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/GetMetashapeFiles/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/{sid}/GetMetashapeFiles/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/{sid}/GetMetashapeFiles/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/{sid}/GetMetashapeFiles/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/GetMetashapeFiles/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/{sid}/GetMetashapeFiles/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/{sid}/GetMetashapeFiles/

API endpoint that allows Video Instance data to viewed or edited.

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_ToggleLabelerReviewed_partial_update

Code samples

# You can also use wget
curl -X PATCH /videos/{sid}/ToggleLabelerReviewed/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

PATCH /videos/{sid}/ToggleLabelerReviewed/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/ToggleLabelerReviewed/',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.patch '/videos/{sid}/ToggleLabelerReviewed/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.patch('/videos/{sid}/ToggleLabelerReviewed/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','/videos/{sid}/ToggleLabelerReviewed/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/ToggleLabelerReviewed/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/videos/{sid}/ToggleLabelerReviewed/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

PATCH /videos/{sid}/ToggleLabelerReviewed/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	PatchedVideoRequest	false	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_pdf_retrieve

Code samples

# You can also use wget
curl -X GET /videos/{sid}/pdf/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/{sid}/pdf/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/pdf/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/{sid}/pdf/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/{sid}/pdf/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/{sid}/pdf/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/pdf/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/{sid}/pdf/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/{sid}/pdf/

API endpoint that allows Video Instance data to viewed or edited.

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_test_360_frames_create

Code samples

# You can also use wget
curl -X POST /videos/{sid}/test_360_frames/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/{sid}/test_360_frames/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/test_360_frames/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/{sid}/test_360_frames/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/{sid}/test_360_frames/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/{sid}/test_360_frames/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/test_360_frames/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/{sid}/test_360_frames/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/{sid}/test_360_frames/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_update_file_create

Code samples

# You can also use wget
curl -X POST /videos/{sid}/update-file/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/{sid}/update-file/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/{sid}/update-file/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/{sid}/update-file/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/{sid}/update-file/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/{sid}/update-file/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/{sid}/update-file/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/{sid}/update-file/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/{sid}/update-file/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
sid	path	string(uuid)	true	none
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_AddRemoveProject_create

Code samples

# You can also use wget
curl -X POST /videos/AddRemoveProject/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/AddRemoveProject/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/AddRemoveProject/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/AddRemoveProject/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/AddRemoveProject/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/AddRemoveProject/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/AddRemoveProject/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/AddRemoveProject/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/AddRemoveProject/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_AddRemoveProject_destroy

Code samples

# You can also use wget
curl -X DELETE /videos/AddRemoveProject/ \
  -H 'Authorization: API_KEY'

DELETE /videos/AddRemoveProject/ HTTP/1.1


const headers = {
  'Authorization':'API_KEY'
};

fetch('/videos/AddRemoveProject/',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Authorization' => 'API_KEY'
}

result = RestClient.delete '/videos/AddRemoveProject/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Authorization': 'API_KEY'
}

r = requests.delete('/videos/AddRemoveProject/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('DELETE','/videos/AddRemoveProject/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/AddRemoveProject/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("DELETE");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("DELETE", "/videos/AddRemoveProject/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

DELETE /videos/AddRemoveProject/

API endpoint that allows Video Instance data to viewed or edited.

Responses

Status	Meaning	Description	Schema
204	No Content	No response body	None

videos_BulkArchive_create

Code samples

# You can also use wget
curl -X POST /videos/BulkArchive/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/BulkArchive/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/BulkArchive/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/BulkArchive/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/BulkArchive/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/BulkArchive/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/BulkArchive/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/BulkArchive/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/BulkArchive/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_BulkMarkReviewed_create

Code samples

# You can also use wget
curl -X POST /videos/BulkMarkReviewed/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/BulkMarkReviewed/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/BulkMarkReviewed/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/BulkMarkReviewed/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/BulkMarkReviewed/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/BulkMarkReviewed/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/BulkMarkReviewed/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/BulkMarkReviewed/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/BulkMarkReviewed/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_GetBBReview_retrieve

Code samples

# You can also use wget
curl -X GET /videos/GetBBReview/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/GetBBReview/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/GetBBReview/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/GetBBReview/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/GetBBReview/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/GetBBReview/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/GetBBReview/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/GetBBReview/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/GetBBReview/

API endpoint that allows Video Instance data to viewed or edited.

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_PipeStatistics_retrieve

Code samples

# You can also use wget
curl -X GET /videos/PipeStatistics/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/PipeStatistics/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/PipeStatistics/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/PipeStatistics/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/PipeStatistics/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/PipeStatistics/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/PipeStatistics/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/PipeStatistics/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/PipeStatistics/

API endpoint that allows Video Instance data to viewed or edited.

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_SubmitBBReview_create

Code samples

# You can also use wget
curl -X POST /videos/SubmitBBReview/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/SubmitBBReview/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/SubmitBBReview/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/SubmitBBReview/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/SubmitBBReview/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/SubmitBBReview/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/SubmitBBReview/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/SubmitBBReview/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/SubmitBBReview/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_ValidationReport_retrieve

Code samples

# You can also use wget
curl -X GET /videos/ValidationReport/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/ValidationReport/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/ValidationReport/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/ValidationReport/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/ValidationReport/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/ValidationReport/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/ValidationReport/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/ValidationReport/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/ValidationReport/

API endpoint that allows Video Instance data to viewed or edited.

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_ValidationReport_create

Code samples

# You can also use wget
curl -X POST /videos/ValidationReport/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/ValidationReport/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/ValidationReport/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/ValidationReport/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/ValidationReport/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/ValidationReport/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/ValidationReport/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/ValidationReport/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/ValidationReport/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_get_taggable_users_retrieve

Code samples

# You can also use wget
curl -X GET /videos/get_taggable_users/ \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

GET /videos/get_taggable_users/ HTTP/1.1

Accept: application/json


const headers = {
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/get_taggable_users/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.get '/videos/get_taggable_users/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.get('/videos/get_taggable_users/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','/videos/get_taggable_users/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/get_taggable_users/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/videos/get_taggable_users/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

GET /videos/get_taggable_users/

API endpoint that allows Video Instance data to viewed or edited.

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

videos_kickoff_submittal_create

Code samples

# You can also use wget
curl -X POST /videos/kickoff_submittal/ \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json' \
  -H 'Authorization: API_KEY'

POST /videos/kickoff_submittal/ HTTP/1.1

Content-Type: application/json
Accept: application/json

const inputBody = '{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json',
  'Authorization':'API_KEY'
};

fetch('/videos/kickoff_submittal/',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/json',
  'Accept' => 'application/json',
  'Authorization' => 'API_KEY'
}

result = RestClient.post '/videos/kickoff_submittal/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'Authorization': 'API_KEY'
}

r = requests.post('/videos/kickoff_submittal/', headers = headers)

print(r.json())

<?php

require 'vendor/autoload.php';

$headers = array(
    'Content-Type' => 'application/json',
    'Accept' => 'application/json',
    'Authorization' => 'API_KEY',
);

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','/videos/kickoff_submittal/', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

URL obj = new URL("/videos/kickoff_submittal/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"API_KEY"},
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/videos/kickoff_submittal/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

POST /videos/kickoff_submittal/

API endpoint that allows Video Instance data to viewed or edited.

Body parameter

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

inspection:
  key: string
  asset: 5a841cf2-3786-47ad-8831-36ccea9ed096
  owner: 534359f7-5407-4b19-ba92-c71c370022a5
  client: 95b7f642-4812-4c19-ba03-689f2fdf42f8
  reason: operations-support
  city: string
  city_area: string
  country_area: string
  country_code: string
  postal_code: string
  sorting_code: string
  street_address: string
  inspection_datetime: 2019-08-24T14:15:22Z
  inspection_type: mainline
  distance:
    ? property1
    ? property2
  metadata:
    ? property1
    ? property2
  projects:
    - 497f6eca-6276-4993-bfeb-53cbbbba6f08
  validate: true
  account: f5b54a51-a98c-44cf-bb68-a676332e7d12
  year_built: string
  pipe_category: string
  shape: string
  direction: string
  renewal_method: string
  renewal_year: string
  notes: string
  result: string
  location_type: string
  purchase_order: string
  work_order: string
  weather: string
  temperature: string
  captured_by: string
  certification: string
  reviewed_by: string
  capture_method: string
  height: 0
  joint_distance: 0
  length_inspected: 0
  length: 0
  width: 0
  metric: true
  pre_cleaning: string
  pre_cleaning_date: string
  flow_condition: string
  begin_rim_to_invert: 0
  begin_rim_to_grade: 0
  end_rim_to_invert: 0
  end_rim_to_grade: 0
  begin_access_point: string
  end_access_point: string
variant: 0
encoding_location: string
encoding_location_exists: true
encoded: true
video_format: 0
zero_distance_mark: 0
number_of_frames: -2147483648
is_selectable: true
pipe: 0
camera: 0
video_width: -2147483648
video_height: -2147483648
video_duration: 0
model_scale_factor: 0
default_position_coords:
  ? property1
  ? property2
contractor: string
created_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
updated_by:
  first_name: string
  last_name: string
  email: user@example.com
  last_pioneer_login: 2019-08-24T14:15:22Z
auxillary_videos:
  ? property1
  ? property2

Parameters

Name	In	Type	Required	Description
body	body	VideoRequest	true	none

Example responses

200 Response

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Responses

Status	Meaning	Description	Schema
200	OK	none	Video

Schemas

AccountUser

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "last_pioneer_login": "2019-08-24T14:15:22Z",
  "permission_level": "string",
  "projects": "string"
}

AccountUser serializer

Properties

Name	Type	Required	Restrictions	Description
sid	string(uuid)	true	read-only	none
first_name	string	false	none	none
last_name	string	false	none	none
email	string(email)	true	none	none
last_pioneer_login	string(date-time)¦null	false	none	none
permission_level	string	true	read-only	none
projects	string	true	read-only	none

AccountUserRequest

{
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "last_pioneer_login": "2019-08-24T14:15:22Z"
}

AccountUserRequest serializer

Properties

Name	Type	Required	Restrictions	Description
first_name	string	false	none	none
last_name	string	false	none	none
email	string(email)	true	none	none
last_pioneer_login	string(date-time)¦null	false	none	none

AssetList

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "name": "string",
  "key": "string",
  "owner": "http://example.com",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

AssetList serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
name	string	true	none	none
key	string¦null	false	none	none
owner	string(uri)	true	read-only	none
kind	string	true	none	none
geojson	object	false	none	none
» additionalProperties	any	false	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
created	string(date-time)	true	read-only	none
created_by	string(uri)	true	read-only	none
updated	string(date-time)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none
account	string(uri)	true	read-only	none

Enumerated Values

Property	Value
kind	mainline
kind	lateral
kind	maintenance-hole

AssetRequest

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	MainlineAssetWriteRequest	false	none	MainlineAssetWriteRequest serializer

xor

Name	Type	Required	Restrictions	Description
anonymous	LateralAssetWriteRequest	false	none	LateralAssetWriteRequest serializer

CortTokenObtainPair

{
  "username": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	true	none	none

CortTokenObtainPairRequest

{
  "username": "string",
  "password": "string"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	true	none	none
password	string	true	write-only	none

ExportRead

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "name": "string",
  "completed": "string",
  "downloads": "string",
  "output_paths": "string",
  "progress": {
    "property1": null,
    "property2": null
  },
  "total_size": 0
}

ExportRead serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
name	string¦null	false	none	none
completed	string	true	read-only	none
downloads	string	true	read-only	none
output_paths	string	true	read-only	none
progress	object	false	none	none
» additionalProperties	any	false	none	none
total_size	number(double)	false	none	none

ExportWrite

{
  "name": "string",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378"
}

ExportWrite serializer

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none
sid	string(uuid)	true	read-only	none

ExportWriteRequest

{
  "name": "string"
}

ExportWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
name	string¦null	false	none	none

File

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "account": "http://example.com",
  "origin_path": "string",
  "name": "string",
  "kind": 0,
  "location": "string",
  "size": "string",
  "exists": "string",
  "upload_location": "string",
  "meta": {
    "property1": null,
    "property2": null
  }
}

File serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
account	string(uri)	true	read-only	none
origin_path	string	true	none	none
name	string	true	read-only	none
kind	integer	false	none	none
location	string¦null	false	none	none
size	string	true	read-only	none
exists	string	true	read-only	none
upload_location	string	true	read-only	none
meta	object	true	none	none
» additionalProperties	any	false	none	none

Enumerated Values

Property	Value
kind	0
kind	1
kind	2
kind	3
kind	4
kind	5
kind	6
kind	7
kind	8
kind	99

Inspection

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "Inspection_Date": "string",
  "Inspection_Time": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "Street": "string",
  "City": "string",
  "City_Area": "string",
  "Country_Area": "string",
  "Country_Code": "string",
  "Postal_Code": "string",
  "Sorting_Code": "string",
  "validate": true,
  "geojson": {
    "property1": null,
    "property2": null
  },
  "partner_links": [
    {
      "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
      "partner": "unearth",
      "link": "http://example.com",
      "icon_url": "string",
      "meta": {
        "property1": null,
        "property2": null
      }
    }
  ],
  "created": "2019-08-24T14:15:22Z",
  "created_by": 0,
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": 0
}

Inspection serializer

Properties

Name	Type	Required	Restrictions	Description
sid	string(uuid)	true	read-only	none
Inspection_Date	string¦null	false	none	none
Inspection_Time	string¦null	false	none	none
inspection_datetime	string(date-time)	true	read-only	none
Street	string	false	none	none
City	string	false	none	none
City_Area	string	false	none	none
Country_Area	string	false	none	none
Country_Code	string	false	none	none
Postal_Code	string	false	none	none
Sorting_Code	string	false	none	none
validate	boolean	false	none	Should this inspection be validated (default: True)
geojson	object	true	read-only	none
» additionalProperties	any	false	none	none
partner_links	[PartnerLink]	true	read-only	none
created	string(date-time)	true	read-only	none
created_by	integer	true	read-only	none
updated	string(date-time)	true	read-only	none
updated_by	integer	true	read-only	none

InspectionList

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "url": "http://example.com",
  "key": "string",
  "asset": "http://example.com",
  "owner": "http://example.com",
  "client": "http://example.com",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "autocode_complete": true,
  "autocode_complete_date": "2019-08-24T14:15:22Z",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "projects": [
    {
      "url": "http://example.com",
      "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
      "account": "http://example.com",
      "name": "string",
      "description": "string",
      "client": "http://example.com",
      "date_due": "2019-08-24T14:15:22Z",
      "date_started": "2019-08-24T14:15:22Z",
      "date_finished": "2019-08-24T14:15:22Z",
      "active": true,
      "created": "2019-08-24T14:15:22Z",
      "updated": "2019-08-24T14:15:22Z",
      "created_by": "http://example.com",
      "updated_by": "http://example.com",
      "deleted": "2019-08-24T14:15:22Z",
      "deleted_by": "http://example.com"
    }
  ],
  "video": "http://example.com",
  "validate": true,
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

InspectionList serializer

Properties

Name	Type	Required	Restrictions	Description
sid	string(uuid)	true	read-only	none
url	string(uri)	true	read-only	none
key	string	true	none	none
asset	string(uri)	true	read-only	none
owner	string(uri)	true	read-only	none
client	string(uri)	true	read-only	none
reason	string	false	none	none
city	string	false	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
inspection_datetime	string(date-time)	true	none	none
inspection_type	string	true	none	none
autocode_complete	boolean	false	none	none
autocode_complete_date	string(date-time)¦null	true	read-only	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
created	string(date-time)	true	read-only	none
updated	string(date-time)	true	read-only	none
projects	[ProjectRead]	true	none	[ProjectRead serializer]
video	string(uri)	true	read-only	none
validate	boolean	false	none	Should this inspection be validated (default: True)
created_by	string(uri)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none
account	string(uri)	true	read-only	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other
inspection_type	mainline
inspection_type	lateral
inspection_type	maintenance-hole

InspectionRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	MainlineInspectionWriteRequest	false	none	MainlineInspectionSerializer

xor

Name	Type	Required	Restrictions	Description
anonymous	LateralInspectionWriteRequest	false	none	LateralInspectionSerializer

xor

Name	Type	Required	Restrictions	Description
anonymous	MaintenanceHoleInspectionWriteRequest	false	none	MaintenanceHoleInspectionWriteRequest serializer

xor

Name	Type	Required	Restrictions	Description
anonymous	PACPInspectionWriteRequest	false	none	PACPInspectionSerializer

xor

Name	Type	Required	Restrictions	Description
anonymous	LACPInspectionWriteRequest	false	none	LACPInspectionSerializer

xor

Name	Type	Required	Restrictions	Description
anonymous	MACPInspectionWriteRequest	false	none	MACPInspectionSerializer

LACPInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "City": "string",
  "Street": "string",
  "inspection_type": "lacp",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "Inspection_Date": "string",
  "Inspection_Time": "string",
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "InspectionID": "string",
  "Surveyed_By": "string",
  "Certificate_Number": "string",
  "Reviewed_By": "string",
  "Reviewer_Certificate_Number": "string",
  "Owner": "string",
  "Customer": "string",
  "PO_Number": "string",
  "WorkOrder": "string",
  "Media_Label": "string",
  "Project": "string",
  "Weather": "string",
  "PreCleaning": "string",
  "Date_Cleaned": "string",
  "Purpose": "string",
  "Consequence_Of_Failure": "string",
  "Drainage_Area": "string",
  "Location_Code": "string",
  "Location_Details": "string",
  "Vertical_Datum": "string",
  "GPS_Accuracy": "string",
  "Additional_Info": "string",
  "Year_Constructed": "string",
  "Year_Renewed": "string",
  "Sheet_Number": 0,
  "IsImperial": true,
  "Custom_Fields": {
    "property1": null,
    "property2": null
  },
  "Custom_Labels": {
    "property1": null,
    "property2": null
  },
  "Inspection_Status": "string",
  "Pipe_Use": "string",
  "Material": "string",
  "Direction": "string",
  "Downstream_MH": "string",
  "Inspection_Technology_Used_CCTV": "string",
  "Inspection_Technology_Used_Laser": "string",
  "Inspection_Technology_Used_Other": "string",
  "Inspection_Technology_Used_Sidewall": "string",
  "Inspection_Technology_Used_Sonar": "string",
  "Inspection_Technology_Used_Zoom": "string",
  "Lining_Method": "string",
  "Pipe_Segment_Reference": "string",
  "Pressure_Value": "string",
  "Upstream_MH": "string",
  "PACPInspectionID": "string",
  "Lateral_Segment_Reference": "string",
  "Access_Point": "string",
  "Access_Point_Northing": "string",
  "Access_Point_Easting": "string",
  "Access_Point_Elevation": "string",
  "Coordinate_System": "string",
  "StartManhole": "string",
  "Size": 0,
  "Property_Line": 0,
  "Tap_Location": 0,
  "Rim_Invert": 0,
  "Length_Surveyed": 0,
  "Total_Length": 0,
  "Reverse_Setup": 0
}

LACPInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	none
asset	string(uuid)¦null	true	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
City	string	true	none	none
Street	string¦null	true	none	none
inspection_type	string	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
Inspection_Date	string¦null	false	none	none
Inspection_Time	string¦null	false	none	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
InspectionID	string¦null	false	none	none
Surveyed_By	string¦null	false	none	none
Certificate_Number	string¦null	false	none	none
Reviewed_By	string¦null	false	none	none
Reviewer_Certificate_Number	string¦null	false	none	none
Owner	string¦null	false	none	none
Customer	string¦null	false	none	none
PO_Number	string¦null	false	none	none
WorkOrder	string¦null	false	none	none
Media_Label	string¦null	false	none	none
Project	string¦null	false	none	none
Weather	string¦null	false	none	none
PreCleaning	string¦null	false	none	none
Date_Cleaned	string¦null	false	none	none
Purpose	string¦null	false	none	none
Consequence_Of_Failure	string¦null	false	none	none
Drainage_Area	string¦null	false	none	none
Location_Code	string¦null	false	none	none
Location_Details	string¦null	false	none	none
Vertical_Datum	string¦null	false	none	none
GPS_Accuracy	string¦null	false	none	none
Additional_Info	string¦null	false	none	none
Year_Constructed	string¦null	false	none	none
Year_Renewed	string¦null	false	none	none
Sheet_Number	integer¦null	false	none	none
IsImperial	boolean¦null	false	none	none
Custom_Fields	object¦null	false	none	none
» additionalProperties	any	false	none	none
Custom_Labels	object¦null	false	none	none
» additionalProperties	any	false	none	none
Inspection_Status	string¦null	false	none	none
Pipe_Use	string¦null	false	none	none
Material	string¦null	false	none	none
Direction	string¦null	false	none	none
Downstream_MH	string¦null	false	none	none
Inspection_Technology_Used_CCTV	string¦null	false	none	none
Inspection_Technology_Used_Laser	string¦null	false	none	none
Inspection_Technology_Used_Other	string¦null	false	none	none
Inspection_Technology_Used_Sidewall	string¦null	false	none	none
Inspection_Technology_Used_Sonar	string¦null	false	none	none
Inspection_Technology_Used_Zoom	string¦null	false	none	none
Lining_Method	string¦null	false	none	none
Pipe_Segment_Reference	string¦null	false	none	none
Pressure_Value	string¦null	false	none	none
Upstream_MH	string¦null	false	none	none
PACPInspectionID	string¦null	false	none	none
Lateral_Segment_Reference	string¦null	false	none	none
Access_Point	string¦null	false	none	none
Access_Point_Northing	string¦null	false	none	none
Access_Point_Easting	string¦null	false	none	none
Access_Point_Elevation	string¦null	false	none	none
Coordinate_System	string¦null	false	none	none
StartManhole	string¦null	false	none	none
Size	number(double)¦null	false	none	none
Property_Line	number(double)¦null	false	none	none
Tap_Location	number(double)¦null	false	none	none
Rim_Invert	number(double)¦null	false	none	none
Length_Surveyed	number(double)¦null	false	none	none
Total_Length	number(double)¦null	false	none	none
Reverse_Setup	number(double)¦null	false	none	none

LateralAssetWriteRequest

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "lateral",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "tap_distance": 0
}

LateralAssetWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
key	string¦null	false	none	none
owner	string(uuid)¦null	false	write-only	none
kind	string	false	none	none
geojson	object	false	none	none
» additionalProperties	any	false	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
account	string(uuid)	false	none	none
category	string¦null	false	none	none
metric	boolean¦null	false	none	none
shape	string¦null	false	none	none
host_material	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
length	number(double)¦null	false	none	none
height	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
tap_distance	number(double)¦null	false	none	none

LateralInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "lateral",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "lateral_access_point": "string",
  "property_distance": 0,
  "tap_distance": 0,
  "rim_to_invert": 0,
  "access_point": "string"
}

LateralInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	none
asset	string(uuid)¦null	true	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
reason	string	false	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
inspection_datetime	string(date-time)	true	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
year_built	string¦null	false	none	none
pipe_category	string¦null	false	none	none
shape	string¦null	false	none	none
direction	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
notes	string¦null	false	none	none
result	string¦null	false	none	none
location_type	string¦null	false	none	none
purchase_order	string¦null	false	none	none
work_order	string¦null	false	none	none
weather	string¦null	false	none	none
temperature	string¦null	false	none	none
captured_by	string¦null	false	none	none
certification	string¦null	false	none	none
reviewed_by	string¦null	false	none	none
capture_method	string¦null	false	none	none
height	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
length_inspected	number(double)¦null	false	none	none
length	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
metric	boolean¦null	false	none	none
pre_cleaning	string¦null	false	none	none
pre_cleaning_date	string¦null	false	none	none
lateral_access_point	string¦null	false	none	none
property_distance	number(double)¦null	false	none	none
tap_distance	number(double)¦null	false	none	none
rim_to_invert	number(double)¦null	false	none	none
access_point	string¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

MACPInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "City": "string",
  "Street": "string",
  "inspection_type": "macp",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "Inspection_Date": "string",
  "Inspection_Time": "string",
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "pipe_connections": [
    null
  ],
  "InspectionID": "string",
  "Surveyed_By": "string",
  "Certificate_Number": "string",
  "Reviewed_By": "string",
  "Reviewer_Certificate_Number": "string",
  "Owner": "string",
  "Customer": "string",
  "PO_Number": "string",
  "WorkOrder": "string",
  "Media_Label": "string",
  "Project": "string",
  "Weather": "string",
  "PreCleaning": "string",
  "Date_Cleaned": "string",
  "Purpose": "string",
  "Consequence_Of_Failure": "string",
  "Drainage_Area": "string",
  "Location_Code": "string",
  "Location_Details": "string",
  "Vertical_Datum": "string",
  "GPS_Accuracy": "string",
  "Additional_Info": "string",
  "Year_Constructed": 0,
  "Year_Renewed": 0,
  "Sheet_Number": 0,
  "IsImperial": true,
  "Custom_Fields": {
    "property1": null,
    "property2": null
  },
  "Custom_Labels": {
    "property1": null,
    "property2": null
  },
  "InspectionLevel": "string",
  "Inspection_Status": "string",
  "Manhole_Number": "string",
  "Inflow_Potential_from_Runoff": "string",
  "MH_Use": "string",
  "Access_Type": "string",
  "Northing": "string",
  "Easting": "string",
  "Elevation": "string",
  "Coordinate_System": "string",
  "Cover_Shape": "string",
  "Cover_Material": "string",
  "Hole_Diameter": "string",
  "Cover_Frame_Fit": "string",
  "Cover_Insert_Type": "string",
  "Adjustment_Ring_Type": "string",
  "Adjustment_Ring_Material": "string",
  "Frame_Material": "string",
  "Frame_Seal_Inflow": "string",
  "Chimney_Present": "string",
  "Chimney_Material1": "string",
  "Chimney_Material2": "string",
  "Chimney_InI": "string",
  "Chimney_Lining_Interior": "string",
  "Chimney_Lining_Exterior": "string",
  "Chimney_Condition": "string",
  "Cone_Type": "string",
  "Cone_Material": "string",
  "Cone_Lining_Interior": "string",
  "Cone_Lining_Exterior": "string",
  "Cone_Condition": "string",
  "Wall_Material": "string",
  "Wall_Lining_Interior": "string",
  "Wall_Lining_Exterior": "string",
  "Wall_Condition": "string",
  "Bench_Present": "string",
  "Bench_Material": "string",
  "Bench_Lining": "string",
  "Bench_Condition": "string",
  "Channel_Installed": "string",
  "Channel_Material": "string",
  "Channel_Type": "string",
  "Channel_Exposure": "string",
  "Channel_Condition": "string",
  "Step_Material": "string",
  "Evidence_Surcharge": "string",
  "AdditionalComponentInformation": "string",
  "Rim_to_Invert": 0,
  "Rim_to_Grade": 0,
  "Grade_to_Invert": 0,
  "Rim_to_Grade_Exposed": 0,
  "Cover_Size": 0,
  "Center_Cover_Size": 0,
  "Cover_Size_Width": 0,
  "Cover_Bearing_Surface_Dia": 0,
  "Cover_Bearing_Surface_Width": 0,
  "Adjustment_Ring_Height": 0,
  "Frame_Bearing_Surface_Width": 0,
  "Frame_Bearing_Surface_Depth": 0,
  "Frame_Clear_Open_Diam": 0,
  "Frame_Clear_Open_Width": 0,
  "Frame_Offset_Distance": 0,
  "Frame_Depth": 0,
  "Chimney_Clear_Opening": 0,
  "Chimney_Depth": 0,
  "Cone_Depth": 0,
  "Wall_Diam": 0,
  "Wall_BySize": 0,
  "Wall_Depth": 0,
  "Hole_Number": 0,
  "Step_Number": 0,
  "Surface_Type_Asphalt": true,
  "Surface_Type_ConcretePavement": true,
  "Surface_Type_ConcreteCollar": true,
  "Surface_Type_GrassDirt": true,
  "Surface_Type_Gravel": true,
  "Surface_Type_Other": true,
  "Cover_Type_Bolted": true,
  "Cover_Type_Gasketed": true,
  "Cover_Type_Hatch_Double": true,
  "Cover_Type_Hatch_Single": true,
  "Cover_Type_Inner_Cover": true,
  "Cover_Type_Lamphole": true,
  "Cover_Type_Locking": true,
  "Cover_Type_Removable_Center": true,
  "Cover_Type_Solid": true,
  "Cover_Type_Vented": true,
  "Cover_Condition_BoltsMissing": true,
  "Cover_Condition_Broken": true,
  "Cover_Condition_Corroded": true,
  "Cover_Condition_Cracked": true,
  "Cover_Condition_Missing": true,
  "Cover_Condition_Restraint_Defective": true,
  "Cover_Condition_Restraint_Missing": true,
  "Cover_Condition_Sound": true,
  "Insert_Condition_Cracked": true,
  "Insert_Condition_Corroded": true,
  "Insert_Condition_InsertFell": true,
  "Insert_Condition_Leaking": true,
  "Insert_Condition_PoorlyFitting": true,
  "Insert_Condition_Sound": true,
  "Ring_Condition_Broken": true,
  "Ring_Condition_Corroded": true,
  "Ring_Condition_Cracked": true,
  "Ring_Condition_Leaking": true,
  "Ring_Condition_PoorInstall": true,
  "Ring_Condition_Sound": true,
  "Frame_Condition_Broken": true,
  "Frame_Condition_Coated": true,
  "Frame_Condition_Corroded": true,
  "Frame_Condition_Cracked": true,
  "Frame_Condition_Missing": true,
  "Frame_Condition_Sound": true,
  "Seal_Condition_Cracked": true,
  "Seal_Condition_Loose": true,
  "Seal_Condition_Missing": true,
  "Seal_Condition_Offset": true,
  "Seal_Condition_Sound": true
}

MACPInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	none
asset	string(uuid)¦null	true	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
reason	string	false	none	none
City	string	true	none	none
Street	string¦null	true	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
Inspection_Date	string¦null	false	none	none
Inspection_Time	string¦null	false	none	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
pipe_connections	[any]	true	none	none
InspectionID	string¦null	false	none	none
Surveyed_By	string¦null	false	none	none
Certificate_Number	string¦null	false	none	none
Reviewed_By	string¦null	false	none	none
Reviewer_Certificate_Number	string¦null	false	none	none
Owner	string¦null	false	none	none
Customer	string¦null	false	none	none
PO_Number	string¦null	false	none	none
WorkOrder	string¦null	false	none	none
Media_Label	string¦null	false	none	none
Project	string¦null	false	none	none
Weather	string¦null	false	none	none
PreCleaning	string¦null	false	none	none
Date_Cleaned	string¦null	false	none	none
Purpose	string¦null	false	none	none
Consequence_Of_Failure	string¦null	false	none	none
Drainage_Area	string¦null	false	none	none
Location_Code	string¦null	false	none	none
Location_Details	string¦null	false	none	none
Vertical_Datum	string¦null	false	none	none
GPS_Accuracy	string¦null	false	none	none
Additional_Info	string¦null	false	none	none
Year_Constructed	integer¦null	false	none	none
Year_Renewed	integer¦null	false	none	none
Sheet_Number	integer¦null	false	none	none
IsImperial	boolean¦null	false	none	none
Custom_Fields	object¦null	false	none	none
» additionalProperties	any	false	none	none
Custom_Labels	object¦null	false	none	none
» additionalProperties	any	false	none	none
InspectionLevel	string¦null	false	none	none
Inspection_Status	string¦null	false	none	none
Manhole_Number	string¦null	false	none	none
Inflow_Potential_from_Runoff	string¦null	false	none	none
MH_Use	string¦null	false	none	none
Access_Type	string¦null	false	none	none
Northing	string¦null	false	none	none
Easting	string¦null	false	none	none
Elevation	string¦null	false	none	none
Coordinate_System	string¦null	false	none	none
Cover_Shape	string¦null	false	none	none
Cover_Material	string¦null	false	none	none
Hole_Diameter	string¦null	false	none	none
Cover_Frame_Fit	string¦null	false	none	none
Cover_Insert_Type	string¦null	false	none	none
Adjustment_Ring_Type	string¦null	false	none	none
Adjustment_Ring_Material	string¦null	false	none	none
Frame_Material	string¦null	false	none	none
Frame_Seal_Inflow	string¦null	false	none	none
Chimney_Present	string¦null	false	none	none
Chimney_Material1	string¦null	false	none	none
Chimney_Material2	string¦null	false	none	none
Chimney_InI	string¦null	false	none	none
Chimney_Lining_Interior	string¦null	false	none	none
Chimney_Lining_Exterior	string¦null	false	none	none
Chimney_Condition	string¦null	false	none	none
Cone_Type	string¦null	false	none	none
Cone_Material	string¦null	false	none	none
Cone_Lining_Interior	string¦null	false	none	none
Cone_Lining_Exterior	string¦null	false	none	none
Cone_Condition	string¦null	false	none	none
Wall_Material	string¦null	false	none	none
Wall_Lining_Interior	string¦null	false	none	none
Wall_Lining_Exterior	string¦null	false	none	none
Wall_Condition	string¦null	false	none	none
Bench_Present	string¦null	false	none	none
Bench_Material	string¦null	false	none	none
Bench_Lining	string¦null	false	none	none
Bench_Condition	string¦null	false	none	none
Channel_Installed	string¦null	false	none	none
Channel_Material	string¦null	false	none	none
Channel_Type	string¦null	false	none	none
Channel_Exposure	string¦null	false	none	none
Channel_Condition	string¦null	false	none	none
Step_Material	string¦null	false	none	none
Evidence_Surcharge	string¦null	false	none	none
AdditionalComponentInformation	string¦null	false	none	none
Rim_to_Invert	number(double)¦null	false	none	none
Rim_to_Grade	number(double)¦null	false	none	none
Grade_to_Invert	number(double)¦null	false	none	none
Rim_to_Grade_Exposed	number(double)¦null	false	none	none
Cover_Size	number(double)¦null	false	none	none
Center_Cover_Size	number(double)¦null	false	none	none
Cover_Size_Width	number(double)¦null	false	none	none
Cover_Bearing_Surface_Dia	number(double)¦null	false	none	none
Cover_Bearing_Surface_Width	number(double)¦null	false	none	none
Adjustment_Ring_Height	number(double)¦null	false	none	none
Frame_Bearing_Surface_Width	number(double)¦null	false	none	none
Frame_Bearing_Surface_Depth	number(double)¦null	false	none	none
Frame_Clear_Open_Diam	number(double)¦null	false	none	none
Frame_Clear_Open_Width	number(double)¦null	false	none	none
Frame_Offset_Distance	number(double)¦null	false	none	none
Frame_Depth	number(double)¦null	false	none	none
Chimney_Clear_Opening	number(double)¦null	false	none	none
Chimney_Depth	number(double)¦null	false	none	none
Cone_Depth	number(double)¦null	false	none	none
Wall_Diam	number(double)¦null	false	none	none
Wall_BySize	number(double)¦null	false	none	none
Wall_Depth	number(double)¦null	false	none	none
Hole_Number	integer¦null	false	none	none
Step_Number	integer¦null	false	none	none
Surface_Type_Asphalt	boolean¦null	false	none	none
Surface_Type_ConcretePavement	boolean¦null	false	none	none
Surface_Type_ConcreteCollar	boolean¦null	false	none	none
Surface_Type_GrassDirt	boolean¦null	false	none	none
Surface_Type_Gravel	boolean¦null	false	none	none
Surface_Type_Other	boolean¦null	false	none	none
Cover_Type_Bolted	boolean¦null	false	none	none
Cover_Type_Gasketed	boolean¦null	false	none	none
Cover_Type_Hatch_Double	boolean¦null	false	none	none
Cover_Type_Hatch_Single	boolean¦null	false	none	none
Cover_Type_Inner_Cover	boolean¦null	false	none	none
Cover_Type_Lamphole	boolean¦null	false	none	none
Cover_Type_Locking	boolean¦null	false	none	none
Cover_Type_Removable_Center	boolean¦null	false	none	none
Cover_Type_Solid	boolean¦null	false	none	none
Cover_Type_Vented	boolean¦null	false	none	none
Cover_Condition_BoltsMissing	boolean¦null	false	none	none
Cover_Condition_Broken	boolean¦null	false	none	none
Cover_Condition_Corroded	boolean¦null	false	none	none
Cover_Condition_Cracked	boolean¦null	false	none	none
Cover_Condition_Missing	boolean¦null	false	none	none
Cover_Condition_Restraint_Defective	boolean¦null	false	none	none
Cover_Condition_Restraint_Missing	boolean¦null	false	none	none
Cover_Condition_Sound	boolean¦null	false	none	none
Insert_Condition_Cracked	boolean¦null	false	none	none
Insert_Condition_Corroded	boolean¦null	false	none	none
Insert_Condition_InsertFell	boolean¦null	false	none	none
Insert_Condition_Leaking	boolean¦null	false	none	none
Insert_Condition_PoorlyFitting	boolean¦null	false	none	none
Insert_Condition_Sound	boolean¦null	false	none	none
Ring_Condition_Broken	boolean¦null	false	none	none
Ring_Condition_Corroded	boolean¦null	false	none	none
Ring_Condition_Cracked	boolean¦null	false	none	none
Ring_Condition_Leaking	boolean¦null	false	none	none
Ring_Condition_PoorInstall	boolean¦null	false	none	none
Ring_Condition_Sound	boolean¦null	false	none	none
Frame_Condition_Broken	boolean¦null	false	none	none
Frame_Condition_Coated	boolean¦null	false	none	none
Frame_Condition_Corroded	boolean¦null	false	none	none
Frame_Condition_Cracked	boolean¦null	false	none	none
Frame_Condition_Missing	boolean¦null	false	none	none
Frame_Condition_Sound	boolean¦null	false	none	none
Seal_Condition_Cracked	boolean¦null	false	none	none
Seal_Condition_Loose	boolean¦null	false	none	none
Seal_Condition_Missing	boolean¦null	false	none	none
Seal_Condition_Offset	boolean¦null	false	none	none
Seal_Condition_Sound	boolean¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

MainlineAssetWriteRequest

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

MainlineAssetWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
key	string¦null	false	none	none
owner	string(uuid)¦null	false	write-only	none
kind	string	false	none	none
geojson	object	false	none	none
» additionalProperties	any	false	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
account	string(uuid)	false	none	none
category	string¦null	false	none	none
metric	boolean¦null	false	none	none
shape	string¦null	false	none	none
host_material	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
length	number(double)¦null	false	none	none
height	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
rim_to_invert	number(double)¦null	false	none	none
rim_to_grade	number(double)¦null	false	none	none

MainlineInspectionWrite

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "url": "http://example.com",
  "key": "string",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "video": "http://example.com",
  "validate": true,
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

MainlineInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
sid	string(uuid)	true	read-only	none
url	string(uri)	true	read-only	none
key	string	true	none	none
reason	string	false	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
inspection_datetime	string(date-time)	true	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
created	string(date-time)	true	read-only	none
updated	string(date-time)	true	read-only	none
video	string(uri)	true	read-only	none
validate	boolean	false	none	Should this inspection be validated (default: True)
created_by	string(uri)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none
account	string(uuid)	false	none	none
year_built	string¦null	false	none	none
pipe_category	string¦null	false	none	none
shape	string¦null	false	none	none
direction	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
notes	string¦null	false	none	none
result	string¦null	false	none	none
location_type	string¦null	false	none	none
purchase_order	string¦null	false	none	none
work_order	string¦null	false	none	none
weather	string¦null	false	none	none
temperature	string¦null	false	none	none
captured_by	string¦null	false	none	none
certification	string¦null	false	none	none
reviewed_by	string¦null	false	none	none
capture_method	string¦null	false	none	none
height	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
length_inspected	number(double)¦null	false	none	none
length	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
metric	boolean¦null	false	none	none
pre_cleaning	string¦null	false	none	none
pre_cleaning_date	string¦null	false	none	none
flow_condition	string¦null	false	none	none
begin_rim_to_invert	number(double)¦null	false	none	none
begin_rim_to_grade	number(double)¦null	false	none	none
end_rim_to_invert	number(double)¦null	false	none	none
end_rim_to_grade	number(double)¦null	false	none	none
begin_access_point	string¦null	false	none	none
end_access_point	string¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

MainlineInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

MainlineInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	none
asset	string(uuid)¦null	true	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
reason	string	false	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
inspection_datetime	string(date-time)	true	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
year_built	string¦null	false	none	none
pipe_category	string¦null	false	none	none
shape	string¦null	false	none	none
direction	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
notes	string¦null	false	none	none
result	string¦null	false	none	none
location_type	string¦null	false	none	none
purchase_order	string¦null	false	none	none
work_order	string¦null	false	none	none
weather	string¦null	false	none	none
temperature	string¦null	false	none	none
captured_by	string¦null	false	none	none
certification	string¦null	false	none	none
reviewed_by	string¦null	false	none	none
capture_method	string¦null	false	none	none
height	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
length_inspected	number(double)¦null	false	none	none
length	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
metric	boolean¦null	false	none	none
pre_cleaning	string¦null	false	none	none
pre_cleaning_date	string¦null	false	none	none
flow_condition	string¦null	false	none	none
begin_rim_to_invert	number(double)¦null	false	none	none
begin_rim_to_grade	number(double)¦null	false	none	none
end_rim_to_invert	number(double)¦null	false	none	none
end_rim_to_grade	number(double)¦null	false	none	none
begin_access_point	string¦null	false	none	none
end_access_point	string¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

MaintenanceHoleInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "maintenance-hole",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "access_type": "string",
  "inspection_level": "string",
  "overflow": "string",
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

MaintenanceHoleInspectionWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	none
asset	string(uuid)¦null	true	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
reason	string	false	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
inspection_datetime	string(date-time)	true	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
year_built	string¦null	false	none	none
pipe_category	string¦null	false	none	none
shape	string¦null	false	none	none
direction	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
notes	string¦null	false	none	none
result	string¦null	false	none	none
location_type	string¦null	false	none	none
purchase_order	string¦null	false	none	none
work_order	string¦null	false	none	none
weather	string¦null	false	none	none
temperature	string¦null	false	none	none
captured_by	string¦null	false	none	none
certification	string¦null	false	none	none
reviewed_by	string¦null	false	none	none
capture_method	string¦null	false	none	none
height	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
length_inspected	number(double)¦null	false	none	none
length	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
metric	boolean¦null	false	none	none
access_type	string¦null	false	none	none
inspection_level	string¦null	false	none	none
overflow	string¦null	false	none	none
rim_to_invert	number(double)¦null	false	none	none
rim_to_grade	number(double)¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

ObservationRead

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_frame": -2147483648,
  "Distance": 0,
  "code": "string",
  "description": "string",
  "Continuous": "string",
  "Joint": true,
  "Clock_At_From": 0,
  "Clock_To": 0,
  "Value_1st_Dimension": 0,
  "Value_2nd_Dimension": 0,
  "Value_Percent": 0,
  "Grade": "string",
  "Remarks": "string",
  "snapshot_url": "string",
  "bounding_boxes": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

ObservationRead serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
video_frame	integer¦null	false	none	none
Distance	number(double)	true	read-only	none
code	string	true	read-only	none
description	string	true	read-only	none
Continuous	string	true	read-only	none
Joint	boolean	true	read-only	none
Clock_At_From	integer	true	read-only	none
Clock_To	integer	true	read-only	none
Value_1st_Dimension	number(double)	true	read-only	none
Value_2nd_Dimension	number(double)	true	read-only	none
Value_Percent	number(double)	true	read-only	none
Grade	string	true	read-only	none
Remarks	string	true	read-only	none
snapshot_url	string	true	read-only	none
bounding_boxes	string	true	read-only	none
created	string(date-time)	true	read-only	none
created_by	string(uri)	true	read-only	none
updated	string(date-time)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none
account	string(uri)	true	read-only	none

ObservationWrite

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_frame": -2147483648,
  "Distance": 0,
  "code": "string",
  "description": "string",
  "Continuous": "string",
  "Joint": true,
  "Clock_At_From": 0,
  "Clock_To": 0,
  "Value_1st_Dimension": 0,
  "Value_2nd_Dimension": 0,
  "Value_Percent": 0,
  "Remarks": "string",
  "snapshot_url": "string",
  "bounding_boxes": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

ObservationWrite serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
video_frame	integer¦null	false	none	none
Distance	number(double)	true	read-only	none
code	string	true	read-only	none
description	string	true	read-only	none
Continuous	string	true	read-only	none
Joint	boolean	true	read-only	none
Clock_At_From	integer	true	read-only	none
Clock_To	integer	true	read-only	none
Value_1st_Dimension	number(double)	true	read-only	none
Value_2nd_Dimension	number(double)	true	read-only	none
Value_Percent	number(double)	true	read-only	none
Remarks	string	true	read-only	none
snapshot_url	string	true	read-only	none
bounding_boxes	string	true	read-only	none
created	string(date-time)	true	read-only	none
created_by	string(uri)	true	read-only	none
updated	string(date-time)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none
account	string(uuid)	false	none	none

ObservationWriteRequest

{
  "video_frame": -2147483648,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

ObservationWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
video_frame	integer¦null	false	none	none
account	string(uuid)	false	none	none

OrganizationRead

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "http://example.com",
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

OrganizationRead serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
name	string	true	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
phone_number	string¦null	false	none	none
account	string(uri)	true	read-only	none
created	string(date-time)	true	read-only	none
updated	string(date-time)	true	read-only	none
created_by	string(uri)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none

OrganizationWriteRequest

{
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

OrganizationWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
name	string	true	none	none
city	string	true	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
phone_number	string¦null	false	none	none
account	string(uuid)	false	none	none

PACPInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "inspection_type": "pacp",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "City": "string",
  "Street": "string",
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "Inspection_Date": "string",
  "Inspection_Time": "string",
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "InspectionID": "string",
  "Surveyed_By": "string",
  "Certificate_Number": "string",
  "Reviewed_By": "string",
  "Reviewer_Certificate_Number": "string",
  "Owner": "string",
  "Customer": "string",
  "PO_Number": "string",
  "WorkOrder": "string",
  "Media_Label": "string",
  "Project": "string",
  "Weather": "string",
  "PreCleaning": "string",
  "Date_Cleaned": "string",
  "Purpose": "string",
  "Consequence_Of_Failure": "string",
  "Drainage_Area": "string",
  "Location_Code": "string",
  "Location_Details": "string",
  "Vertical_Datum": "string",
  "GPS_Accuracy": "string",
  "Additional_Info": "string",
  "Year_Constructed": "string",
  "Year_Renewed": "string",
  "Sheet_Number": 0,
  "IsImperial": true,
  "Custom_Fields": {
    "property1": null,
    "property2": null
  },
  "Custom_Labels": {
    "property1": null,
    "property2": null
  },
  "Pipe_Use": "string",
  "Upstream_MH": "string",
  "Downstream_MH": "string",
  "Material": "string",
  "Lining_Method": "string",
  "Direction": "string",
  "Pipe_Segment_Reference": "string",
  "Inspection_Status": "string",
  "Pressure_Value": 0,
  "Total_Length": 0,
  "Length_Surveyed": 0,
  "Reverse_Setup": 0,
  "Inspection_Technology_Used_CCTV": true,
  "Inspection_Technology_Used_Laser": true,
  "Inspection_Technology_Used_Sonar": true,
  "Inspection_Technology_Used_Sidewall": true,
  "Inspection_Technology_Used_Zoom": true,
  "Inspection_Technology_Used_Other": true,
  "Flow_Control": "string",
  "Shape": "string",
  "Coating_Method": "string",
  "Up_Northing": "string",
  "Up_Easting": "string",
  "Up_Elevation": "string",
  "Down_Northing": "string",
  "Down_Easting": "string",
  "Down_Elevation": "string",
  "MH_Coordinate_System": "string",
  "Coordinate_System": "string",
  "Height": 0,
  "Width": 0,
  "Pipe_Joint_Length": 0,
  "Up_Rim_to_Invert": 0,
  "Up_Grade_to_Invert": 0,
  "Up_Rim_to_Grade": 0,
  "Down_Rim_to_Invert": 0,
  "Down_Grade_to_Invert": 0,
  "Down_Rim_to_Grade": 0
}

PACPInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	true	none	none
asset	string(uuid)¦null	true	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
City	string	true	none	none
Street	string¦null	true	none	none
projects	[string]	false	write-only	none
Inspection_Date	string¦null	false	none	none
Inspection_Time	string¦null	false	none	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
InspectionID	string¦null	false	none	none
Surveyed_By	string¦null	false	none	none
Certificate_Number	string¦null	false	none	none
Reviewed_By	string¦null	false	none	none
Reviewer_Certificate_Number	string¦null	false	none	none
Owner	string¦null	false	none	none
Customer	string¦null	false	none	none
PO_Number	string¦null	false	none	none
WorkOrder	string¦null	false	none	none
Media_Label	string¦null	false	none	none
Project	string¦null	false	none	none
Weather	string¦null	false	none	none
PreCleaning	string¦null	false	none	none
Date_Cleaned	string¦null	false	none	none
Purpose	string¦null	false	none	none
Consequence_Of_Failure	string¦null	false	none	none
Drainage_Area	string¦null	false	none	none
Location_Code	string¦null	false	none	none
Location_Details	string¦null	false	none	none
Vertical_Datum	string¦null	false	none	none
GPS_Accuracy	string¦null	false	none	none
Additional_Info	string¦null	false	none	none
Year_Constructed	string¦null	false	none	none
Year_Renewed	string¦null	false	none	none
Sheet_Number	integer¦null	false	none	none
IsImperial	boolean¦null	false	none	none
Custom_Fields	object¦null	false	none	none
» additionalProperties	any	false	none	none
Custom_Labels	object¦null	false	none	none
» additionalProperties	any	false	none	none
Pipe_Use	string¦null	false	none	none
Upstream_MH	string¦null	false	none	none
Downstream_MH	string¦null	false	none	none
Material	string¦null	false	none	none
Lining_Method	string¦null	false	none	none
Direction	string¦null	false	none	none
Pipe_Segment_Reference	string¦null	false	none	none
Inspection_Status	string¦null	false	none	none
Pressure_Value	number(double)¦null	false	none	none
Total_Length	number(double)¦null	false	none	none
Length_Surveyed	number(double)¦null	false	none	none
Reverse_Setup	number(double)¦null	false	none	none
Inspection_Technology_Used_CCTV	boolean¦null	false	none	none
Inspection_Technology_Used_Laser	boolean¦null	false	none	none
Inspection_Technology_Used_Sonar	boolean¦null	false	none	none
Inspection_Technology_Used_Sidewall	boolean¦null	false	none	none
Inspection_Technology_Used_Zoom	boolean¦null	false	none	none
Inspection_Technology_Used_Other	boolean¦null	false	none	none
Flow_Control	string¦null	false	none	none
Shape	string¦null	false	none	none
Coating_Method	string¦null	false	none	none
Up_Northing	string¦null	false	none	none
Up_Easting	string¦null	false	none	none
Up_Elevation	string¦null	false	none	none
Down_Northing	string¦null	false	none	none
Down_Easting	string¦null	false	none	none
Down_Elevation	string¦null	false	none	none
MH_Coordinate_System	string¦null	false	none	none
Coordinate_System	string¦null	false	none	none
Height	number(double)¦null	false	none	none
Width	number(double)¦null	false	none	none
Pipe_Joint_Length	number(double)¦null	false	none	none
Up_Rim_to_Invert	number(double)¦null	false	none	none
Up_Grade_to_Invert	number(double)¦null	false	none	none
Up_Rim_to_Grade	number(double)¦null	false	none	none
Down_Rim_to_Invert	number(double)¦null	false	none	none
Down_Grade_to_Invert	number(double)¦null	false	none	none
Down_Rim_to_Grade	number(double)¦null	false	none	none

PaginatedAssetListList

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "name": "string",
    "key": "string",
    "owner": "http://example.com",
    "kind": "mainline",
    "geojson": {
      "property1": null,
      "property2": null
    },
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "created": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[AssetList]	false	none	[AssetList serializer]

PaginatedInspectionListList

[
  {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "url": "http://example.com",
    "key": "string",
    "asset": "http://example.com",
    "owner": "http://example.com",
    "client": "http://example.com",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "autocode_complete": true,
    "autocode_complete_date": "2019-08-24T14:15:22Z",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "projects": [
      {
        "url": "http://example.com",
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "account": "http://example.com",
        "name": "string",
        "description": "string",
        "client": "http://example.com",
        "date_due": "2019-08-24T14:15:22Z",
        "date_started": "2019-08-24T14:15:22Z",
        "date_finished": "2019-08-24T14:15:22Z",
        "active": true,
        "created": "2019-08-24T14:15:22Z",
        "updated": "2019-08-24T14:15:22Z",
        "created_by": "http://example.com",
        "updated_by": "http://example.com",
        "deleted": "2019-08-24T14:15:22Z",
        "deleted_by": "http://example.com"
      }
    ],
    "video": "http://example.com",
    "validate": true,
    "created_by": "http://example.com",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[InspectionList]	false	none	[InspectionList serializer]

PaginatedObservationReadList

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "video_frame": -2147483648,
    "Distance": 0,
    "code": "string",
    "description": "string",
    "Continuous": "string",
    "Joint": true,
    "Clock_At_From": 0,
    "Clock_To": 0,
    "Value_1st_Dimension": 0,
    "Value_2nd_Dimension": 0,
    "Value_Percent": 0,
    "Grade": "string",
    "Remarks": "string",
    "snapshot_url": "string",
    "bounding_boxes": "string",
    "created": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[ObservationRead]	false	none	[ObservationRead serializer]

PaginatedOrganizationReadList

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "name": "string",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "phone_number": "string",
    "account": "http://example.com",
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[OrganizationRead]	false	none	[OrganizationRead serializer]

PaginatedProjectReadList

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "account": "http://example.com",
    "name": "string",
    "description": "string",
    "client": "http://example.com",
    "date_due": "2019-08-24T14:15:22Z",
    "date_started": "2019-08-24T14:15:22Z",
    "date_finished": "2019-08-24T14:15:22Z",
    "active": true,
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[ProjectRead]	false	none	[ProjectRead serializer]

PaginatedUserListList

[
  {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "url": "http://example.com",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[UserList]	false	none	[UserList serializer]

PaginatedVideoReadList

[
  {
    "url": "http://example.com",
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "video_name": "string",
    "inspection": "http://example.com",
    "path": "string",
    "stage": "string",
    "presigned_upload_data": {
      "property1": null,
      "property2": null
    },
    "created": "2019-08-24T14:15:22Z",
    "updated": "2019-08-24T14:15:22Z",
    "created_by": "http://example.com",
    "updated_by": "http://example.com",
    "deleted": "2019-08-24T14:15:22Z",
    "deleted_by": "http://example.com",
    "account": "http://example.com"
  }
]

Properties

Name	Type	Required	Restrictions	Description
anonymous	[VideoRead]	false	none	[VideoRead serializer]

PartnerLink

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "partner": "unearth",
  "link": "http://example.com",
  "icon_url": "string",
  "meta": {
    "property1": null,
    "property2": null
  }
}

Properties

Name	Type	Required	Restrictions	Description
sid	string(uuid)	true	read-only	none
partner	string	true	none	none
link	string(uri)	true	none	none
icon_url	string	true	read-only	none
meta	object¦null	false	none	none
» additionalProperties	any	false	none	none

Enumerated Values

Property	Value
partner	unearth

PatchedAssetRequest

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	PatchedMainlineAssetWriteRequest	false	none	PatchedMainlineAssetWriteRequest serializer

xor

Name	Type	Required	Restrictions	Description
anonymous	PatchedLateralAssetWriteRequest	false	none	PatchedLateralAssetWriteRequest serializer

PatchedInspectionRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

Properties

oneOf

Name	Type	Required	Restrictions	Description
anonymous	PatchedMainlineInspectionWriteRequest	false	none	MainlineInspectionSerializer

xor

Name	Type	Required	Restrictions	Description
anonymous	PatchedLateralInspectionWriteRequest	false	none	LateralInspectionSerializer

xor

Name	Type	Required	Restrictions	Description
anonymous	PatchedMaintenanceHoleInspectionWriteRequest	false	none	PatchedMaintenanceHoleInspectionWriteRequest serializer

xor

Name	Type	Required	Restrictions	Description
anonymous	PatchedPACPInspectionWriteRequest	false	none	PACPInspectionSerializer

xor

Name	Type	Required	Restrictions	Description
anonymous	PatchedLACPInspectionWriteRequest	false	none	LACPInspectionSerializer

xor

Name	Type	Required	Restrictions	Description
anonymous	PatchedMACPInspectionWriteRequest	false	none	MACPInspectionSerializer

PatchedLACPInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "City": "string",
  "Street": "string",
  "inspection_type": "lacp",
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "Inspection_Date": "string",
  "Inspection_Time": "string",
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "InspectionID": "string",
  "Surveyed_By": "string",
  "Certificate_Number": "string",
  "Reviewed_By": "string",
  "Reviewer_Certificate_Number": "string",
  "Owner": "string",
  "Customer": "string",
  "PO_Number": "string",
  "WorkOrder": "string",
  "Media_Label": "string",
  "Project": "string",
  "Weather": "string",
  "PreCleaning": "string",
  "Date_Cleaned": "string",
  "Purpose": "string",
  "Consequence_Of_Failure": "string",
  "Drainage_Area": "string",
  "Location_Code": "string",
  "Location_Details": "string",
  "Vertical_Datum": "string",
  "GPS_Accuracy": "string",
  "Additional_Info": "string",
  "Year_Constructed": "string",
  "Year_Renewed": "string",
  "Sheet_Number": 0,
  "IsImperial": true,
  "Custom_Fields": {
    "property1": null,
    "property2": null
  },
  "Custom_Labels": {
    "property1": null,
    "property2": null
  },
  "Inspection_Status": "string",
  "Pipe_Use": "string",
  "Material": "string",
  "Direction": "string",
  "Downstream_MH": "string",
  "Inspection_Technology_Used_CCTV": "string",
  "Inspection_Technology_Used_Laser": "string",
  "Inspection_Technology_Used_Other": "string",
  "Inspection_Technology_Used_Sidewall": "string",
  "Inspection_Technology_Used_Sonar": "string",
  "Inspection_Technology_Used_Zoom": "string",
  "Lining_Method": "string",
  "Pipe_Segment_Reference": "string",
  "Pressure_Value": "string",
  "Upstream_MH": "string",
  "PACPInspectionID": "string",
  "Lateral_Segment_Reference": "string",
  "Access_Point": "string",
  "Access_Point_Northing": "string",
  "Access_Point_Easting": "string",
  "Access_Point_Elevation": "string",
  "Coordinate_System": "string",
  "StartManhole": "string",
  "Size": 0,
  "Property_Line": 0,
  "Tap_Location": 0,
  "Rim_Invert": 0,
  "Length_Surveyed": 0,
  "Total_Length": 0,
  "Reverse_Setup": 0
}

LACPInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
asset	string(uuid)¦null	false	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
City	string	false	none	none
Street	string¦null	false	none	none
inspection_type	string	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
Inspection_Date	string¦null	false	none	none
Inspection_Time	string¦null	false	none	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
InspectionID	string¦null	false	none	none
Surveyed_By	string¦null	false	none	none
Certificate_Number	string¦null	false	none	none
Reviewed_By	string¦null	false	none	none
Reviewer_Certificate_Number	string¦null	false	none	none
Owner	string¦null	false	none	none
Customer	string¦null	false	none	none
PO_Number	string¦null	false	none	none
WorkOrder	string¦null	false	none	none
Media_Label	string¦null	false	none	none
Project	string¦null	false	none	none
Weather	string¦null	false	none	none
PreCleaning	string¦null	false	none	none
Date_Cleaned	string¦null	false	none	none
Purpose	string¦null	false	none	none
Consequence_Of_Failure	string¦null	false	none	none
Drainage_Area	string¦null	false	none	none
Location_Code	string¦null	false	none	none
Location_Details	string¦null	false	none	none
Vertical_Datum	string¦null	false	none	none
GPS_Accuracy	string¦null	false	none	none
Additional_Info	string¦null	false	none	none
Year_Constructed	string¦null	false	none	none
Year_Renewed	string¦null	false	none	none
Sheet_Number	integer¦null	false	none	none
IsImperial	boolean¦null	false	none	none
Custom_Fields	object¦null	false	none	none
» additionalProperties	any	false	none	none
Custom_Labels	object¦null	false	none	none
» additionalProperties	any	false	none	none
Inspection_Status	string¦null	false	none	none
Pipe_Use	string¦null	false	none	none
Material	string¦null	false	none	none
Direction	string¦null	false	none	none
Downstream_MH	string¦null	false	none	none
Inspection_Technology_Used_CCTV	string¦null	false	none	none
Inspection_Technology_Used_Laser	string¦null	false	none	none
Inspection_Technology_Used_Other	string¦null	false	none	none
Inspection_Technology_Used_Sidewall	string¦null	false	none	none
Inspection_Technology_Used_Sonar	string¦null	false	none	none
Inspection_Technology_Used_Zoom	string¦null	false	none	none
Lining_Method	string¦null	false	none	none
Pipe_Segment_Reference	string¦null	false	none	none
Pressure_Value	string¦null	false	none	none
Upstream_MH	string¦null	false	none	none
PACPInspectionID	string¦null	false	none	none
Lateral_Segment_Reference	string¦null	false	none	none
Access_Point	string¦null	false	none	none
Access_Point_Northing	string¦null	false	none	none
Access_Point_Easting	string¦null	false	none	none
Access_Point_Elevation	string¦null	false	none	none
Coordinate_System	string¦null	false	none	none
StartManhole	string¦null	false	none	none
Size	number(double)¦null	false	none	none
Property_Line	number(double)¦null	false	none	none
Tap_Location	number(double)¦null	false	none	none
Rim_Invert	number(double)¦null	false	none	none
Length_Surveyed	number(double)¦null	false	none	none
Total_Length	number(double)¦null	false	none	none
Reverse_Setup	number(double)¦null	false	none	none

PatchedLateralAssetWriteRequest

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "lateral",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "tap_distance": 0
}

PatchedLateralAssetWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
key	string¦null	false	none	none
owner	string(uuid)¦null	false	write-only	none
kind	string	false	none	none
geojson	object	false	none	none
» additionalProperties	any	false	none	none
city	string	false	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
account	string(uuid)	false	none	none
category	string¦null	false	none	none
metric	boolean¦null	false	none	none
shape	string¦null	false	none	none
host_material	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
length	number(double)¦null	false	none	none
height	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
tap_distance	number(double)¦null	false	none	none

PatchedLateralInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "lateral",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "lateral_access_point": "string",
  "property_distance": 0,
  "tap_distance": 0,
  "rim_to_invert": 0,
  "access_point": "string"
}

LateralInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
asset	string(uuid)¦null	false	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
reason	string	false	none	none
city	string	false	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
inspection_datetime	string(date-time)	false	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
year_built	string¦null	false	none	none
pipe_category	string¦null	false	none	none
shape	string¦null	false	none	none
direction	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
notes	string¦null	false	none	none
result	string¦null	false	none	none
location_type	string¦null	false	none	none
purchase_order	string¦null	false	none	none
work_order	string¦null	false	none	none
weather	string¦null	false	none	none
temperature	string¦null	false	none	none
captured_by	string¦null	false	none	none
certification	string¦null	false	none	none
reviewed_by	string¦null	false	none	none
capture_method	string¦null	false	none	none
height	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
length_inspected	number(double)¦null	false	none	none
length	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
metric	boolean¦null	false	none	none
pre_cleaning	string¦null	false	none	none
pre_cleaning_date	string¦null	false	none	none
lateral_access_point	string¦null	false	none	none
property_distance	number(double)¦null	false	none	none
tap_distance	number(double)¦null	false	none	none
rim_to_invert	number(double)¦null	false	none	none
access_point	string¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

PatchedMACPInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "City": "string",
  "Street": "string",
  "inspection_type": "macp",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "Inspection_Date": "string",
  "Inspection_Time": "string",
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "pipe_connections": [
    null
  ],
  "InspectionID": "string",
  "Surveyed_By": "string",
  "Certificate_Number": "string",
  "Reviewed_By": "string",
  "Reviewer_Certificate_Number": "string",
  "Owner": "string",
  "Customer": "string",
  "PO_Number": "string",
  "WorkOrder": "string",
  "Media_Label": "string",
  "Project": "string",
  "Weather": "string",
  "PreCleaning": "string",
  "Date_Cleaned": "string",
  "Purpose": "string",
  "Consequence_Of_Failure": "string",
  "Drainage_Area": "string",
  "Location_Code": "string",
  "Location_Details": "string",
  "Vertical_Datum": "string",
  "GPS_Accuracy": "string",
  "Additional_Info": "string",
  "Year_Constructed": 0,
  "Year_Renewed": 0,
  "Sheet_Number": 0,
  "IsImperial": true,
  "Custom_Fields": {
    "property1": null,
    "property2": null
  },
  "Custom_Labels": {
    "property1": null,
    "property2": null
  },
  "InspectionLevel": "string",
  "Inspection_Status": "string",
  "Manhole_Number": "string",
  "Inflow_Potential_from_Runoff": "string",
  "MH_Use": "string",
  "Access_Type": "string",
  "Northing": "string",
  "Easting": "string",
  "Elevation": "string",
  "Coordinate_System": "string",
  "Cover_Shape": "string",
  "Cover_Material": "string",
  "Hole_Diameter": "string",
  "Cover_Frame_Fit": "string",
  "Cover_Insert_Type": "string",
  "Adjustment_Ring_Type": "string",
  "Adjustment_Ring_Material": "string",
  "Frame_Material": "string",
  "Frame_Seal_Inflow": "string",
  "Chimney_Present": "string",
  "Chimney_Material1": "string",
  "Chimney_Material2": "string",
  "Chimney_InI": "string",
  "Chimney_Lining_Interior": "string",
  "Chimney_Lining_Exterior": "string",
  "Chimney_Condition": "string",
  "Cone_Type": "string",
  "Cone_Material": "string",
  "Cone_Lining_Interior": "string",
  "Cone_Lining_Exterior": "string",
  "Cone_Condition": "string",
  "Wall_Material": "string",
  "Wall_Lining_Interior": "string",
  "Wall_Lining_Exterior": "string",
  "Wall_Condition": "string",
  "Bench_Present": "string",
  "Bench_Material": "string",
  "Bench_Lining": "string",
  "Bench_Condition": "string",
  "Channel_Installed": "string",
  "Channel_Material": "string",
  "Channel_Type": "string",
  "Channel_Exposure": "string",
  "Channel_Condition": "string",
  "Step_Material": "string",
  "Evidence_Surcharge": "string",
  "AdditionalComponentInformation": "string",
  "Rim_to_Invert": 0,
  "Rim_to_Grade": 0,
  "Grade_to_Invert": 0,
  "Rim_to_Grade_Exposed": 0,
  "Cover_Size": 0,
  "Center_Cover_Size": 0,
  "Cover_Size_Width": 0,
  "Cover_Bearing_Surface_Dia": 0,
  "Cover_Bearing_Surface_Width": 0,
  "Adjustment_Ring_Height": 0,
  "Frame_Bearing_Surface_Width": 0,
  "Frame_Bearing_Surface_Depth": 0,
  "Frame_Clear_Open_Diam": 0,
  "Frame_Clear_Open_Width": 0,
  "Frame_Offset_Distance": 0,
  "Frame_Depth": 0,
  "Chimney_Clear_Opening": 0,
  "Chimney_Depth": 0,
  "Cone_Depth": 0,
  "Wall_Diam": 0,
  "Wall_BySize": 0,
  "Wall_Depth": 0,
  "Hole_Number": 0,
  "Step_Number": 0,
  "Surface_Type_Asphalt": true,
  "Surface_Type_ConcretePavement": true,
  "Surface_Type_ConcreteCollar": true,
  "Surface_Type_GrassDirt": true,
  "Surface_Type_Gravel": true,
  "Surface_Type_Other": true,
  "Cover_Type_Bolted": true,
  "Cover_Type_Gasketed": true,
  "Cover_Type_Hatch_Double": true,
  "Cover_Type_Hatch_Single": true,
  "Cover_Type_Inner_Cover": true,
  "Cover_Type_Lamphole": true,
  "Cover_Type_Locking": true,
  "Cover_Type_Removable_Center": true,
  "Cover_Type_Solid": true,
  "Cover_Type_Vented": true,
  "Cover_Condition_BoltsMissing": true,
  "Cover_Condition_Broken": true,
  "Cover_Condition_Corroded": true,
  "Cover_Condition_Cracked": true,
  "Cover_Condition_Missing": true,
  "Cover_Condition_Restraint_Defective": true,
  "Cover_Condition_Restraint_Missing": true,
  "Cover_Condition_Sound": true,
  "Insert_Condition_Cracked": true,
  "Insert_Condition_Corroded": true,
  "Insert_Condition_InsertFell": true,
  "Insert_Condition_Leaking": true,
  "Insert_Condition_PoorlyFitting": true,
  "Insert_Condition_Sound": true,
  "Ring_Condition_Broken": true,
  "Ring_Condition_Corroded": true,
  "Ring_Condition_Cracked": true,
  "Ring_Condition_Leaking": true,
  "Ring_Condition_PoorInstall": true,
  "Ring_Condition_Sound": true,
  "Frame_Condition_Broken": true,
  "Frame_Condition_Coated": true,
  "Frame_Condition_Corroded": true,
  "Frame_Condition_Cracked": true,
  "Frame_Condition_Missing": true,
  "Frame_Condition_Sound": true,
  "Seal_Condition_Cracked": true,
  "Seal_Condition_Loose": true,
  "Seal_Condition_Missing": true,
  "Seal_Condition_Offset": true,
  "Seal_Condition_Sound": true
}

MACPInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
asset	string(uuid)¦null	false	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
reason	string	false	none	none
City	string	false	none	none
Street	string¦null	false	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
Inspection_Date	string¦null	false	none	none
Inspection_Time	string¦null	false	none	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
pipe_connections	[any]	false	none	none
InspectionID	string¦null	false	none	none
Surveyed_By	string¦null	false	none	none
Certificate_Number	string¦null	false	none	none
Reviewed_By	string¦null	false	none	none
Reviewer_Certificate_Number	string¦null	false	none	none
Owner	string¦null	false	none	none
Customer	string¦null	false	none	none
PO_Number	string¦null	false	none	none
WorkOrder	string¦null	false	none	none
Media_Label	string¦null	false	none	none
Project	string¦null	false	none	none
Weather	string¦null	false	none	none
PreCleaning	string¦null	false	none	none
Date_Cleaned	string¦null	false	none	none
Purpose	string¦null	false	none	none
Consequence_Of_Failure	string¦null	false	none	none
Drainage_Area	string¦null	false	none	none
Location_Code	string¦null	false	none	none
Location_Details	string¦null	false	none	none
Vertical_Datum	string¦null	false	none	none
GPS_Accuracy	string¦null	false	none	none
Additional_Info	string¦null	false	none	none
Year_Constructed	integer¦null	false	none	none
Year_Renewed	integer¦null	false	none	none
Sheet_Number	integer¦null	false	none	none
IsImperial	boolean¦null	false	none	none
Custom_Fields	object¦null	false	none	none
» additionalProperties	any	false	none	none
Custom_Labels	object¦null	false	none	none
» additionalProperties	any	false	none	none
InspectionLevel	string¦null	false	none	none
Inspection_Status	string¦null	false	none	none
Manhole_Number	string¦null	false	none	none
Inflow_Potential_from_Runoff	string¦null	false	none	none
MH_Use	string¦null	false	none	none
Access_Type	string¦null	false	none	none
Northing	string¦null	false	none	none
Easting	string¦null	false	none	none
Elevation	string¦null	false	none	none
Coordinate_System	string¦null	false	none	none
Cover_Shape	string¦null	false	none	none
Cover_Material	string¦null	false	none	none
Hole_Diameter	string¦null	false	none	none
Cover_Frame_Fit	string¦null	false	none	none
Cover_Insert_Type	string¦null	false	none	none
Adjustment_Ring_Type	string¦null	false	none	none
Adjustment_Ring_Material	string¦null	false	none	none
Frame_Material	string¦null	false	none	none
Frame_Seal_Inflow	string¦null	false	none	none
Chimney_Present	string¦null	false	none	none
Chimney_Material1	string¦null	false	none	none
Chimney_Material2	string¦null	false	none	none
Chimney_InI	string¦null	false	none	none
Chimney_Lining_Interior	string¦null	false	none	none
Chimney_Lining_Exterior	string¦null	false	none	none
Chimney_Condition	string¦null	false	none	none
Cone_Type	string¦null	false	none	none
Cone_Material	string¦null	false	none	none
Cone_Lining_Interior	string¦null	false	none	none
Cone_Lining_Exterior	string¦null	false	none	none
Cone_Condition	string¦null	false	none	none
Wall_Material	string¦null	false	none	none
Wall_Lining_Interior	string¦null	false	none	none
Wall_Lining_Exterior	string¦null	false	none	none
Wall_Condition	string¦null	false	none	none
Bench_Present	string¦null	false	none	none
Bench_Material	string¦null	false	none	none
Bench_Lining	string¦null	false	none	none
Bench_Condition	string¦null	false	none	none
Channel_Installed	string¦null	false	none	none
Channel_Material	string¦null	false	none	none
Channel_Type	string¦null	false	none	none
Channel_Exposure	string¦null	false	none	none
Channel_Condition	string¦null	false	none	none
Step_Material	string¦null	false	none	none
Evidence_Surcharge	string¦null	false	none	none
AdditionalComponentInformation	string¦null	false	none	none
Rim_to_Invert	number(double)¦null	false	none	none
Rim_to_Grade	number(double)¦null	false	none	none
Grade_to_Invert	number(double)¦null	false	none	none
Rim_to_Grade_Exposed	number(double)¦null	false	none	none
Cover_Size	number(double)¦null	false	none	none
Center_Cover_Size	number(double)¦null	false	none	none
Cover_Size_Width	number(double)¦null	false	none	none
Cover_Bearing_Surface_Dia	number(double)¦null	false	none	none
Cover_Bearing_Surface_Width	number(double)¦null	false	none	none
Adjustment_Ring_Height	number(double)¦null	false	none	none
Frame_Bearing_Surface_Width	number(double)¦null	false	none	none
Frame_Bearing_Surface_Depth	number(double)¦null	false	none	none
Frame_Clear_Open_Diam	number(double)¦null	false	none	none
Frame_Clear_Open_Width	number(double)¦null	false	none	none
Frame_Offset_Distance	number(double)¦null	false	none	none
Frame_Depth	number(double)¦null	false	none	none
Chimney_Clear_Opening	number(double)¦null	false	none	none
Chimney_Depth	number(double)¦null	false	none	none
Cone_Depth	number(double)¦null	false	none	none
Wall_Diam	number(double)¦null	false	none	none
Wall_BySize	number(double)¦null	false	none	none
Wall_Depth	number(double)¦null	false	none	none
Hole_Number	integer¦null	false	none	none
Step_Number	integer¦null	false	none	none
Surface_Type_Asphalt	boolean¦null	false	none	none
Surface_Type_ConcretePavement	boolean¦null	false	none	none
Surface_Type_ConcreteCollar	boolean¦null	false	none	none
Surface_Type_GrassDirt	boolean¦null	false	none	none
Surface_Type_Gravel	boolean¦null	false	none	none
Surface_Type_Other	boolean¦null	false	none	none
Cover_Type_Bolted	boolean¦null	false	none	none
Cover_Type_Gasketed	boolean¦null	false	none	none
Cover_Type_Hatch_Double	boolean¦null	false	none	none
Cover_Type_Hatch_Single	boolean¦null	false	none	none
Cover_Type_Inner_Cover	boolean¦null	false	none	none
Cover_Type_Lamphole	boolean¦null	false	none	none
Cover_Type_Locking	boolean¦null	false	none	none
Cover_Type_Removable_Center	boolean¦null	false	none	none
Cover_Type_Solid	boolean¦null	false	none	none
Cover_Type_Vented	boolean¦null	false	none	none
Cover_Condition_BoltsMissing	boolean¦null	false	none	none
Cover_Condition_Broken	boolean¦null	false	none	none
Cover_Condition_Corroded	boolean¦null	false	none	none
Cover_Condition_Cracked	boolean¦null	false	none	none
Cover_Condition_Missing	boolean¦null	false	none	none
Cover_Condition_Restraint_Defective	boolean¦null	false	none	none
Cover_Condition_Restraint_Missing	boolean¦null	false	none	none
Cover_Condition_Sound	boolean¦null	false	none	none
Insert_Condition_Cracked	boolean¦null	false	none	none
Insert_Condition_Corroded	boolean¦null	false	none	none
Insert_Condition_InsertFell	boolean¦null	false	none	none
Insert_Condition_Leaking	boolean¦null	false	none	none
Insert_Condition_PoorlyFitting	boolean¦null	false	none	none
Insert_Condition_Sound	boolean¦null	false	none	none
Ring_Condition_Broken	boolean¦null	false	none	none
Ring_Condition_Corroded	boolean¦null	false	none	none
Ring_Condition_Cracked	boolean¦null	false	none	none
Ring_Condition_Leaking	boolean¦null	false	none	none
Ring_Condition_PoorInstall	boolean¦null	false	none	none
Ring_Condition_Sound	boolean¦null	false	none	none
Frame_Condition_Broken	boolean¦null	false	none	none
Frame_Condition_Coated	boolean¦null	false	none	none
Frame_Condition_Corroded	boolean¦null	false	none	none
Frame_Condition_Cracked	boolean¦null	false	none	none
Frame_Condition_Missing	boolean¦null	false	none	none
Frame_Condition_Sound	boolean¦null	false	none	none
Seal_Condition_Cracked	boolean¦null	false	none	none
Seal_Condition_Loose	boolean¦null	false	none	none
Seal_Condition_Missing	boolean¦null	false	none	none
Seal_Condition_Offset	boolean¦null	false	none	none
Seal_Condition_Sound	boolean¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

PatchedMainlineAssetWriteRequest

{
  "name": "string",
  "key": "string",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "kind": "mainline",
  "geojson": {
    "property1": null,
    "property2": null
  },
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "category": "string",
  "metric": true,
  "shape": "string",
  "host_material": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "length": 0,
  "height": 0,
  "width": 0,
  "joint_distance": 0,
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

PatchedMainlineAssetWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
key	string¦null	false	none	none
owner	string(uuid)¦null	false	write-only	none
kind	string	false	none	none
geojson	object	false	none	none
» additionalProperties	any	false	none	none
city	string	false	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
account	string(uuid)	false	none	none
category	string¦null	false	none	none
metric	boolean¦null	false	none	none
shape	string¦null	false	none	none
host_material	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
length	number(double)¦null	false	none	none
height	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
rim_to_invert	number(double)¦null	false	none	none
rim_to_grade	number(double)¦null	false	none	none

PatchedMainlineInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "mainline",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "pre_cleaning": "string",
  "pre_cleaning_date": "string",
  "flow_condition": "string",
  "begin_rim_to_invert": 0,
  "begin_rim_to_grade": 0,
  "end_rim_to_invert": 0,
  "end_rim_to_grade": 0,
  "begin_access_point": "string",
  "end_access_point": "string"
}

MainlineInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
asset	string(uuid)¦null	false	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
reason	string	false	none	none
city	string	false	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
inspection_datetime	string(date-time)	false	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
year_built	string¦null	false	none	none
pipe_category	string¦null	false	none	none
shape	string¦null	false	none	none
direction	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
notes	string¦null	false	none	none
result	string¦null	false	none	none
location_type	string¦null	false	none	none
purchase_order	string¦null	false	none	none
work_order	string¦null	false	none	none
weather	string¦null	false	none	none
temperature	string¦null	false	none	none
captured_by	string¦null	false	none	none
certification	string¦null	false	none	none
reviewed_by	string¦null	false	none	none
capture_method	string¦null	false	none	none
height	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
length_inspected	number(double)¦null	false	none	none
length	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
metric	boolean¦null	false	none	none
pre_cleaning	string¦null	false	none	none
pre_cleaning_date	string¦null	false	none	none
flow_condition	string¦null	false	none	none
begin_rim_to_invert	number(double)¦null	false	none	none
begin_rim_to_grade	number(double)¦null	false	none	none
end_rim_to_invert	number(double)¦null	false	none	none
end_rim_to_grade	number(double)¦null	false	none	none
begin_access_point	string¦null	false	none	none
end_access_point	string¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

PatchedMaintenanceHoleInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "reason": "operations-support",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "inspection_datetime": "2019-08-24T14:15:22Z",
  "inspection_type": "maintenance-hole",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "year_built": "string",
  "pipe_category": "string",
  "shape": "string",
  "direction": "string",
  "renewal_method": "string",
  "renewal_year": "string",
  "notes": "string",
  "result": "string",
  "location_type": "string",
  "purchase_order": "string",
  "work_order": "string",
  "weather": "string",
  "temperature": "string",
  "captured_by": "string",
  "certification": "string",
  "reviewed_by": "string",
  "capture_method": "string",
  "height": 0,
  "joint_distance": 0,
  "length_inspected": 0,
  "length": 0,
  "width": 0,
  "metric": true,
  "access_type": "string",
  "inspection_level": "string",
  "overflow": "string",
  "rim_to_invert": 0,
  "rim_to_grade": 0
}

PatchedMaintenanceHoleInspectionWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
asset	string(uuid)¦null	false	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
reason	string	false	none	none
city	string	false	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
inspection_datetime	string(date-time)	false	none	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
projects	[string]	false	write-only	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
year_built	string¦null	false	none	none
pipe_category	string¦null	false	none	none
shape	string¦null	false	none	none
direction	string¦null	false	none	none
renewal_method	string¦null	false	none	none
renewal_year	string¦null	false	none	none
notes	string¦null	false	none	none
result	string¦null	false	none	none
location_type	string¦null	false	none	none
purchase_order	string¦null	false	none	none
work_order	string¦null	false	none	none
weather	string¦null	false	none	none
temperature	string¦null	false	none	none
captured_by	string¦null	false	none	none
certification	string¦null	false	none	none
reviewed_by	string¦null	false	none	none
capture_method	string¦null	false	none	none
height	number(double)¦null	false	none	none
joint_distance	number(double)¦null	false	none	none
length_inspected	number(double)¦null	false	none	none
length	number(double)¦null	false	none	none
width	number(double)¦null	false	none	none
metric	boolean¦null	false	none	none
access_type	string¦null	false	none	none
inspection_level	string¦null	false	none	none
overflow	string¦null	false	none	none
rim_to_invert	number(double)¦null	false	none	none
rim_to_grade	number(double)¦null	false	none	none

Enumerated Values

Property	Value
reason	operations-support
reason	infiltation-and-inflow
reason	new-install
reason	post-renewal
reason	pre-renewal
reason	routine
reason	pre-construction
reason	resurvey
reason	sewer-system-evaluation-survey
reason	pre-existing-media
reason	other

PatchedOrganizationWriteRequest

{
  "name": "string",
  "city": "string",
  "city_area": "string",
  "country_area": "string",
  "country_code": "string",
  "postal_code": "string",
  "sorting_code": "string",
  "street_address": "string",
  "phone_number": "string",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

PatchedOrganizationWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
name	string	false	none	none
city	string	false	none	none
city_area	string	false	none	none
country_area	string	false	none	none
country_code	string	false	none	none
postal_code	string	false	none	none
sorting_code	string	false	none	none
street_address	string	false	none	none
phone_number	string¦null	false	none	none
account	string(uuid)	false	none	none

PatchedPACPInspectionWriteRequest

{
  "key": "string",
  "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
  "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "inspection_type": "pacp",
  "distance": {
    "property1": null,
    "property2": null
  },
  "metadata": {
    "property1": null,
    "property2": null
  },
  "City": "string",
  "Street": "string",
  "projects": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "Inspection_Date": "string",
  "Inspection_Time": "string",
  "validate": true,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "InspectionID": "string",
  "Surveyed_By": "string",
  "Certificate_Number": "string",
  "Reviewed_By": "string",
  "Reviewer_Certificate_Number": "string",
  "Owner": "string",
  "Customer": "string",
  "PO_Number": "string",
  "WorkOrder": "string",
  "Media_Label": "string",
  "Project": "string",
  "Weather": "string",
  "PreCleaning": "string",
  "Date_Cleaned": "string",
  "Purpose": "string",
  "Consequence_Of_Failure": "string",
  "Drainage_Area": "string",
  "Location_Code": "string",
  "Location_Details": "string",
  "Vertical_Datum": "string",
  "GPS_Accuracy": "string",
  "Additional_Info": "string",
  "Year_Constructed": "string",
  "Year_Renewed": "string",
  "Sheet_Number": 0,
  "IsImperial": true,
  "Custom_Fields": {
    "property1": null,
    "property2": null
  },
  "Custom_Labels": {
    "property1": null,
    "property2": null
  },
  "Pipe_Use": "string",
  "Upstream_MH": "string",
  "Downstream_MH": "string",
  "Material": "string",
  "Lining_Method": "string",
  "Direction": "string",
  "Pipe_Segment_Reference": "string",
  "Inspection_Status": "string",
  "Pressure_Value": 0,
  "Total_Length": 0,
  "Length_Surveyed": 0,
  "Reverse_Setup": 0,
  "Inspection_Technology_Used_CCTV": true,
  "Inspection_Technology_Used_Laser": true,
  "Inspection_Technology_Used_Sonar": true,
  "Inspection_Technology_Used_Sidewall": true,
  "Inspection_Technology_Used_Zoom": true,
  "Inspection_Technology_Used_Other": true,
  "Flow_Control": "string",
  "Shape": "string",
  "Coating_Method": "string",
  "Up_Northing": "string",
  "Up_Easting": "string",
  "Up_Elevation": "string",
  "Down_Northing": "string",
  "Down_Easting": "string",
  "Down_Elevation": "string",
  "MH_Coordinate_System": "string",
  "Coordinate_System": "string",
  "Height": 0,
  "Width": 0,
  "Pipe_Joint_Length": 0,
  "Up_Rim_to_Invert": 0,
  "Up_Grade_to_Invert": 0,
  "Up_Rim_to_Grade": 0,
  "Down_Rim_to_Invert": 0,
  "Down_Grade_to_Invert": 0,
  "Down_Rim_to_Grade": 0
}

PACPInspectionSerializer

Properties

Name	Type	Required	Restrictions	Description
key	string	false	none	none
asset	string(uuid)¦null	false	write-only	none
owner	string(uuid)¦null	false	write-only	none
client	string(uuid)¦null	false	write-only	none
inspection_type	string	false	none	none
distance	object	false	none	none
» additionalProperties	any	false	none	none
metadata	object	false	none	Customer defined Inspection metadata.
» additionalProperties	any	false	none	none
City	string	false	none	none
Street	string¦null	false	none	none
projects	[string]	false	write-only	none
Inspection_Date	string¦null	false	none	none
Inspection_Time	string¦null	false	none	none
validate	boolean	false	none	Should this inspection be validated (default: True)
account	string(uuid)	false	none	none
InspectionID	string¦null	false	none	none
Surveyed_By	string¦null	false	none	none
Certificate_Number	string¦null	false	none	none
Reviewed_By	string¦null	false	none	none
Reviewer_Certificate_Number	string¦null	false	none	none
Owner	string¦null	false	none	none
Customer	string¦null	false	none	none
PO_Number	string¦null	false	none	none
WorkOrder	string¦null	false	none	none
Media_Label	string¦null	false	none	none
Project	string¦null	false	none	none
Weather	string¦null	false	none	none
PreCleaning	string¦null	false	none	none
Date_Cleaned	string¦null	false	none	none
Purpose	string¦null	false	none	none
Consequence_Of_Failure	string¦null	false	none	none
Drainage_Area	string¦null	false	none	none
Location_Code	string¦null	false	none	none
Location_Details	string¦null	false	none	none
Vertical_Datum	string¦null	false	none	none
GPS_Accuracy	string¦null	false	none	none
Additional_Info	string¦null	false	none	none
Year_Constructed	string¦null	false	none	none
Year_Renewed	string¦null	false	none	none
Sheet_Number	integer¦null	false	none	none
IsImperial	boolean¦null	false	none	none
Custom_Fields	object¦null	false	none	none
» additionalProperties	any	false	none	none
Custom_Labels	object¦null	false	none	none
» additionalProperties	any	false	none	none
Pipe_Use	string¦null	false	none	none
Upstream_MH	string¦null	false	none	none
Downstream_MH	string¦null	false	none	none
Material	string¦null	false	none	none
Lining_Method	string¦null	false	none	none
Direction	string¦null	false	none	none
Pipe_Segment_Reference	string¦null	false	none	none
Inspection_Status	string¦null	false	none	none
Pressure_Value	number(double)¦null	false	none	none
Total_Length	number(double)¦null	false	none	none
Length_Surveyed	number(double)¦null	false	none	none
Reverse_Setup	number(double)¦null	false	none	none
Inspection_Technology_Used_CCTV	boolean¦null	false	none	none
Inspection_Technology_Used_Laser	boolean¦null	false	none	none
Inspection_Technology_Used_Sonar	boolean¦null	false	none	none
Inspection_Technology_Used_Sidewall	boolean¦null	false	none	none
Inspection_Technology_Used_Zoom	boolean¦null	false	none	none
Inspection_Technology_Used_Other	boolean¦null	false	none	none
Flow_Control	string¦null	false	none	none
Shape	string¦null	false	none	none
Coating_Method	string¦null	false	none	none
Up_Northing	string¦null	false	none	none
Up_Easting	string¦null	false	none	none
Up_Elevation	string¦null	false	none	none
Down_Northing	string¦null	false	none	none
Down_Easting	string¦null	false	none	none
Down_Elevation	string¦null	false	none	none
MH_Coordinate_System	string¦null	false	none	none
Coordinate_System	string¦null	false	none	none
Height	number(double)¦null	false	none	none
Width	number(double)¦null	false	none	none
Pipe_Joint_Length	number(double)¦null	false	none	none
Up_Rim_to_Invert	number(double)¦null	false	none	none
Up_Grade_to_Invert	number(double)¦null	false	none	none
Up_Rim_to_Grade	number(double)¦null	false	none	none
Down_Rim_to_Invert	number(double)¦null	false	none	none
Down_Grade_to_Invert	number(double)¦null	false	none	none
Down_Rim_to_Grade	number(double)¦null	false	none	none

PatchedProjectWriteRequest

{
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "name": "string",
  "description": "string",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true
}

PatchedProjectWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
account	string(uuid)	false	none	none
name	string	false	none	none
description	string¦null	false	none	none
client	string(uuid)¦null	false	write-only	none
date_due	string(date-time)¦null	false	none	Project’s Date Due
date_started	string(date-time)¦null	false	none	Project’s Date Started
date_finished	string(date-time)¦null	false	none	Project’s Date Finished
active	boolean	false	none	none

PatchedVideoRequest

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

PatchedVideoRequest serializer

Properties

Name	Type	Required	Restrictions	Description
inspection	InspectionRequest	false	none	none
variant	integer	false	none	none
encoding_location	string¦null	false	none	The S3 location of the encoding
encoding_location_exists	boolean¦null	false	none	none
encoded	boolean	false	none	none
video_format	integer	false	none	none
zero_distance_mark	number(double)¦null	false	none	none
number_of_frames	integer¦null	false	none	The number of frames in this video
is_selectable	boolean	false	none	none
pipe	integer	false	none	none
camera	integer	false	none	none
video_width	integer¦null	false	none	none
video_height	integer¦null	false	none	none
video_duration	number(double)¦null	false	none	The duration in seconds of the video
model_scale_factor	number(double)¦null	false	none	none
default_position_coords	object¦null	false	none	none
» additionalProperties	any	false	none	none
contractor	string¦null	false	none	none
created_by	AccountUserRequest	false	none	AccountUserRequest serializer
updated_by	AccountUserRequest	false	none	AccountUserRequest serializer
auxillary_videos	object¦null	false	none	none
» additionalProperties	any	false	none	none

Enumerated Values

Property	Value
variant	0
variant	1
variant	2
variant	3
variant	4
video_format	0
video_format	1
video_format	2
video_format	3
pipe	0
pipe	1
pipe	2
pipe	3
pipe	4
pipe	5
pipe	6
camera	0
camera	1
camera	2
camera	3
camera	4
camera	5
camera	6

PatchedVideoWriteRequest

{
  "inspection": "382346be-f083-4b69-b8d0-1c54192c69c9",
  "payouts": "string",
  "path": "string",
  "stage": 0,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

PatchedVideoWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
inspection	string(uuid)	false	write-only	none
payouts	string	false	none	none
path	string¦null	false	none	none
stage	integer	false	none	none
account	string(uuid)	false	none	none

Enumerated Values

Property	Value
stage	0
stage	1
stage	2
stage	3
stage	4
stage	5
stage	11
stage	12
stage	13
stage	20

ProjectRead

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "account": "http://example.com",
  "name": "string",
  "description": "string",
  "client": "http://example.com",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true,
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com"
}

ProjectRead serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
account	string(uri)	true	read-only	none
name	string	true	none	none
description	string¦null	false	none	none
client	string(uri)	true	read-only	none
date_due	string(date-time)¦null	false	none	Project’s Date Due
date_started	string(date-time)¦null	false	none	Project’s Date Started
date_finished	string(date-time)¦null	false	none	Project’s Date Finished
active	boolean	false	none	none
created	string(date-time)	true	read-only	none
updated	string(date-time)	true	read-only	none
created_by	string(uri)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none

ProjectWriteRequest

{
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
  "name": "string",
  "description": "string",
  "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
  "date_due": "2019-08-24T14:15:22Z",
  "date_started": "2019-08-24T14:15:22Z",
  "date_finished": "2019-08-24T14:15:22Z",
  "active": true
}

ProjectWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
account	string(uuid)	false	none	none
name	string	true	none	none
description	string¦null	false	none	none
client	string(uuid)¦null	false	write-only	none
date_due	string(date-time)¦null	false	none	Project’s Date Due
date_started	string(date-time)¦null	false	none	Project’s Date Started
date_finished	string(date-time)¦null	false	none	Project’s Date Finished
active	boolean	false	none	none

TokenRefresh

{
  "access": "string"
}

Properties

Name	Type	Required	Restrictions	Description
access	string	true	read-only	none

TokenRefreshRequest

{
  "refresh": "string"
}

Properties

Name	Type	Required	Restrictions	Description
refresh	string	true	write-only	none

UserList

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "url": "http://example.com",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com"
}

UserList serializer

Properties

Name	Type	Required	Restrictions	Description
sid	string(uuid)	true	read-only	none
url	string(uri)	true	read-only	none
first_name	string	false	none	none
last_name	string	false	none	none
email	string(email)	true	none	none

UserRead

{
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "url": "http://example.com",
  "first_name": "string",
  "last_name": "string",
  "email": "user@example.com",
  "permission_level": "string",
  "projects": "string"
}

UserRead serializer

Properties

Name	Type	Required	Restrictions	Description
sid	string(uuid)	true	read-only	none
url	string(uri)	true	read-only	none
first_name	string	false	none	none
last_name	string	false	none	none
email	string(email)	true	none	none
permission_level	string	true	read-only	none
projects	string	true	read-only	none

Video

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "inspection": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "Inspection_Date": "string",
    "Inspection_Time": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "Street": "string",
    "City": "string",
    "City_Area": "string",
    "Country_Area": "string",
    "Country_Code": "string",
    "Postal_Code": "string",
    "Sorting_Code": "string",
    "validate": true,
    "geojson": {
      "property1": null,
      "property2": null
    },
    "partner_links": [
      {
        "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
        "partner": "unearth",
        "link": "http://example.com",
        "icon_url": "string",
        "meta": {
          "property1": null,
          "property2": null
        }
      }
    ],
    "created": "2019-08-24T14:15:22Z",
    "created_by": 0,
    "updated": "2019-08-24T14:15:22Z",
    "updated_by": 0
  },
  "permission_level": "string",
  "variant": 0,
  "stage": 0,
  "stage_str": "string",
  "friendly_stage_str": "string",
  "file_name": "string",
  "project_names": "string",
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "inspection_type": "string",
  "zero_distance_mark": 0,
  "client_reviewed": "2019-08-24T14:15:22Z",
  "client_reviewed_by": "string",
  "ready_for_labeling": "string",
  "maximo_id": "string",
  "stage_components": "string",
  "num_errors": "string",
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "pano_offset": "string",
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "agency": "string",
  "account": "string",
  "account_sid": "string",
  "last_internal_reviewer": "string",
  "last_internal_review_date": "2019-08-24T14:15:22Z",
  "is_metashape": "string",
  "needs_qc": true,
  "qc_reviewed": true,
  "contractor": "string",
  "payout_bb": "string",
  "payout_bg": "string",
  "rotated_pano": "string",
  "training_mode": "string",
  "submittal": "string",
  "submittal_accepted": true,
  "submittal_status": "string",
  "pdf_exists": "string",
  "created": "2019-08-24T14:15:22Z",
  "created_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "updated": "2019-08-24T14:15:22Z",
  "updated_by": {
    "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z",
    "permission_level": "string",
    "projects": "string"
  },
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "meta": "string",
  "truck_info": {
    "property1": null,
    "property2": null
  },
  "key": "string",
  "tahoe_phase": "string",
  "auxillary_videos": {
    "property1": null,
    "property2": null
  },
  "autocode_complete_date": "string",
  "projects": "string",
  "sepehr_im_sorry": "string"
}

Video serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
inspection	Inspection	true	none	Inspection serializer
permission_level	string	true	read-only	none
variant	integer	false	none	none
stage	integer	true	read-only	none
stage_str	string	true	read-only	none
friendly_stage_str	string	true	read-only	none
file_name	string	true	read-only	none
project_names	string	true	read-only	none
encoding_location	string¦null	false	none	The S3 location of the encoding
encoding_location_exists	boolean¦null	false	none	none
encoded	boolean	false	none	none
video_format	integer	false	none	none
inspection_type	string	true	read-only	none
zero_distance_mark	number(double)¦null	false	none	none
client_reviewed	string(date-time)	true	read-only	none
client_reviewed_by	string	true	read-only	none
ready_for_labeling	string	true	read-only	none
maximo_id	string	true	read-only	none
stage_components	string	true	read-only	none
num_errors	string	true	read-only	none
number_of_frames	integer¦null	false	none	The number of frames in this video
is_selectable	boolean	false	none	none
pipe	integer	false	none	none
camera	integer	false	none	none
video_width	integer¦null	false	none	none
video_height	integer¦null	false	none	none
video_duration	number(double)¦null	false	none	The duration in seconds of the video
pano_offset	string	true	read-only	none
model_scale_factor	number(double)¦null	false	none	none
default_position_coords	object¦null	false	none	none
» additionalProperties	any	false	none	none
agency	string	true	read-only	none
account	string	true	read-only	none
account_sid	string	true	read-only	none
last_internal_reviewer	string	true	read-only	none
last_internal_review_date	string(date-time)	true	read-only	none
is_metashape	string	true	read-only	none
needs_qc	boolean	true	read-only	none
qc_reviewed	boolean	true	read-only	none
contractor	string¦null	false	none	none
payout_bb	string	true	read-only	none
payout_bg	string	true	read-only	none
rotated_pano	string	true	read-only	none
training_mode	string	true	read-only	none
submittal	string	true	read-only	none
submittal_accepted	boolean	true	read-only	none
submittal_status	string	true	read-only	none
pdf_exists	string	true	read-only	none
created	string(date-time)	true	read-only	none
created_by	AccountUser	true	none	AccountUser serializer
updated	string(date-time)	true	read-only	none
updated_by	AccountUser	true	none	AccountUser serializer
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none
meta	string	true	read-only	none
truck_info	object	true	read-only	none
» additionalProperties	any	false	none	none
key	string	true	read-only	none
tahoe_phase	string	true	read-only	none
auxillary_videos	object¦null	false	none	none
» additionalProperties	any	false	none	none
autocode_complete_date	string	true	read-only	none
projects	string	true	read-only	none
sepehr_im_sorry	string	true	read-only	none

Enumerated Values

Property	Value
variant	0
variant	1
variant	2
variant	3
variant	4
stage	0
stage	1
stage	2
stage	3
stage	4
stage	5
stage	11
stage	12
stage	13
stage	20
video_format	0
video_format	1
video_format	2
video_format	3
pipe	0
pipe	1
pipe	2
pipe	3
pipe	4
pipe	5
pipe	6
camera	0
camera	1
camera	2
camera	3
camera	4
camera	5
camera	6

VideoRead

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_name": "string",
  "inspection": "http://example.com",
  "path": "string",
  "stage": "string",
  "presigned_upload_data": {
    "property1": null,
    "property2": null
  },
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "http://example.com"
}

VideoRead serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
video_name	string¦null	true	read-only	none
inspection	string(uri)	true	read-only	none
path	string¦null	true	none	none
stage	string	true	read-only	none
presigned_upload_data	object	true	read-only	none
» additionalProperties	any	false	none	none
created	string(date-time)	true	read-only	none
updated	string(date-time)	true	read-only	none
created_by	string(uri)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none
account	string(uri)	true	read-only	none

VideoRequest

{
  "inspection": {
    "key": "string",
    "asset": "5a841cf2-3786-47ad-8831-36ccea9ed096",
    "owner": "534359f7-5407-4b19-ba92-c71c370022a5",
    "client": "95b7f642-4812-4c19-ba03-689f2fdf42f8",
    "reason": "operations-support",
    "city": "string",
    "city_area": "string",
    "country_area": "string",
    "country_code": "string",
    "postal_code": "string",
    "sorting_code": "string",
    "street_address": "string",
    "inspection_datetime": "2019-08-24T14:15:22Z",
    "inspection_type": "mainline",
    "distance": {
      "property1": null,
      "property2": null
    },
    "metadata": {
      "property1": null,
      "property2": null
    },
    "projects": [
      "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    ],
    "validate": true,
    "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
    "year_built": "string",
    "pipe_category": "string",
    "shape": "string",
    "direction": "string",
    "renewal_method": "string",
    "renewal_year": "string",
    "notes": "string",
    "result": "string",
    "location_type": "string",
    "purchase_order": "string",
    "work_order": "string",
    "weather": "string",
    "temperature": "string",
    "captured_by": "string",
    "certification": "string",
    "reviewed_by": "string",
    "capture_method": "string",
    "height": 0,
    "joint_distance": 0,
    "length_inspected": 0,
    "length": 0,
    "width": 0,
    "metric": true,
    "pre_cleaning": "string",
    "pre_cleaning_date": "string",
    "flow_condition": "string",
    "begin_rim_to_invert": 0,
    "begin_rim_to_grade": 0,
    "end_rim_to_invert": 0,
    "end_rim_to_grade": 0,
    "begin_access_point": "string",
    "end_access_point": "string"
  },
  "variant": 0,
  "encoding_location": "string",
  "encoding_location_exists": true,
  "encoded": true,
  "video_format": 0,
  "zero_distance_mark": 0,
  "number_of_frames": -2147483648,
  "is_selectable": true,
  "pipe": 0,
  "camera": 0,
  "video_width": -2147483648,
  "video_height": -2147483648,
  "video_duration": 0,
  "model_scale_factor": 0,
  "default_position_coords": {
    "property1": null,
    "property2": null
  },
  "contractor": "string",
  "created_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "updated_by": {
    "first_name": "string",
    "last_name": "string",
    "email": "user@example.com",
    "last_pioneer_login": "2019-08-24T14:15:22Z"
  },
  "auxillary_videos": {
    "property1": null,
    "property2": null
  }
}

VideoRequest serializer

Properties

Name	Type	Required	Restrictions	Description
inspection	InspectionRequest	true	none	none
variant	integer	false	none	none
encoding_location	string¦null	false	none	The S3 location of the encoding
encoding_location_exists	boolean¦null	false	none	none
encoded	boolean	false	none	none
video_format	integer	false	none	none
zero_distance_mark	number(double)¦null	false	none	none
number_of_frames	integer¦null	false	none	The number of frames in this video
is_selectable	boolean	false	none	none
pipe	integer	false	none	none
camera	integer	false	none	none
video_width	integer¦null	false	none	none
video_height	integer¦null	false	none	none
video_duration	number(double)¦null	false	none	The duration in seconds of the video
model_scale_factor	number(double)¦null	false	none	none
default_position_coords	object¦null	false	none	none
» additionalProperties	any	false	none	none
contractor	string¦null	false	none	none
created_by	AccountUserRequest	true	none	AccountUserRequest serializer
updated_by	AccountUserRequest	true	none	AccountUserRequest serializer
auxillary_videos	object¦null	false	none	none
» additionalProperties	any	false	none	none

Enumerated Values

Property	Value
variant	0
variant	1
variant	2
variant	3
variant	4
video_format	0
video_format	1
video_format	2
video_format	3
pipe	0
pipe	1
pipe	2
pipe	3
pipe	4
pipe	5
pipe	6
camera	0
camera	1
camera	2
camera	3
camera	4
camera	5
camera	6

VideoWrite

{
  "url": "http://example.com",
  "sid": "07f6f342-38f7-4271-ab8f-fab49fd96378",
  "video_name": "string",
  "payouts": "string",
  "path": "string",
  "presigned_upload_data": {
    "property1": null,
    "property2": null
  },
  "stage": 0,
  "created": "2019-08-24T14:15:22Z",
  "updated": "2019-08-24T14:15:22Z",
  "created_by": "http://example.com",
  "updated_by": "http://example.com",
  "deleted": "2019-08-24T14:15:22Z",
  "deleted_by": "http://example.com",
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

VideoWrite serializer

Properties

Name	Type	Required	Restrictions	Description
url	string(uri)	true	read-only	none
sid	string(uuid)	true	read-only	none
video_name	string¦null	true	read-only	none
payouts	string	false	none	none
path	string¦null	true	none	none
presigned_upload_data	object	true	read-only	none
» additionalProperties	any	false	none	none
stage	integer	false	none	none
created	string(date-time)	true	read-only	none
updated	string(date-time)	true	read-only	none
created_by	string(uri)	true	read-only	none
updated_by	string(uri)	true	read-only	none
deleted	string(date-time)	true	read-only	none
deleted_by	string(uri)	true	read-only	none
account	string(uuid)	false	none	none

Enumerated Values

Property	Value
stage	0
stage	1
stage	2
stage	3
stage	4
stage	5
stage	11
stage	12
stage	13
stage	20

VideoWriteRequest

{
  "inspection": "382346be-f083-4b69-b8d0-1c54192c69c9",
  "payouts": "string",
  "path": "string",
  "stage": 0,
  "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12"
}

VideoWriteRequest serializer

Properties

Name	Type	Required	Restrictions	Description
inspection	string(uuid)	true	write-only	none
payouts	string	false	none	none
path	string¦null	true	none	none
stage	integer	false	none	none
account	string(uuid)	false	none	none

Enumerated Values

Property	Value
stage	0
stage	1
stage	2
stage	3
stage	4
stage	5
stage	11
stage	12
stage	13
stage	20