Demo

GET

Retrieves all demo accounts.

GET/demo

Query parameters

Response

200403

Demo accounts retrieved successfully

Body

application/json

countnumber

Example: 10

usersarray of object

Request

JavaScriptCurlPython

const response = await fetch('/demo', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200403

{
  "count": 10,
  "users": [
    {
      "id": 1,
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe",
      "previewLink": "encrypted_preview_link"
    }
  ]
}

POST

Creates a new demo account.

POST/demo/account

Body

application/json

Demo account creation data

emailstring

Example: "[e-mail]"

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

passwordnullable string

Example: "securePassword123"

Response

201400403

Demo account created successfully

Body

application/json

idnumber

Example: 1

emailstring

Example: "[e-mail]"

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

previewLinkstring

Example: "encrypted_preview_link"

Request

JavaScriptCurlPython

const response = await fetch('/demo/account', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400403

{
  "id": 1,
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "previewLink": "encrypted_preview_link"
}

Validates a preview link by decrypting the hash.

POST/demo/preview

Response

200400

Preview link validated successfully

Body

application/json

string

Example: "[e-mail];password"

Request

JavaScriptCurlPython

const response = await fetch('/demo/preview', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400

[e-mail];password

Resets a demo account by its ID.

POST/demo/account/reset/{id}

Path parameters

id*number

Response

200400403404

Demo account reset successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/demo/account/reset/{id}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "message": "Demo account reset successfully",
  "description": "<p>The demo account has been reset successfully.</p>",
  "__$markdownParsed": true
}

Uploads a file to the S3 bucket.

POST/action-demo-files

Body

application/json

File upload data

filestring (binary)

Response

200400

File uploaded successfully

Body

application/json

string

Example: "formatted_file_name.jpg"

Request

JavaScriptCurlPython

const response = await fetch('/action-demo-files', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200400

formatted_file_name.jpg

PATCH

Edits an existing demo account.

PATCH/demo/account/{id}

Path parameters

id*number

Body

application/json

Demo account edit data

email*string

Email of the demo user

Example: "[e-mail]"

firstName*string

First name of the demo user

Example: "John"

lastName*string

Last name of the demo user

Example: "Doe"

password*nullable string

Password for the demo user

Example: "securePassword123"

Response

200400403

Demo account edited successfully

Body

application/json

idnumber

Example: 1

emailstring

Example: "[e-mail]"

firstNamestring

Example: "John"

lastNamestring

Example: "Doe"

previewLinkstring

Example: "encrypted_preview_link"

Request

JavaScriptCurlPython

const response = await fetch('/demo/account/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]",
      "firstName": "John",
      "lastName": "Doe",
      "password": "securePassword123"
    }),
});
const data = await response.json();

Response

200400403

{
  "id": 1,
  "email": "[e-mail]",
  "firstName": "John",
  "lastName": "Doe",
  "previewLink": "encrypted_preview_link"
}

DELETE

Deletes a demo account by its ID.

DELETE/demo/account/{id}

Path parameters

id*number

Response

200400403404

Demo account deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/demo/account/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200400403404

{
  "message": "Demo account deleted successfully",
  "description": "<p>The demo account has been deleted successfully.</p>",
  "__$markdownParsed": true
}

Deletes a file by its name from the S3 bucket.

DELETE/action-demo-files/{fileName}

Path parameters

fileName*string

Response

200404500

File deleted successfully

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('/action-demo-files/{fileName}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200404500

{
  "message": "File deleted successfully",
  "description": "<p>The file has been deleted successfully.</p>",
  "__$markdownParsed": true
}