User Events
User Events System APIs
APIs to manage - create, update, or search events-related information.
Query parameters
eventTypesstring[]Optional
fromDateinteger · int64Optional
idsstring[]Optional
isCitizenSearchbooleanOptional
isEventsCountCallbooleanOptional
limitinteger · int32Optional
namestring[]Optional
offsetinteger · int32Optional
postedBystring[]Optional
recepientsstring[]Optional
referenceIdsstring[]Optional
rolesstring[]Optional
sourcestring[]Optional
statusstring[]Optional
tenantIdstringRequired
toDateinteger · int64Optional
useridsstring[]Optional
Body
Responses
200
OK
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /user-event/v1/events/_search?tenantId=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 446
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}
}{}Body
Contract class to receive request. Array of Event items are used in case of create and update
Responses
201
ReponseInfo with Events created successfully
*/*
400
Events creation failed
*/*
post
POST /user-event/v1/events/_create HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 987
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"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",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"eventDetails": {
"fromDate": "text",
"toDate": "text",
"latitude": 1,
"longitude": 1,
"documents": [
"text"
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"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",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"eventDetails": {
"fromDate": "text",
"toDate": "text",
"latitude": 1,
"longitude": 1,
"documents": [
"text"
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}This API is used to update existing events in the system.
Body
Contract class to receive request. Array of Event items are used in case of create and update
Responses
201
ReponseInfo with Events updated sudcessfully
*/*
400
Events(s) updation failed
*/*
post
POST /user-event/v1/events/_update HTTP/1.1
Host:
Content-Type: */*
Accept: */*
Content-Length: 987
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
},
"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",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"eventDetails": {
"fromDate": "text",
"toDate": "text",
"latitude": 1,
"longitude": 1,
"documents": [
"text"
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}{
"ResponseInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"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",
"createdTime": 1,
"lastModifiedTime": 1
}
},
"eventDetails": {
"fromDate": "text",
"toDate": "text",
"latitude": 1,
"longitude": 1,
"documents": [
"text"
]
},
"auditDetails": {
"createdBy": "text",
"lastModifiedBy": "text",
"createdTime": 1,
"lastModifiedTime": 1
}
}
]
}Body
Responses
200
OK
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /user-event/v1/events/lat/_update HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 446
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}
}{}Query parameters
eventTypesstring[]Optional
fromDateinteger · int64Optional
idsstring[]Optional
isCitizenSearchbooleanOptional
isEventsCountCallbooleanOptional
limitinteger · int32Optional
namestring[]Optional
offsetinteger · int32Optional
postedBystring[]Optional
recepientsstring[]Optional
referenceIdsstring[]Optional
rolesstring[]Optional
sourcestring[]Optional
statusstring[]Optional
tenantIdstringRequired
toDateinteger · int64Optional
useridsstring[]Optional
Body
Responses
200
OK
*/*
Responseobject
201
Created
401
Unauthorized
403
Forbidden
404
Not Found
post
POST /user-event/v1/events/notifications/_count?tenantId=text HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 446
{
"RequestInfo": {
"apiId": "text",
"ver": "text",
"ts": 1,
"action": "text",
"did": "text",
"key": "text",
"msgId": "text",
"requesterId": "text",
"authToken": "text",
"userInfo": {
"tenantId": "text",
"uuid": "text",
"userName": "text",
"password": "text",
"idToken": "text",
"mobile": "text",
"email": "text",
"primaryrole": [
{
"name": "text",
"code": "text",
"description": "text"
}
],
"additionalroles": [
{
"tenantId": "text",
"roles": [
{
"name": "text",
"code": "text",
"description": "text"
}
]
}
]
}
}
}{}Last updated
Was this helpful?