User Events

User Events System APIs

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

PreviousTrade Licence Calculator NextVehicle Registration

Last updated 1 year ago

Was this helpful?

search

post

/v1/events/_search

Query parameters

eventTypesstring[]

fromDateinteger · int64

idsstring[]

isCitizenSearchboolean

isEventsCountCallboolean

limitinteger · int32

namestring[]

offsetinteger · int32

postedBystring[]

recepientsstring[]

referenceIdsstring[]

rolesstring[]

sourcestring[]

statusstring[]

tenantIdstringrequired

toDateinteger · int64

useridsstring[]

Body

RequestInfoobject

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.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/user-event/v1/events/_search?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

{}

Create new Event

post

/v1/events/_create

Body

RequestInfoobject

Eventsobject[]

Array of events to be created in the system.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/user-event/v1/events/_create' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Events":[{"tenantId":"text","actions":{"tenantId":"text","auditDetails":{},"actionUrls":[{}]},"eventDetails":{"documents":[null]},"auditDetails":{},"status":"Active","toRoles":[null],"toUsers":[null]}]}'

201

400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Events": [
    {
      "tenantId": "text",
      "id": "text",
      "eventType": "text",
      "description": "text",
      "actions": {
        "tenantId": "text",
        "auditDetails": {},
        "actionUrls": [
          {}
        ]
      },
      "eventDetails": {
        "documents": [
          null
        ]
      },
      "auditDetails": {},
      "status": "Active",
      "toRoles": [
        "text"
      ],
      "toUsers": [
        "text"
      ]
    }
  ]
}

ReponseInfo with Events created successfully

Update existing events

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

post

/v1/events/_update

Body

RequestInfoobject

Eventsobject[]

Array of events to be created in the system.

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/user-event/v1/events/_update' \
  --header 'Content-Type: */*' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}},"Events":[{"tenantId":"text","actions":{"tenantId":"text","auditDetails":{},"actionUrls":[{}]},"eventDetails":{"documents":[null]},"auditDetails":{},"status":"Active","toRoles":[null],"toUsers":[null]}]}'

201

400

{
  "ResponseInfo": {
    "apiId": "text",
    "ver": "text",
    "ts": 1,
    "resMsgId": "text",
    "msgId": "text",
    "status": "SUCCESSFUL"
  },
  "Events": [
    {
      "tenantId": "text",
      "id": "text",
      "eventType": "text",
      "description": "text",
      "actions": {
        "tenantId": "text",
        "auditDetails": {},
        "actionUrls": [
          {}
        ]
      },
      "eventDetails": {
        "documents": [
          null
        ]
      },
      "auditDetails": {},
      "status": "Active",
      "toRoles": [
        "text"
      ],
      "toUsers": [
        "text"
      ]
    }
  ]
}

ReponseInfo with Events updated sudcessfully

updatellt

post

/v1/events/lat/_update

Body

RequestInfoobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/user-event/v1/events/lat/_update' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

{}

count

post

/v1/events/notifications/_count

Query parameters

eventTypesstring[]

fromDateinteger · int64

idsstring[]

isCitizenSearchboolean

isEventsCountCallboolean

limitinteger · int32

namestring[]

offsetinteger · int32

postedBystring[]

recepientsstring[]

referenceIdsstring[]

rolesstring[]

sourcestring[]

statusstring[]

tenantIdstringrequired

toDateinteger · int64

useridsstring[]

Body

RequestInfoobject

Responses

*/*

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/user-event/v1/events/notifications/_count?tenantId=text' \
  --header 'Content-Type: application/json' \
  --data '{"RequestInfo":{"apiId":"text","ver":"text","ts":1,"action":"text","msgId":"text","userInfo":{"tenantId":"text","userName":"text","primaryrole":[{"name":"text"}],"additionalroles":[{"tenantId":"text","roles":[{"name":"text"}]}]}}}'

200

201

401

403

404

{}