iFIX Department Entity Service API

Create/Add new department on iFix for a tenant

Create/Add new department on iFix for a tenant

POSThttps://<server-address>/fiscal-event-service/department/v1/_create

Body

application/json

Details for the new department + 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.

department*Department (object)

Captures the department attributes

Response

202400500

Request has been accepted for processing

Body

*/*

responseHeaderResponseHeader (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.

departmentarray of Department (object)

Request

JavaScriptCurlPython

const response = await fetch('https://<server-address>/fiscal-event-service/department/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "department": {
        "code": "text",
        "name": "text",
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

202400500

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "department": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "name": "text",
      "isNodal": false,
      "parent": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the list departments.

Based on the criteria get the list of departments.

POSThttps://<server-address>/fiscal-event-service/department/v1/_search

Body

application/json

Details for the department search criteria + 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.

criteria*DepartmentSearchCriteria (object)

The object contains all the search criteria of the Department

Response

200400500

Successful response

Body

*/*

responseHeaderResponseHeader (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.

departmentarray of Department (object)

Request

JavaScriptCurlPython

const response = await fetch('https://<server-address>/fiscal-event-service/department/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

200400500

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "department": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "name": "text",
      "isNodal": false,
      "parent": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Create/Add new Expenditure on iFix for a tenant

Create/Add new Expenditure on iFix for a tenant

POSThttps://<server-address>/fiscal-event-service/expenditure/v1/_create

Body

application/json

Details for the new Expenditure + 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.

expenditure*Expenditure (object)

Captures the Expenditure attributes

Response

202400500

Request has been accepted for processing

Body

*/*

responseHeaderResponseHeader (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.

Expenditurearray of Expenditure (object)

Request

JavaScriptCurlPython

const response = await fetch('https://<server-address>/fiscal-event-service/expenditure/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "expenditure": {
        "code": "text",
        "name": "text",
        "tenantId": "text",
        "type": "Scheme"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

202400500

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "Expenditure": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "name": "text",
      "type": "Scheme",
      "departmentId": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the list Expenditure.

Based on the criteria get the list of Expenditure.

POSThttps://<server-address>/fiscal-event-service/expenditure/v1/_search

Body

application/json

Details for the Expenditure search criteria + 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.

criteria*ExpenditureSearchCriteria (object)

The object contains all the search criteria of the Expenditure

Response

200400500

Successful response

Body

*/*

responseHeaderResponseHeader (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.

Expenditurearray of Expenditure (object)

Request

JavaScriptCurlPython

const response = await fetch('https://<server-address>/fiscal-event-service/expenditure/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

200400500

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "Expenditure": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "name": "text",
      "type": "Scheme",
      "departmentId": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Create/Add new project on iFix for a tenant

Create/Add new project on iFix for a tenant

POSThttps://<server-address>/fiscal-event-service/project/v1/_create

Body

application/json

Details for the new Project + 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.

project*object

Response

202400500

Request has been accepted for processing

Body

*/*

responseHeaderResponseHeader (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.

projectarray of Project (object)

Request

JavaScriptCurlPython

const response = await fetch('https://<server-address>/fiscal-event-service/project/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": {},
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

202400500

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "project": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "name": "text",
      "expenditureId": "text",
      "departmentEntityIds": [
        "text"
      ],
      "locationIds": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Update existing project on iFix for a tenant

Update existing project on iFix for a tenant

POSThttps://<server-address>/fiscal-event-service/project/v1/_update

Body

application/json

Details for the update Project + 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.

project*all of

Response

202400500

Request has been accepted for processing

Body

*/*

responseHeaderResponseHeader (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.

projectarray of Project (object)

Request

JavaScriptCurlPython

const response = await fetch('https://<server-address>/fiscal-event-service/project/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "project": {},
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

202400500

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "project": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "name": "text",
      "expenditureId": "text",
      "departmentEntityIds": [
        "text"
      ],
      "locationIds": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the list Project.

Based on the criteria get the list of Project.

POSThttps://<server-address>/fiscal-event-service/project/v1/_search

Body

application/json

Details for the Project search criteria + 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.

criteria*ProjectSearchCriteria (object)

The object contains all the search criteria of the Project

Response

200400500

Successful response

Body

*/*

responseHeaderResponseHeader (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.

projectarray of Project (object)

Request

JavaScriptCurlPython

const response = await fetch('https://<server-address>/fiscal-event-service/project/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

200400500

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "project": [
    {
      "id": "text",
      "tenantId": "text",
      "code": "text",
      "name": "text",
      "expenditureId": "text",
      "departmentEntityIds": [
        "text"
      ],
      "locationIds": [
        "text"
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}