mGramSeva iFIX Adapter Service API

Push the fiscal event on iFix

Push the fiscal event on iFix

POSThttps://iFix.org/event/v1/_push

Body

application/json

Details for the events + RequestHeader (meta data of the API).

requestHeader*RequestHeader (object)

RequestHeader should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestHeader 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 ResponseHeader in the response body to ensure correlation.

event*Event (object)

Captures the finacial event attributes

Response

202400500

Request has been accepted for processing

Body

*/*

responseInfoResponseHeader (object)

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

eventarray of Event (object)

Request

JavaScriptCurlPython

const response = await fetch('https://iFix.org/event/v1/_push', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestHeader": {},
      "event": {
        "tenantId": "text",
        "eventType": "DEMAND",
        "entity": []
      }
    }),
});
const data = await response.json();

Response

202400500

{
  "responseInfo": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "event": [
    {
      "id": "text",
      "tenantId": "text",
      "eventType": "DEMAND",
      "entity": [],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}