[Internal] Prism

These endpoints are to create, read, update, delete Prism business info.

[Internal] Get Prism Properties

GET prism/business-infos/

Note

Authorized Roles: root, manager, backend

Get property values of Prism for the current database.

Response JSON Object
  • warnings (list-of-string) – Optional. List of warnings

EXAMPLE RESPONSE
  {
      "name": "prism-test-name",
      "category": ["family", "sci-fi", "anime"],
      "logo": "http://img.test/logo-test.jpg"
  }

Errors:

  • NotFoundError with error name ITEM_NOT_FOUND if no prism config doesn’t exist

[Internal] Create or Partial Update Prism Properties

POST prism/business-infos/

Note

Authorized Roles: root, manager, backend

Create property values for Prism, or partial update them if already exists for the current database.

EXAMPLE QUERY BODY
  {
      "name": "prism-test-name",
      "category": ["family", "sci-fi", "anime"],
      "logo": "http://img.test/logo-test.jpg"
  }

Errors:

  • WrongData with error name WRONG_DATA_TYPE if the properties are invalid

[Internal] Delete Prism Properties

DELETE prism/business-infos/

Note

Authorized Roles: root, manager, backend

Delete the property values of Prism for the current database.