User Events

User Events System APIs

APIs to manage - create, update, or search events-related information.

search

POST/user-event/v1/events/_search

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('/user-event/v1/events/_search?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Create new Event

POST/user-event/v1/events/_create

Body

*/*

Details for the new Events + RequestInfo meta data.

RequestInfoRequestInfo (object)

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.

Eventsarray of Event (object)

Array of events to be created in the system.

Response

201400

ReponseInfo with Events created successfully

Body

*/*

ResponseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Eventsarray of Event (object)

Array of events to be received from the system.

Request

JavaScriptCurlPython

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

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Events": [
    {
      "tenantId": "text",
      "id": "text",
      "eventType": "text",
      "description": "text",
      "status": "Active",
      "toRoles": [
        "text"
      ],
      "toUsers": [
        "text"
      ],
      "actions": {
        "tenantId": "text",
        "id": "text",
        "eventId": "text",
        "actionUrls": [
          {
            "actionUrl": "text",
            "code": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "eventDetails": {
        "fromDate": "text",
        "toDate": "text",
        "latitude": 0,
        "longitude": 0,
        "documents": [
          "text"
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Update existing events

This API is used to update existing events in the system.

POST/user-event/v1/events/_update

Body

*/*

Details for the new Events + RequestInfo meta data.

RequestInfoRequestInfo (object)

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.

Eventsarray of Event (object)

Array of events to be created in the system.

Response

201400

ReponseInfo with Events updated sudcessfully

Body

*/*

ResponseInfoResponseInfo_2 (object)

ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.

Eventsarray of Event (object)

Array of events to be received from the system.

Request

JavaScriptCurlPython

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

Response

201400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Events": [
    {
      "tenantId": "text",
      "id": "text",
      "eventType": "text",
      "description": "text",
      "status": "Active",
      "toRoles": [
        "text"
      ],
      "toUsers": [
        "text"
      ],
      "actions": {
        "tenantId": "text",
        "id": "text",
        "eventId": "text",
        "actionUrls": [
          {
            "actionUrl": "text",
            "code": "text"
          }
        ],
        "auditDetails": {
          "createdBy": "text",
          "lastModifiedBy": "text"
        }
      },
      "eventDetails": {
        "fromDate": "text",
        "toDate": "text",
        "latitude": 0,
        "longitude": 0,
        "documents": [
          "text"
        ]
      },
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

updatellt

POST/user-event/v1/events/lat/_update

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

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

count

POST/user-event/v1/events/notifications/_count

Query parameters

Body

application/json

RequestInfoRequestInfo (object)

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.

Response

200201401403404

OK

Body

*/*

object

Request

JavaScriptCurlPython

const response = await fetch('/user-event/v1/events/notifications/_count?tenantId=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();