iFIX Department Entity Service API

Create/Add new department on iFix for a tenant

Create/Add new department on iFix for a tenant

post

/department/v1/_create

Body

requestHeaderobjectrequired

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.

departmentobjectrequired

Captures the department attributes

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<server-address>/fiscal-event-service/department/v1/_create' \
  --header 'Content-Type: application/json'

202

400

500

202

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

Request has been accepted for processing

Get the list departments.

Based on the criteria get the list of departments.

post

/department/v1/_search

Body

requestHeaderobjectrequired

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.

criteriaobjectrequired

The object contains all the search criteria of the Department

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<server-address>/fiscal-event-service/department/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

200

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

Successful response

Create/Add new Expenditure on iFix for a tenant

Create/Add new Expenditure on iFix for a tenant

post

/expenditure/v1/_create

Body

requestHeaderobjectrequired

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.

expenditureobjectrequired

Captures the Expenditure attributes

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<server-address>/fiscal-event-service/expenditure/v1/_create' \
  --header 'Content-Type: application/json'

202

400

500

202

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

Request has been accepted for processing

Get the list Expenditure.

Based on the criteria get the list of Expenditure.

post

/expenditure/v1/_search

Body

requestHeaderobjectrequired

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.

criteriaobjectrequired

The object contains all the search criteria of the Expenditure

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<server-address>/fiscal-event-service/expenditure/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

200

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

Successful response

Create/Add new project on iFix for a tenant

Create/Add new project on iFix for a tenant

post

/project/v1/_create

Body

requestHeaderobjectrequired

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.

projectobjectrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<server-address>/fiscal-event-service/project/v1/_create' \
  --header 'Content-Type: application/json'

202

400

500

202

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

Request has been accepted for processing

Update existing project on iFix for a tenant

Update existing project on iFix for a tenant

post

/project/v1/_update

Body

requestHeaderobjectrequired

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.

projectall ofrequired

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<server-address>/fiscal-event-service/project/v1/_update' \
  --header 'Content-Type: application/json'

202

400

500

202

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

Request has been accepted for processing

Get the list Project.

Based on the criteria get the list of Project.

post

/project/v1/_search

Body

requestHeaderobjectrequired

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.

criteriaobjectrequired

The object contains all the search criteria of the Project

Responses

*/*

*/*

*/*

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://<server-address>/fiscal-event-service/project/v1/_search' \
  --header 'Content-Type: application/json'

200

400

500

200

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

Successful response