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.

tenantIdstringOptional

Unique tenant id.

Responses
200
MessagesResponse as object
application/json
Responseobject
post
POST /messages/v1/_create HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "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"
}
{}

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..

Responses
200
MessagesResponse as object
application/json
post
POST /messages/v1/_update HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "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"
    }
  ]
}
{
  "messages": [
    {
      "code": "text",
      "message": "text",
      "module": "text",
      "locale": "text"
    }
  ],
  "responseInfo": {}
}

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.

Responses
200
MessagesResponse as object
application/json
post
POST /messages/v1/_delete HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 247

{
  "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"
    }
  ]
}
{
  "successful": true,
  "responseInfo": {}
}

Get messages by locale and tenantId

post

Returns all the messages by locale and tenantId.

Query parameters
tenantIdstring · varcharRequired

Unique id for ulb.

localestring · varcharRequired

locale for message.

modulestring · varcharRequired

Module name for message

Responses
200
An array of Messages
application/json
post
POST /messages/v1/_search?tenantId=text&locale=text&module=text HTTP/1.1
Host: 
Accept: */*
[
  {
    "messages": [
      {
        "code": "text",
        "message": "text",
        "module": "text",
        "locale": "text"
      }
    ],
    "responseInfo": {}
  }
]

Last updated

Was this helpful?