Localisation | DIGIT Core

Create messages for different locale

Create messages for different locale.

POST/messages/v1/_create

Body

Message Object to create messages for different locale

RequestInfoany

messagesarray of Message (object)

tenantIdstring

Unique tenant id.

Response

MessagesResponse as object

Body

object

Request

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

update messages for different locale

update messages for different locale.

POST/messages/v1/_update

Body

Message Object to update messages for different locale

RequestInfoany

localestring

Locale of message.

tenantIdstring

Tenant of message.

modulestring

Module of message..

messagesarray of UpdateMessage (object)

Response

MessagesResponse as object

Body

messagesarray of Message (object)

responseInfoobject

Request

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

Response

{
  "messages": [
    {
      "code": "text",
      "message": "text",
      "module": "text",
      "locale": "text"
    }
  ]
}

delete messages

POST/messages/v1/_delete

Body

Message Object to update messages for different locale

RequestInfoany

tenantIdstring

tenant id of message.

messagesarray of Message (object)

Response

MessagesResponse as object

Body

successfulboolean

responseInfoobject

Request

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

Response

{
  "successful": false
}

Get messages by locale and tenantId

Returns all the messages by locale and tenantId.

POST/messages/v1/_search

Query parameters

Response

An array of Messages

Body

messagesarray of Message (object)

responseInfoobject

Request

const response = await fetch('/messages/v1/_search?tenantId=text&locale=text&module=text', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

[
  {
    "messages": [
      {
        "code": "text",
        "message": "text",
        "module": "text",
        "locale": "text"
      }
    ]
  }
]