iFIX Department Entity Service API | DIGIT Specifications

DIGIT Specifications

Platform Urban Sanitation

Create/Add new department on iFix for a tenant

post

Create/Add new department on iFix for a tenant

Body

Department request along with request metadata

Responses

202

Request has been accepted for processing

*/*

400

Failed to process the request

*/*

500

Internal server error

*/*

post

POST /fiscal-event-service/department/v1/_create HTTP/1.1
Host: <server-address>
Content-Type: application/json
Accept: */*
Content-Length: 170

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "department": {
    "tenantId": "text",
    "code": "text",
    "name": "text",
    "isNodal": false,
    "parent": "text"
  }
}

{
  "responseHeader": {
    "ts": 1,
    "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Get the list departments.

post

Based on the criteria get the list of departments.

Body

Department search request along with request metadata. Defoult operator b/w multiple criteria is AND.

Responses

200

Successful response

*/*

400

Invalid input.

*/*

500

Internal server error

*/*

post

POST /fiscal-event-service/department/v1/_search HTTP/1.1
Host: <server-address>
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "criteria": {
    "Ids": [
      "text"
    ],
    "tenantId": "text",
    "name": "text",
    "code": "text"
  }
}

{
  "responseHeader": {
    "ts": 1,
    "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Create/Add new Expenditure on iFix for a tenant

post

Create/Add new Expenditure on iFix for a tenant

Body

Expenditure request along with request metadata

Responses

202

Request has been accepted for processing

*/*

400

Failed to process the request

*/*

500

Internal server error

*/*

post

POST /fiscal-event-service/expenditure/v1/_create HTTP/1.1
Host: <server-address>
Content-Type: application/json
Accept: */*
Content-Length: 177

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "expenditure": {
    "tenantId": "text",
    "code": "text",
    "name": "text",
    "type": "Scheme",
    "departmentId": "text"
  }
}

{
  "responseHeader": {
    "ts": 1,
    "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Get the list Expenditure.

post

Based on the criteria get the list of Expenditure.

Body

Expenditure search request along with request metadata. Defoult operator b/w multiple criteria is AND.

Responses

200

Successful response

*/*

400

Invalid input.

*/*

500

Internal server error

*/*

post

POST /fiscal-event-service/expenditure/v1/_search HTTP/1.1
Host: <server-address>
Content-Type: application/json
Accept: */*
Content-Length: 151

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "criteria": {
    "Ids": [
      "text"
    ],
    "tenantId": "text",
    "name": "text",
    "code": "text"
  }
}

{
  "responseHeader": {
    "ts": 1,
    "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Create/Add new project on iFix for a tenant

post

Create/Add new project on iFix for a tenant

Body

Project request along with request metadata

Responses

202

Request has been accepted for processing

*/*

400

Failed to process the request

*/*

500

Internal server error

*/*

post

POST /fiscal-event-service/project/v1/_create HTTP/1.1
Host: <server-address>
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "project": {
    "id": "text",
    "tenantId": "text",
    "code": "text",
    "name": "text",
    "expenditureId": "text",
    "departmentEntityIds": [
      "text"
    ],
    "locationIds": [
      "text"
    ]
  }
}

{
  "responseHeader": {
    "ts": 1,
    "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Update existing project on iFix for a tenant

post

Update existing project on iFix for a tenant

Body

Project request along with request metadata

projectall ofRequired

and

anyOptional

Responses

202

Request has been accepted for processing

*/*

400

Failed to process the request

*/*

500

Internal server error

*/*

post

POST /fiscal-event-service/project/v1/_update HTTP/1.1
Host: <server-address>
Content-Type: application/json
Accept: */*
Content-Length: 224

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "project": {
    "id": "text",
    "tenantId": "text",
    "code": "text",
    "name": "text",
    "expenditureId": "text",
    "departmentEntityIds": [
      "text"
    ],
    "locationIds": [
      "text"
    ]
  }
}

{
  "responseHeader": {
    "ts": 1,
    "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}

Get the list Project.

post

Based on the criteria get the list of Project.

Body

Project search request along with request metadata. Default operator b/w multiple criteria is AND

Responses

200

Successful response

*/*

400

Invalid input.

*/*

500

Internal server error

*/*

post

POST /fiscal-event-service/project/v1/_search HTTP/1.1
Host: <server-address>
Content-Type: application/json
Accept: */*
Content-Length: 244

{
  "requestHeader": {
    "ts": 1,
    "version": "text",
    "msgId": "text",
    "signature": "text"
  },
  "criteria": {
    "Ids": [
      "text"
    ],
    "tenantId": "text",
    "name": "text",
    "code": "text",
    "expenditureId": "text",
    "departmentId": "text",
    "departmentEntityId": "text",
    "locationId": "text"
  }
}

{
  "responseHeader": {
    "ts": 1,
    "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",
        "createdTime": 1,
        "lastModifiedTime": 1
      }
    }
  ]
}