Localisation

Create messages for different locale

post

Create messages for different locale.

Body

RequestInfoanyoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

messagesobject[]optional

tenantIdstringoptional

Unique tenant id.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/_create' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": [
      {
        "apiId": "text",
        "ver": "text",
        "ts": 1,
        "action": "text",
        "did": "text",
        "key": "text",
        "msgId": "text",
        "requesterId": "text",
        "authToken": "text"
      }
    ],
    "messages": [
      {
        "code": "text",
        "message": "text",
        "module": "text",
        "locale": "text"
      }
    ],
    "tenantId": "text"
  }'

200

400

200

{}

MessagesResponse as object

update messages for different locale

post

update messages for different locale.

Body

RequestInfoanyoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

localestringoptional

Locale of message.

tenantIdstringoptional

Tenant of message.

modulestringoptional

Module of message..

messagesobject[]optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/_update' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": [
      {
        "apiId": "text",
        "ver": "text",
        "ts": 1,
        "action": "text",
        "did": "text",
        "key": "text",
        "msgId": "text",
        "requesterId": "text",
        "authToken": "text"
      }
    ],
    "locale": "text",
    "tenantId": "text",
    "module": "text",
    "messages": [
      {
        "code": "text",
        "message": "text"
      }
    ]
  }'

200

400

200

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

MessagesResponse as object

delete messages

post

delete messages

Body

RequestInfoanyoptional

RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo as a part of the request body to carry this meta information. Some of this information will be returned back from the server as part of the ResponseInfo in the response body to ensure correlation.

tenantIdstringoptional

tenant id of message.

messagesobject[]optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/_delete' \
  --header 'Content-Type: application/json' \
  --data '{
    "RequestInfo": [
      {
        "apiId": "text",
        "ver": "text",
        "ts": 1,
        "action": "text",
        "did": "text",
        "key": "text",
        "msgId": "text",
        "requesterId": "text",
        "authToken": "text"
      }
    ],
    "tenantId": "text",
    "messages": [
      {
        "code": "text",
        "message": "text",
        "module": "text",
        "locale": "text"
      }
    ]
  }'

200

400

200

{
  "successful": true,
  "responseInfo": {}
}

MessagesResponse as object

Get messages by locale and tenantId

post

Returns all the messages by locale and tenantId.

Query parameters

tenantIdanyrequired

Unique id for ulb.

localeanyrequired

locale for message.

moduleanyrequired

Module name for message

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/_search'

200

400

200

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

An array of Messages