DIGIT Specifications
PlatformUrbanHealthPublic FinanceSanitation
  • Specifications Overview
    • Standardisation Approach
  • Common Service Specs
    • Access Control
    • Analytics
    • Billing
    • Collection
    • Dashboard Analytics
    • Decision Support System Ingest
    • Document Controller
    • Employee
    • Encryption
    • Filestore
    • ID Generation
    • Inbox
    • Indexer
    • Master
    • Master Data Management
    • OTP
    • Payment Gateway
    • PDF Generation
    • URL Shortening
    • User
    • Workflow
  • Domain Service Specs
    • Attendance
    • Bank Account
    • Billing Calculator
    • Birth-Death
    • Building Plan Approval
    • Building Plan Calculator
    • Campaign
    • Campaign Delivery
    • Contracts
    • Estimates
    • eChallan
    • Facility
    • Faecal Sludge Management (FSM)
    • Fire NOC
    • Fire NOC Calculator
    • Household
    • Individual
    • Inventory
    • Land
    • Muster Roll
    • National Dashboard Ingest
    • No Objection Certificate
    • Organization
    • Planning
    • Product
    • Project
    • Property Registry
    • Property Tax Calculator
    • Public Grievance Redressal
    • Registration
    • Sewerage Connection
    • Stock
    • Supervision
    • Sync
    • Trade Licence
    • Trade Licence Calculator
    • User Events
    • Vehicle Registration
    • Vendor Registration
    • Water Connection
  • Archived-docs
    • DIGIT Urban Service Specs
      • Property Tax Service
        • Property Tax Taxonomy
        • Property Tax Data Model
        • Property Tax Service API
      • Public Grievance Redressal Service
        • Public Grievance Redressal Taxonomy
        • Public Grievance Redressal Data Model
        • Public Grievance Redressal Service API
      • Trade License Service
        • Trade License Taxonomy
        • Trade License Data Model
        • Trade License API
      • Fire NOC Service
        • Fire NOC Taxonomy
        • Fire NOC Data Model
        • Fire NOC API
      • Miscellaneous Collection Service
        • Miscellaneous Collections Taxonomy
        • Miscellaneous Collections Data Model
        • Miscellaneous Collection API
      • Online Building Plan Approval Service
        • Online Building Plan Approval Taxonomy
        • Online Building Plan Approval Data Model
        • Online Building Plan Approval Service API
      • Water & Sewerage Service
        • Water & Sewerage Taxonomy
        • Water Service Data Model
        • Sewerage Service Data Model
        • Water & Sewerage Service API
      • Birth & Death Service
        • Birth & Death Taxonomy
        • Birth & Death Data Model
        • Birth & Death Service API
    • DIGIT Public Finance Management Service Specs
      • iFIX Master Data Service API
      • Adapter Master Data Service API
      • mGramSeva iFIX Adapter Service API
      • iFIX Department Entity Service API
      • Fiscal Event API
    • DIGIT Health Service Specs
      • Health Service Data Model
      • Health Service API
    • DIGIT Sanitation Service Specs
      • Faecal Sludge Management Service
        • Faecal Sludge Management Data Model
        • Faecal Sludge Management Service API
Powered by GitBook

​All content on this page by eGov Foundation is licensed under a Creative Commons Attribution 4.0 International License.

On this page

Was this helpful?

Export as PDF
  1. Domain Service Specs

User Events

PreviousTrade Licence CalculatorNextVehicle Registration

Last updated 2 years ago

Was this helpful?

User Events System APIs

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

  • User Events System APIs
  • POSTsearch
  • POSTCreate new Event
  • POSTUpdate existing events
  • POSTupdatellt
  • POSTcount

search

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

Create new Event

post
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
      }
    }
  ]
}

Update existing events

post

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
      }
    }
  ]
}

updatellt

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

count

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