Soundshot Plugin

Create soundshot

POST

http://localhost:3000/api/plugins/soundshots

This API Endpoint allows uploading the soundshot file along with related metadata.

Create soundshot

curl -X POST 'http://localhost:3000/api/plugins/soundshots' \
  --form-string 'isActive=true' \
  --form-string 'isArchived=false' \
  --form-string 'archivedAt=2018-11-21T06:20:32.232Z' \
  --form-string 'tenantId=string' \
  --form-string 'organizationId=string' \
  --form-string 'name=string' \
  --form-string 'storageProvider=LOCAL' \
  --form-string 'fullUrl=string' \
  --form-string 'size=0' \
  --form-string 'channels=0' \
  --form-string 'rate=0' \
  --form-string 'duration=0' \
  --form-string 'timeSlotId=string' \
  --form-string 'uploadedById=string' \
  --form-string 'userId=string'

const form = new FormData();
form.append('isActive', 'true');
form.append('isArchived', 'false');
form.append('archivedAt', '2018-11-21T06:20:32.232Z');
form.append('tenantId', 'string');
form.append('organizationId', 'string');
form.append('name', 'string');
form.append('storageProvider', 'LOCAL');
form.append('fullUrl', 'string');
form.append('size', '0');
form.append('channels', '0');
form.append('rate', '0');
form.append('duration', '0');
form.append('timeSlotId', 'string');
form.append('uploadedById', 'string');
form.append('userId', 'string');
const response = await fetch('http://localhost:3000/api/plugins/soundshots', {
  method: 'POST',
  headers: {},
  body: form,
});
console.log(await response.text());

import requests
from contextlib import ExitStack

with ExitStack() as stack:
    files = [
        ('isActive', (None, 'true')),
        ('isArchived', (None, 'false')),
        ('archivedAt', (None, '2018-11-21T06:20:32.232Z')),
        ('tenantId', (None, 'string')),
        ('organizationId', (None, 'string')),
        ('name', (None, 'string')),
        ('storageProvider', (None, 'LOCAL')),
        ('fullUrl', (None, 'string')),
        ('size', (None, '0')),
        ('channels', (None, '0')),
        ('rate', (None, '0')),
        ('duration', (None, '0')),
        ('timeSlotId', (None, 'string')),
        ('uploadedById', (None, 'string')),
        ('userId', (None, 'string')),
    ]
    response = requests.request('POST', 'http://localhost:3000/api/plugins/soundshots', headers={}, files=files)
    print(response.text)

Request Body

{
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "name": "string",
  "storageProvider": "LOCAL",
  "fullUrl": "string",
  "size": 0,
  "channels": 0,
  "rate": 0,
  "duration": 0,
  "timeSlotId": "string",
  "uploadedById": "string",
  "userId": "string"
}

201

{
  "deletedAt": "2018-11-21T06:20:32.232Z",
  "createdAt": "2018-11-21T06:20:32.232Z",
  "updatedAt": "2018-11-21T06:20:32.232Z",
  "id": "string",
  "isActive": true,
  "isArchived": false,
  "archivedAt": "2018-11-21T06:20:32.232Z",
  "tenantId": "string",
  "organizationId": "string",
  "name": "string",
  "fileKey": "string",
  "storageProvider": "LOCAL",
  "fullUrl": "string",
  "size": 0,
  "channels": 0,
  "rate": 0,
  "duration": 0,
  "timeSlotId": "string",
  "uploadedById": "string",
  "userId": "string"
}

Body

multipart/form-data

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

Name of the soundshot

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEANrequired

recordedAttimestamptz

Date when the soundshot was recorded

fullUrlstring

Full URL to access the soundshot

sizenumber

Size of the soundshot file in bytes

channelsnumber

Sound channels of the soundshot file

ratenumber

Sound rate of the soundshot file

durationnumber

Duration of the soundshot file in seconds

timeSlotIdstring

The UUID of the associated TimeSlot

uploadedByIdstring

The UUID of the associated Employee

userIdstring

The UUID of the associated User

Response

201CreatedSoundshot

Soundshot created successfully.

Response fields application/json

deletedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

createdAtstring<date-time>

The creation timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

updatedAtstring<date-time>

The last update timestamp of the entity.

Example

2018-11-21T06:20:32.232Z

idstring

isActivebooleantrue

isArchivedbooleanfalse

archivedAtstring<date-time>

Example

2018-11-21T06:20:32.232Z

tenantIdstring

organizationIdstring

namestringrequired

Name of the soundshot

fileKeystring

Soundshot file path or identifier

storageProviderstringLOCALS3WASABICLOUDINARYDIGITALOCEANrequired

recordedAttimestamptz

Date when the soundshot was recorded

fullUrlstring

Full URL to access the soundshot

sizenumber

Size of the soundshot file in bytes

channelsnumber

Sound channels of the soundshot file

ratenumber

Sound rate of the soundshot file

durationnumber

Duration of the soundshot file in seconds

timeSlotIdstring

The UUID of the associated TimeSlot

uploadedByIdstring

The UUID of the associated Employee

userIdstring

The UUID of the associated User

400Bad Request

Invalid input provided. Check the response body for error details.

Stack Overflow Website Demo