APIs

iFIX Master Data APIs

Create/Add new COA on iFix for a tenant

Create/Add new COA on iFix for a tenant

POST/chartOfAccount/v1/_create

Body

application/json

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

chartOfAccountChartOfAccount (object)

Captures the COA data as map

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.

chartOfAccountsarray of ChartOfAccount (object)

Request

JavaScriptCurl

const response = await fetch('/chartOfAccount/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "chartOfAccounts": [
    {
      "id": "text",
      "coaCode": "text",
      "tenantId": "text",
      "majorHead": "text",
      "majorHeadName": "text",
      "majorHeadType": "Revenue",
      "subMajorHead": "text",
      "subMajorHeadName": "text",
      "minorHead": "text",
      "minorHeadName": "text",
      "subHead": "text",
      "subHeadName": "text",
      "groupHead": "text",
      "groupHeadName": "text",
      "objectHead": "text",
      "objectHeadName": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get the list COA.

Based on the criteria get the list of COA.

POST/chartOfAccount/v1/_search

Body

application/json

RequestHeader meta data.

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*COASearchCriteria (object)

The object contains all the search criteria of the fund

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.

chartOfAccountsarray of ChartOfAccount (object)

Request

JavaScriptCurl

const response = await fetch('/chartOfAccount/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "chartOfAccounts": [
    {
      "id": "text",
      "coaCode": "text",
      "tenantId": "text",
      "majorHead": "text",
      "majorHeadName": "text",
      "majorHeadType": "Revenue",
      "subMajorHead": "text",
      "subMajorHeadName": "text",
      "minorHead": "text",
      "minorHeadName": "text",
      "subHead": "text",
      "subHeadName": "text",
      "groupHead": "text",
      "groupHeadName": "text",
      "objectHead": "text",
      "objectHeadName": "text",
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

iFIX Department Entity Service APIs

Create/Add new Department Entity on iFix for a tenant

Create/Add new Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_create

Body

application/json

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

DepartmentEntityobject

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.

departmentEntityarray of DepartmentEntity (object)

Request

JavaScriptCurl

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentEntity": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "code": "text",
      "name": "text",
      "hierarchyLevel": 0,
      "children": [
        {
          "childId": "text",
          "status": false
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Update existing Department Entity on iFix for a tenant

Update existing Department Entity on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_update

Body

application/json

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

DepartmentEntity*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.

departmentEntityarray of DepartmentEntity (object)

Request

JavaScriptCurl

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/v1/_update', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "DepartmentEntity": {},
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentEntity": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "code": "text",
      "name": "text",
      "hierarchyLevel": 0,
      "children": [
        {
          "childId": "text",
          "status": false
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get Department Entity details.

Based on the criteria get the list of department entities.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/v1/_search

Body

application/json

RequestHeader meta data.

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*DepartmentEntitySearchCriteria (object)

The object contains all the search criteria of Department Entity

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.

departmentEntityarray of DepartmentEntity (object)

Request

JavaScriptCurl

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

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentEntity": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "code": "text",
      "name": "text",
      "hierarchyLevel": 0,
      "children": [
        {
          "childId": "text",
          "status": false
        }
      ],
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Create/Add new DepartmentHierarchyLevel on iFix for a tenant

Create/Add new DepartmentHierarchyLevel on iFix for a tenant

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_create

Body

application/json

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

departmentHierarchyLevel*DepartmentHierarchyLevel (object)

This object captures the information for level of the department hierarchy and it's alias

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.

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

Request

JavaScriptCurl

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_create', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "departmentHierarchyLevel": {
        "departmentId": "text",
        "id": "text",
        "label": "state, zone, city etc",
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentHierarchyLevel": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "label": "state, zone, city etc",
      "parent": "text",
      "level": 2,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}

Get DepartmentHierarchyLevel.

Based on the criteria get the list of Department Hierarchy Levels.

POSThttps://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_search

Body

application/json

RequestHeader meta data.

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*DepartmentHierarchyLevelSearchCriteria (object)

The object contains all the search criteria of Department Hierarchy Level

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.

departmentHierarchyLevelarray of DepartmentHierarchyLevel (object)

Request

JavaScriptCurl

const response = await fetch('https://<server_address>/ifix-department-entity/departmentEntity/hierarchyLevel/v1/_search', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "criteria": {
        "tenantId": "text"
      },
      "requestHeader": {}
    }),
});
const data = await response.json();

Response

{
  "responseHeader": {
    "correlationId": "text",
    "msgId": "text",
    "status": "SUCCESS",
    "signature": "text",
    "version": "text"
  },
  "departmentHierarchyLevel": [
    {
      "id": "text",
      "tenantId": "text",
      "departmentId": "text",
      "label": "state, zone, city etc",
      "parent": "text",
      "level": 2,
      "auditDetails": {
        "createdBy": "text",
        "lastModifiedBy": "text"
      }
    }
  ]
}