Skip to content

API reference / RivetIT

Outtakes

GET /tickets/{id}/outtakes Bearer token or API key

List device-outtake (pickup) forms for a ticket

Parameters

NameInTypeDescription
idrequiredpathinteger

Example request

curl "https://YOUR-HOST/api/v1/tickets/1/outtakes" \
  -H "Authorization: Bearer $TOKEN"
import requests

response = requests.get(
    "https://YOUR-HOST/api/v1/tickets/1/outtakes",
    headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tickets/1/outtakes", {
  method: "GET",
  headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tickets/1/outtakes");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);

Responses

200Outtake summaries

FieldTypeDescription
[]id integer
[]sign_token string
[]notes string
[]created_by string
[]created_at string
[]signed_name string
[]signed_at string
[]signed boolean
Example response
json
[
    {
        "id": 1,
        "sign_token": "string",
        "notes": "string",
        "created_by": "string",
        "created_at": "string",
        "signed_name": "string",
        "signed_at": "string",
        "signed": true
    }
]

403Authenticated but not permitted

FieldTypeDescription
error string
POST /tickets/{id}/outtake Bearer token or API key

Create a device-outtake form on a ticket

Parameters

NameInTypeDescription
idrequiredpathinteger

Example request

curl -X POST "https://YOUR-HOST/api/v1/tickets/1/outtake" \
  -H "Authorization: Bearer $TOKEN"
import requests

response = requests.post(
    "https://YOUR-HOST/api/v1/tickets/1/outtake",
    headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/tickets/1/outtake", {
  method: "POST",
  headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/tickets/1/outtake");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);

Responses

201Outtake created

FieldTypeDescription
id integer
Example response
json
{
    "id": 1
}
GET /outtakes/{id} Bearer token or API key

Outtake form detail

Parameters

NameInTypeDescription
idrequiredpathinteger

Example request

curl "https://YOUR-HOST/api/v1/outtakes/1" \
  -H "Authorization: Bearer $TOKEN"
import requests

response = requests.get(
    "https://YOUR-HOST/api/v1/outtakes/1",
    headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/outtakes/1", {
  method: "GET",
  headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/outtakes/1");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);

Responses

200Outtake detail

FieldTypeDescription
id integer
sign_token string
notes string
created_by string
created_at string
signed_name string
signed_at string
signed boolean
ticket_subject string
client string
contact_name string
Example response
json
{
    "id": 1,
    "sign_token": "string",
    "notes": "string",
    "created_by": "string",
    "created_at": "string",
    "signed_name": "string",
    "signed_at": "string",
    "signed": true,
    "ticket_subject": "string",
    "client": "string",
    "contact_name": "string"
}

403Authenticated but not permitted

FieldTypeDescription
error string

404Resource not found

FieldTypeDescription
error string
DELETE /outtakes/{id} Bearer token or API key

Delete an outtake form

Parameters

NameInTypeDescription
idrequiredpathinteger

Example request

curl -X DELETE "https://YOUR-HOST/api/v1/outtakes/1" \
  -H "Authorization: Bearer $TOKEN"
import requests

response = requests.delete(
    "https://YOUR-HOST/api/v1/outtakes/1",
    headers={"Authorization": f"Bearer {TOKEN}"},
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/outtakes/1", {
  method: "DELETE",
  headers: { "Authorization": `Bearer ${TOKEN}` },
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/outtakes/1");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "DELETE",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token"],
]);
$data = json_decode(curl_exec($ch), true);

Responses

200Success

FieldTypeDescription
ok boolean
Example response
json
{
    "ok": true
}
POST /outtakes/{id}/sign Bearer token or API key

Sign an outtake form

Parameters

NameInTypeDescription
idrequiredpathinteger

Request body (application/json, required)

FieldTypeDescription
signed_namerequired string
signature string data:image/png;base64,... (optional)

Example request

curl -X POST "https://YOUR-HOST/api/v1/outtakes/1/sign" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"signed_name":"string","signature":"string"}'
import requests

response = requests.post(
    "https://YOUR-HOST/api/v1/outtakes/1/sign",
    headers={"Authorization": f"Bearer {TOKEN}"},
    json={
        "signed_name": "string",
        "signature": "string"
    },
)
print(response.json())
const response = await fetch("https://YOUR-HOST/api/v1/outtakes/1/sign", {
  method: "POST",
  headers: { "Authorization": `Bearer ${TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
      "signed_name": "string",
      "signature": "string"
  }),
});
const data = await response.json();
$ch = curl_init("https://YOUR-HOST/api/v1/outtakes/1/sign");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_HTTPHEADER => ["Authorization: Bearer $token", "Content-Type: application/json"],
    CURLOPT_POSTFIELDS => '{"signed_name":"string","signature":"string"}',
]);
$data = json_decode(curl_exec($ch), true);

Responses

200Success

FieldTypeDescription
ok boolean
Example response
json
{
    "ok": true
}

400Bad request

FieldTypeDescription
error string