diff --git a/business-services/Docs/egf-master-v1.0.0 .yaml b/business-services/Docs/egf-master-v1.0.0 .yaml
deleted file mode 100644
index 3455ba6be02..00000000000
--- a/business-services/Docs/egf-master-v1.0.0 .yaml
+++ /dev/null
@@ -1,4155 +0,0 @@
- swagger: '2.0'
-
- info:
- version: "1.0.0"
- title: Master Service
- description: Master services APIs - to create, update and search Master.
- contact:
- name: Manikanta P T
- email: info@egovernments.org
-
- basePath: "/egf-master/v110"
- x-common-path: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/financials/contracts/egf-master/v1-0-0.yml'
- x-api-id: 'org.egov.egf.master'
- paths:
- /funds/_search:
- post:
- summary: Get the list of funds
- description: funds
- tags:
- - Master
- - Fund
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: name
- type: string
- in: query
- description: |
- name is the name of the fund . Example :Municipal Fund,Capital Fund. Also
- name is unique.
- maxLength: 50
- - name: code
- type: string
- in: query
- description: |
- code is a unique number given to each fund . ULB may refer this for the
- short name
- maxLength: 50
- - name: identifier
- type: string
- in: query
- description: |
- identifier of the Fund
- - name: parent
- type: integer
- format: int64
- in: query
- description: |
- parent adding a parent will create the fund as a sub-fund (child) of a
- fund already created (parent fund).
- - name: active
- type: boolean
- in: query
- description: |
- active is a boolean value which says whether fund is in use or not . If
- Fund is active, then accounting of transactions under the fund is
- enabled. If Fund becomes inactive, and no transactions can be accounted
- under the Fund.
- - name: isParent
- type: boolean
- in: query
- description: |
- isParent is updated internally so that system can identify whether the
- fund is parent or child. Only child which is not parent for any other
- fund can only participate in transaction .
- - name: level
- type: integer
- format: int64
- in: query
- description: |
- level identifies what is the level of the fund in the tree structure. Top
- most parent will have level 0 and its child will have level as 1
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: Fund retrieved Successfully
- schema:
- $ref: '#/definitions/FundResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /funds/_create:
- post:
- summary: Create new funds
- description: Create new funds
- tags:
- - Master
- - Fund
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: fundRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/FundRequest'
- responses:
- 201:
- description: Fund created Successfully
- schema:
- $ref: '#/definitions/FundResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /funds/_update:
- post:
- summary: Update any of the funds
- description: Update any of the funds
- tags:
- - Master
- - Fund
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: fundRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/FundRequest'
- responses:
- 200:
- description: Fund updated Successfully
- schema:
- $ref: '#/definitions/FundResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /financialyears/_search:
- post:
- summary: Get the list of financialyears
- description: financialyears
- tags:
- - Master
- - FinancialYear
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: finYearRange
- type: string
- in: query
- description: |
- finYearRange is the name of the Financial Year . for example for
- accounting year 2017 and 2018 it may be named 2017-18
- maxLength: 25
- - name: startingDate
- type: string
- format: date
- in: query
- description: |
- startingDate is the date on which Accounting Year starts. Usually it is
- 1st April of that year.
- - name: endingDate
- type: string
- format: date
- in: query
- description: |
- endingDate is the date on which Financial Year ends. Usually it is 31st
- march of next year
- - name: active
- type: boolean
- in: query
- description: |
- active says whether Financial Year is active or not . Over a period
- system will have number of Financial years. Reports
- ,searches,transactions will need to display this.If the active value is
- true then Financial Year is listed, if value is false it wont be listed
- - name: isActiveForPosting
- type: boolean
- in: query
- description: |
- isActiveForPosting refers whether posting allowed for the Financial Year
- or not . This value will be true for current year and few previous year
- for which data entry will be happening. Once the account is closed this
- value is set to false . All transactions will happen if and only if
- isActiveForPosting is true
- - name: isClosed
- type: boolean
- in: query
- description: |
- isClosed refers whether the account is closed or not . Once the account
- is closed and balance is transferred this value is set to false if the
- account is closed no transaction can happen on that financial year.
- - name: transferClosingBalance
- type: boolean
- in: query
- description: |
- transferClosingBalance informs whether While closing account balance is
- transferred or not .
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: FinancialYear retrieved Successfully
- schema:
- $ref: '#/definitions/FinancialYearResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /financialyears/_create:
- post:
- summary: Create new financialyears
- description: Create new financialyears
- tags:
- - Master
- - FinancialYear
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: financialYearRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/FinancialYearRequest'
- responses:
- 201:
- description: FinancialYear created Successfully
- schema:
- $ref: '#/definitions/FinancialYearResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /financialyears/_update:
- post:
- summary: Update any of the financialyears
- description: Update any of the financialyears
- tags:
- - Master
- - FinancialYear
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: financialYearRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/FinancialYearRequest'
- responses:
- 200:
- description: FinancialYear updated Successfully
- schema:
- $ref: '#/definitions/FinancialYearResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /fiscalperiods/_search:
- post:
- summary: Get the list of fiscalperiods
- description: fiscalperiods
- tags:
- - Master
- - FiscalPeriod
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: name
- type: string
- in: query
- description: |
- name of the FiscalPeriod
- maxLength: 25
- - name: financialYear
- type: integer
- format: int64
- in: query
- description: |
- financial year of the FiscalPeriod
- - name: startingDate
- type: string
- format: date
- in: query
- description: |
- startingDate is the date on which period starts.
- - name: endingDate
- type: string
- format: date
- in: query
- description: |
- endingDate is the date on which period ends.
- - name: active
- type: boolean
- in: query
- description: |
- active says whether fiscal period is active or not . Over a period system
- will have number of fiscal period. Reports ,searches,transactions will
- need to display this.If the active value is true then fiscal period is
- listed, if value is false it wont be listed
- - name: isActiveForPosting
- type: boolean
- in: query
- description: |
- isActiveForPosting refers whether posting allowed for the fiscal period
- or not . This value will be true for current year and few previous year
- for which data entry will be happening. Once the account is closed this
- value is set to false . All transactions will happen if and only if
- isActiveForPosting is true
- - name: isClosed
- type: boolean
- in: query
- description: |
- isClosed refers whether the account is closed or not . Once the account
- is closed and balance is transferred this value is set to false if the
- account is closed no transaction can happen on that fiscal period.
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: FiscalPeriod retrieved Successfully
- schema:
- $ref: '#/definitions/FiscalPeriodResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /fiscalperiods/_create:
- post:
- summary: Create new fiscalperiods
- description: Create new fiscalperiods
- tags:
- - Master
- - FiscalPeriod
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: fiscalPeriodRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/FiscalPeriodRequest'
- responses:
- 201:
- description: FiscalPeriod created Successfully
- schema:
- $ref: '#/definitions/FiscalPeriodResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /fiscalperiods/_update:
- post:
- summary: Update any of the fiscalperiods
- description: Update any of the fiscalperiods
- tags:
- - Master
- - FiscalPeriod
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: fiscalPeriodRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/FiscalPeriodRequest'
- responses:
- 200:
- description: FiscalPeriod updated Successfully
- schema:
- $ref: '#/definitions/FiscalPeriodResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /functions/_search:
- post:
- summary: Get the list of functions
- description: functions
- tags:
- - Master
- - Function
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: name
- type: string
- in: query
- description: |
- name is the name of the function .
- maxLength: 128
- - name: code
- type: string
- in: query
- description: |
- code is a unique number given to each function . ULBs may refer this for
- the short name.
- maxLength: 16
- - name: level
- type: integer
- format: int32
- in: query
- description: |
- level identifies what is the level of the function in the tree structure.
- Top most parent will have level 0 and its child will have level as 1
- - name: active
- type: boolean
- in: query
- description: |
- active is a boolean value which says whether function is in use or not .
- If Function is active, then accounting of transactions under the Function
- is enabled. If Function becomes inactive, and no transactions can be
- accounted under the Function. Only leaf function can be used in
- transaction ie function which is not parent to any other function
- - name: parentId
- type: integer
- format: int64
- in: query
- description: |
- parent id of the Function
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: Function retrieved Successfully
- schema:
- $ref: '#/definitions/FunctionResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /functions/_create:
- post:
- summary: Create new functions
- description: Create new functions
- tags:
- - Master
- - Function
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: functionRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/FunctionRequest'
- responses:
- 201:
- description: Function created Successfully
- schema:
- $ref: '#/definitions/FunctionResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /functions/_update:
- post:
- summary: Update any of the functions
- description: Update any of the functions
- tags:
- - Master
- - Function
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: functionRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/FunctionRequest'
- responses:
- 200:
- description: Function updated Successfully
- schema:
- $ref: '#/definitions/FunctionResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /functionaries/_search:
- post:
- summary: Get the list of functionaries
- description: functionaries
- tags:
- - Master
- - Functionary
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: code
- type: string
- in: query
- description: |
- code is uniue identifier and ULB may refer this for short name.
- maxLength: 16
- - name: name
- type: string
- in: query
- description: |
- name is the name of the functionary
- maxLength: 256
- - name: active
- type: boolean
- in: query
- description: |
- active states whether the functionary is active or not . Only active
- functionaries will be used in transaction
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: Functionary retrieved Successfully
- schema:
- $ref: '#/definitions/FunctionaryResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /functionaries/_create:
- post:
- summary: Create new functionaries
- description: Create new functionaries
- tags:
- - Master
- - Functionary
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: functionaryRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/FunctionaryRequest'
- responses:
- 201:
- description: Functionary created Successfully
- schema:
- $ref: '#/definitions/FunctionaryResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /functionaries/_update:
- post:
- summary: Update any of the functionaries
- description: Update any of the functionaries
- tags:
- - Master
- - Functionary
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: functionaryRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/FunctionaryRequest'
- responses:
- 200:
- description: Functionary updated Successfully
- schema:
- $ref: '#/definitions/FunctionaryResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /fundsources/_search:
- post:
- summary: Get the list of fundsources
- description: fundsources
- tags:
- - Master
- - Fundsource
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: code
- type: string
- in: query
- description: |
- code of the Fundsource
- maxLength: 25
- - name: name
- type: string
- in: query
- description: |
- name of the Fundsource
- maxLength: 25
- - name: type
- type: string
- in: query
- description: |
- type of the Fundsource
- maxLength: 25
- - name: parent
- type: integer
- format: int64
- in: query
- description: |
- parent of the Fundsource
- - name: llevel
- type: number
- format: double
- in: query
- description: |
- llevel of the Fundsource
- - name: active
- type: boolean
- in: query
- description: |
- Whether Fundsource is Active or not. If the value is TRUE, then Fundsource is active,If the value is FALSE then Fundsource is inactive,Default value is TRUE
- - name: isParent
- type: boolean
- in: query
- description: |
- is parent of the Fundsource
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: Fundsource retrieved Successfully
- schema:
- $ref: '#/definitions/FundsourceResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /fundsources/_create:
- post:
- summary: Create new fundsources
- description: Create new fundsources
- tags:
- - Master
- - Fundsource
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: fundsourceRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/FundsourceRequest'
- responses:
- 201:
- description: Fundsource created Successfully
- schema:
- $ref: '#/definitions/FundsourceResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /fundsources/_update:
- post:
- summary: Update any of the fundsources
- description: Update any of the fundsources
- tags:
- - Master
- - Fundsource
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: fundsourceRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/FundsourceRequest'
- responses:
- 200:
- description: Fundsource updated Successfully
- schema:
- $ref: '#/definitions/FundsourceResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /schemes/_search:
- post:
- summary: Get the list of schemes
- description: schemes
- tags:
- - Master
- - Scheme
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: fund
- type: integer
- format: int64
- in: query
- description: |
- fund of the Scheme
- - name: code
- type: string
- in: query
- description: |
- code of the Scheme
- maxLength: 25
- - name: name
- type: string
- in: query
- description: |
- name of the Scheme
- maxLength: 25
- - name: validFrom
- type: string
- format: date
- in: query
- description: |
- valid from of the Scheme
- - name: validTo
- type: string
- format: date
- in: query
- description: |
- valid to of the Scheme
- - name: active
- type: boolean
- in: query
- description: |
- Whether Scheme is Active or not. If the value is TRUE, then Scheme is active,If the value is FALSE then Scheme is inactive,Default value is TRUE
- - name: description
- type: string
- in: query
- description: |
- description of the Scheme
- maxLength: 256
- - name: boundary
- type: string
- in: query
- description: |
- boundary of the Scheme
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: Scheme retrieved Successfully
- schema:
- $ref: '#/definitions/SchemeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /schemes/_create:
- post:
- summary: Create new schemes
- description: Create new schemes
- tags:
- - Master
- - Scheme
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: schemeRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/SchemeRequest'
- responses:
- 201:
- description: Scheme created Successfully
- schema:
- $ref: '#/definitions/SchemeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /schemes/_update:
- post:
- summary: Update any of the schemes
- description: Update any of the schemes
- tags:
- - Master
- - Scheme
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: schemeRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/SchemeRequest'
- responses:
- 200:
- description: Scheme updated Successfully
- schema:
- $ref: '#/definitions/SchemeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /banks/_search:
- post:
- summary: Get the list of banks
- description: banks
- tags:
- - Master
- - Bank
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: code
- type: string
- in: query
- description: |
- code is the code of the bank
- - name: name
- type: string
- in: query
- description: |
- name is the Bank Name .
- - name: description
- type: string
- in: query
- description: |
- description more detailed description of the bank
- - name: active
- type: boolean
- in: query
- description: |
- active states whether the bank is active in the system or not .
- - name: type
- type: string
- in: query
- description: |
- type of the Bank
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: Bank retrieved Successfully
- schema:
- $ref: '#/definitions/BankResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /banks/_create:
- post:
- summary: Create new banks
- description: Create new banks
- tags:
- - Master
- - Bank
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: bankRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/BankRequest'
- responses:
- 201:
- description: Bank created Successfully
- schema:
- $ref: '#/definitions/BankResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /banks/_update:
- post:
- summary: Update any of the banks
- description: Update any of the banks
- tags:
- - Master
- - Bank
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: bankRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/BankRequest'
- responses:
- 200:
- description: Bank updated Successfully
- schema:
- $ref: '#/definitions/BankResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /bankbranches/_search:
- post:
- summary: Get the list of bankbranches
- description: bankbranches
- tags:
- - Master
- - BankBranch
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: bank
- type: integer
- format: int64
- in: query
- description: |
- bank is the bank of the branch
- - name: code
- type: string
- in: query
- description: |
- code is the branch code
- maxLength: 50
- - name: name
- type: string
- in: query
- description: |
- name is the branch name
- maxLength: 50
- - name: address
- type: string
- in: query
- description: |
- address2 is the secondary address of the branch
- maxLength: 50
- - name: address2
- type: string
- in: query
- description: |
- address2 of the BankBranch
- maxLength: 50
- - name: city
- type: string
- in: query
- description: |
- city is the name of the bank branches city
- maxLength: 50
- - name: state
- type: string
- in: query
- description: |
- state is the name of the state
- maxLength: 50
- - name: pincode
- type: string
- in: query
- description: |
- pincode is the pincode of the branch
- maxLength: 50
- - name: phone
- type: string
- in: query
- description: |
- phone is the phone number of the branch
- maxLength: 15
- - name: fax
- type: string
- in: query
- description: |
- fax is the fax number of the branch
- maxLength: 15
- - name: contactPerson
- type: string
- in: query
- description: |
- contactPerson is the name of the person in contact
- maxLength: 50
- - name: active
- type: boolean
- in: query
- description: |
- active states whether branch is active. i.e is usable by the system or not
- if not active it cannot be used
- - name: description
- type: string
- in: query
- description: |
- description is the more detailed description of the branch
- maxLength: 256
- - name: micr
- type: string
- in: query
- description: |
- micr is the micr code of the bank branch
- maxLength: 50
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: BankBranch retrieved Successfully
- schema:
- $ref: '#/definitions/BankBranchResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /bankbranches/_create:
- post:
- summary: Create new bankbranches
- description: Create new bankbranches
- tags:
- - Master
- - BankBranch
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: bankBranchRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/BankBranchRequest'
- responses:
- 201:
- description: BankBranch created Successfully
- schema:
- $ref: '#/definitions/BankBranchResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /bankbranches/_update:
- post:
- summary: Update any of the bankbranches
- description: Update any of the bankbranches
- tags:
- - Master
- - BankBranch
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: bankBranchRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/BankBranchRequest'
- responses:
- 200:
- description: BankBranch updated Successfully
- schema:
- $ref: '#/definitions/BankBranchResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /bankaccounts/_search:
- post:
- summary: Get the list of bankaccounts
- description: bankaccounts
- tags:
- - Master
- - BankAccount
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: bankBranch
- type: integer
- format: int64
- in: query
- description: |
- bank branch of the BankAccount
- - name: chartOfAccount
- type: integer
- format: int64
- in: query
- description: |
- chart of account of the BankAccount
- - name: fund
- type: integer
- format: int64
- in: query
- description: |
- fund of the BankAccount
- - name: accountNumber
- type: string
- in: query
- description: |
- account number of the BankAccount
- maxLength: 25
- - name: accountType
- type: string
- in: query
- description: |
- account type of the BankAccount
- - name: description
- type: string
- in: query
- description: |
- description of the BankAccount
- maxLength: 256
- - name: active
- type: boolean
- in: query
- description: |
- Whether BankAccount is Active or not. If the value is TRUE, then BankAccount is active,If the value is FALSE then BankAccount is inactive,Default value is TRUE
- - name: payTo
- type: string
- in: query
- description: |
- pay to of the BankAccount
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: BankAccount retrieved Successfully
- schema:
- $ref: '#/definitions/BankAccountResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /bankaccounts/_create:
- post:
- summary: Create new bankaccounts
- description: Create new bankaccounts
- tags:
- - Master
- - BankAccount
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: bankAccountRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/BankAccountRequest'
- responses:
- 201:
- description: BankAccount created Successfully
- schema:
- $ref: '#/definitions/BankAccountResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /bankaccounts/_update:
- post:
- summary: Update any of the bankaccounts
- description: Update any of the bankaccounts
- tags:
- - Master
- - BankAccount
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: bankAccountRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/BankAccountRequest'
- responses:
- 200:
- description: BankAccount updated Successfully
- schema:
- $ref: '#/definitions/BankAccountResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /subschemes/_search:
- post:
- summary: Get the list of subschemes
- description: subschemes
- tags:
- - Master
- - SubScheme
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: scheme
- type: integer
- format: int64
- in: query
- description: |
- scheme of the SubScheme
- - name: code
- type: string
- in: query
- description: |
- code of the SubScheme
- maxLength: 50
- - name: name
- type: string
- in: query
- description: |
- name of the SubScheme
- maxLength: 50
- - name: validFrom
- type: string
- format: date
- in: query
- description: |
- valid from of the SubScheme
- - name: validTo
- type: string
- format: date
- in: query
- description: |
- valid to of the SubScheme
- - name: active
- type: boolean
- in: query
- description: |
- Whether SubScheme is Active or not. If the value is TRUE, then SubScheme is active,If the value is FALSE then SubScheme is inactive,Default value is TRUE
- - name: departmentId
- type: string
- in: query
- description: |
- department id of the SubScheme
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: SubScheme retrieved Successfully
- schema:
- $ref: '#/definitions/SubSchemeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /subschemes/_create:
- post:
- summary: Create new subschemes
- description: Create new subschemes
- tags:
- - Master
- - SubScheme
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: subSchemeRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/SubSchemeRequest'
- responses:
- 201:
- description: SubScheme created Successfully
- schema:
- $ref: '#/definitions/SubSchemeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /subschemes/_update:
- post:
- summary: Update any of the subschemes
- description: Update any of the subschemes
- tags:
- - Master
- - SubScheme
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: subSchemeRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/SubSchemeRequest'
- responses:
- 200:
- description: SubScheme updated Successfully
- schema:
- $ref: '#/definitions/SubSchemeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /suppliers/_search:
- post:
- summary: Get the list of suppliers
- description: suppliers
- tags:
- - Master
- - Supplier
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: code
- type: string
- in: query
- description: |
- code of the Supplier
- maxLength: 50
- - name: name
- type: string
- in: query
- description: |
- name of the Supplier
- maxLength: 50
- - name: address
- type: string
- in: query
- description: |
- address of the Supplier
- maxLength: 300
- - name: mobile
- type: string
- in: query
- description: |
- mobile of the Supplier
- maxLength: 10
- - name: email
- type: string
- in: query
- description: |
- email of the Supplier
- maxLength: 25
- - name: description
- type: string
- in: query
- description: |
- description of the Supplier
- maxLength: 250
- - name: active
- type: boolean
- in: query
- description: |
- Whether Supplier is Active or not. If the value is TRUE, then Supplier is active,If the value is FALSE then Supplier is inactive,Default value is TRUE
- - name: panNo
- type: string
- in: query
- description: |
- pan no of the Supplier
- maxLength: 10
- - name: tinNo
- type: string
- in: query
- description: |
- tin no of the Supplier
- maxLength: 20
- - name: registationNo
- type: string
- in: query
- description: |
- registation no of the Supplier
- maxLength: 25
- - name: bankAccount
- type: integer
- format: int64
- in: query
- description: |
- bank account of the Supplier
- - name: ifscCode
- type: string
- in: query
- description: |
- ifsc code of the Supplier
- maxLength: 12
- - name: bank
- type: integer
- format: int64
- in: query
- description: |
- bank of the Supplier
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: Supplier retrieved Successfully
- schema:
- $ref: '#/definitions/SupplierResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /suppliers/_create:
- post:
- summary: Create new suppliers
- description: Create new suppliers
- tags:
- - Master
- - Supplier
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: supplierRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/SupplierRequest'
- responses:
- 201:
- description: Supplier created Successfully
- schema:
- $ref: '#/definitions/SupplierResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /suppliers/_update:
- post:
- summary: Update any of the suppliers
- description: Update any of the suppliers
- tags:
- - Master
- - Supplier
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: supplierRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/SupplierRequest'
- responses:
- 200:
- description: Supplier updated Successfully
- schema:
- $ref: '#/definitions/SupplierResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /accountdetailtypes/_search:
- post:
- summary: Get the list of accountdetailtypes
- description: accountdetailtypes
- tags:
- - Master
- - AccountDetailType
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: name
- type: string
- in: query
- description: |
- name of the AccountDetailType
- maxLength: 50
- - name: description
- type: string
- in: query
- description: |
- description of the AccountDetailType
- maxLength: 50
- - name: tableName
- type: string
- in: query
- description: |
- table name of the AccountDetailType
- maxLength: 25
- - name: active
- type: boolean
- in: query
- description: |
- Whether AccountDetailType is Active or not. If the value is TRUE, then AccountDetailType is active,If the value is FALSE then AccountDetailType is inactive,Default value is TRUE
- - name: fullyQualifiedName
- type: string
- in: query
- description: |
- fully qualified name of the AccountDetailType
- maxLength: 250
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: AccountDetailType retrieved Successfully
- schema:
- $ref: '#/definitions/AccountDetailTypeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /accountdetailtypes/_create:
- post:
- summary: Create new accountdetailtypes
- description: Create new accountdetailtypes
- tags:
- - Master
- - AccountDetailType
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: accountDetailTypeRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/AccountDetailTypeRequest'
- responses:
- 201:
- description: AccountDetailType created Successfully
- schema:
- $ref: '#/definitions/AccountDetailTypeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /accountdetailtypes/_update:
- post:
- summary: Update any of the accountdetailtypes
- description: Update any of the accountdetailtypes
- tags:
- - Master
- - AccountDetailType
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: accountDetailTypeRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/AccountDetailTypeRequest'
- responses:
- 200:
- description: AccountDetailType updated Successfully
- schema:
- $ref: '#/definitions/AccountDetailTypeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /accountdetailkeys/_search:
- post:
- summary: Get the list of accountdetailkeys
- description: accountdetailkeys
- tags:
- - Master
- - AccountDetailKey
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: key
- type: string
- in: query
- description: |
- key of the AccountDetailKey
- - name: accountDetailType
- type: integer
- format: int64
- in: query
- description: |
- account detail type of the AccountDetailKey
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: AccountDetailKey retrieved Successfully
- schema:
- $ref: '#/definitions/AccountDetailKeyResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /accountdetailkeys/_create:
- post:
- summary: Create new accountdetailkeys
- description: Create new accountdetailkeys
- tags:
- - Master
- - AccountDetailKey
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: accountDetailKeyRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/AccountDetailKeyRequest'
- responses:
- 201:
- description: AccountDetailKey created Successfully
- schema:
- $ref: '#/definitions/AccountDetailKeyResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /accountdetailkeys/_update:
- post:
- summary: Update any of the accountdetailkeys
- description: Update any of the accountdetailkeys
- tags:
- - Master
- - AccountDetailKey
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: accountDetailKeyRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/AccountDetailKeyRequest'
- responses:
- 200:
- description: AccountDetailKey updated Successfully
- schema:
- $ref: '#/definitions/AccountDetailKeyResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /accountentities/_search:
- post:
- summary: Get the list of accountentities
- description: accountentities
- tags:
- - Master
- - AccountEntity
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: accountDetailType
- type: integer
- format: int64
- in: query
- description: |
- account detail type of the AccountEntity
- - name: code
- type: string
- in: query
- description: |
- code of the AccountEntity
- maxLength: 25
- - name: name
- type: string
- in: query
- description: |
- name of the AccountEntity
- maxLength: 350
- - name: active
- type: boolean
- in: query
- description: |
- Whether AccountEntity is Active or not. If the value is TRUE, then AccountEntity is active,If the value is FALSE then AccountEntity is inactive,Default value is TRUE
- - name: description
- type: string
- in: query
- description: |
- description of the AccountEntity
- maxLength: 256
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: AccountEntity retrieved Successfully
- schema:
- $ref: '#/definitions/AccountEntityResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /accountentities/_create:
- post:
- summary: Create new accountentities
- description: Create new accountentities
- tags:
- - Master
- - AccountEntity
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: accountEntityRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/AccountEntityRequest'
- responses:
- 201:
- description: AccountEntity created Successfully
- schema:
- $ref: '#/definitions/AccountEntityResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /accountentities/_update:
- post:
- summary: Update any of the accountentities
- description: Update any of the accountentities
- tags:
- - Master
- - AccountEntity
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: accountEntityRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/AccountEntityRequest'
- responses:
- 200:
- description: AccountEntity updated Successfully
- schema:
- $ref: '#/definitions/AccountEntityResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /accountcodepurposes/_search:
- post:
- summary: Get the list of accountcodepurposes
- description: accountcodepurposes
- tags:
- - Master
- - AccountCodePurpose
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: name
- type: string
- in: query
- description: |
- name of the AccountCodePurpose
- maxLength: 256
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: AccountCodePurpose retrieved Successfully
- schema:
- $ref: '#/definitions/AccountCodePurposeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /accountcodepurposes/_create:
- post:
- summary: Create new accountcodepurposes
- description: Create new accountcodepurposes
- tags:
- - Master
- - AccountCodePurpose
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: accountCodePurposeRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/AccountCodePurposeRequest'
- responses:
- 201:
- description: AccountCodePurpose created Successfully
- schema:
- $ref: '#/definitions/AccountCodePurposeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /accountcodepurposes/_update:
- post:
- summary: Update any of the accountcodepurposes
- description: Update any of the accountcodepurposes
- tags:
- - Master
- - AccountCodePurpose
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: accountCodePurposeRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/AccountCodePurposeRequest'
- responses:
- 200:
- description: AccountCodePurpose updated Successfully
- schema:
- $ref: '#/definitions/AccountCodePurposeResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /chartofaccounts/_search:
- post:
- summary: Get the list of chartofaccounts
- description: chartofaccounts
- tags:
- - Master
- - ChartOfAccount
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: glcode
- type: string
- in: query
- description: |
- glcode is the Account Code or Account Head in Accounting terms.It may be
- Major head,Minor head or Detailed head.It is numeric examples are
- 1,110,1101,1101001,2,210,21000,210010
- maxLength: 16
- - name: name
- type: string
- in: query
- description: |
- name is the name of the account code . for example 110 glcode has the
- name "Tax Revenue"
- maxLength: 128
- - name: accountCodePurpose
- type: integer
- format: int64
- in: query
- description: |
- accountCodePurpose is the mapped AccountCodePurpose . This mapping can
- happen at any level say Major,minor or detailed. When Account code is
- searched 1. If mapped at major code then it lists major and all other
- codes under that major code 2. If mapped at minor code then it list minor
- code and all other codes under that minor code 3. If mapped at detailed
- code then it lists only that code
- - name: description
- type: string
- in: query
- description: |
- description is the more detailed description about the account code
- maxLength: 256
- - name: isActiveForPosting
- type: boolean
- in: query
- description: |
- isActiveForPosting true will be considered for transactions. All
- major,minor codes will be false and only detailed code will be true .
- Further any account code can be disabled for transaction by making this
- field false
- - name: parentId
- type: integer
- format: int64
- in: query
- description: |
- parentId is the id of other account code in the chart of account .Chart
- of account is created in tree structure. Any code can have other code as
- parent . All minor code will have manjor code as parent . All detailed
- code will have minor code as parent only leaf account code that is which
- is not parent for any account code will used for transactions.
- - name: type
- type: string
- in: query
- description: |
- type is a single character representation of account code type I: Income
- E: Expenditure L: Liability A: Asset Account code for all I start with 1
- Account code for all E start with 2 Account code for all L start with 3
- Account code for all A start with 4
- - name: classification
- type: integer
- format: int64
- in: query
- description: |
- classification is internal to the system. This tells whether the code is
- Major ,Minor,Subminor or detailed. Major code classification value is 1
- Minor code is 2 Subminor code is 3 Detailed code is 4. Only
- classification 4 and is activeforposting=true will be used in
- transactions. Reports can be generated at any level.
- - name: functionRequired
- type: boolean
- in: query
- description: |
- functionRequired field specifies while transacting with this accountcode
- is the function is mandatory or not . For any account code this field is
- set to true then all transactions expect a fun=ction code to be passed
- along with account code
- - name: budgetCheckRequired
- type: boolean
- in: query
- description: |
- budgetCheckRequired field specifies whether budgeting check required for
- this account code. Apart from global Budgetcheck configuration this is
- where glcode wise budget check decision is made.
- - name: majorCode
- type: string
- in: query
- description: |
- major code of the ChartOfAccount
- maxLength: 16
- - name: isSubLedger
- type: boolean
- in: query
- description: |
- is sub ledger of the ChartOfAccount
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: ChartOfAccount retrieved Successfully
- schema:
- $ref: '#/definitions/ChartOfAccountResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /chartofaccounts/_create:
- post:
- summary: Create new chartofaccounts
- description: Create new chartofaccounts
- tags:
- - Master
- - ChartOfAccount
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: chartOfAccountRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/ChartOfAccountRequest'
- responses:
- 201:
- description: ChartOfAccount created Successfully
- schema:
- $ref: '#/definitions/ChartOfAccountResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /chartofaccounts/_update:
- post:
- summary: Update any of the chartofaccounts
- description: Update any of the chartofaccounts
- tags:
- - Master
- - ChartOfAccount
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: chartOfAccountRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/ChartOfAccountRequest'
- responses:
- 200:
- description: ChartOfAccount updated Successfully
- schema:
- $ref: '#/definitions/ChartOfAccountResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /chartofaccountdetails/_search:
- post:
- summary: Get the list of chartofaccountdetails
- description: chartofaccountdetails
- tags:
- - Master
- - ChartOfAccountDetail
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: chartOfAccount
- type: integer
- format: int64
- in: query
- description: |
- chart of account of the ChartOfAccountDetail
- - name: accountDetailType
- type: integer
- format: int64
- in: query
- description: |
- account detail type of the ChartOfAccountDetail
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: ChartOfAccountDetail retrieved Successfully
- schema:
- $ref: '#/definitions/ChartOfAccountDetailResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /chartofaccountdetails/_create:
- post:
- summary: Create new chartofaccountdetails
- description: Create new chartofaccountdetails
- tags:
- - Master
- - ChartOfAccountDetail
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: chartOfAccountDetailRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/ChartOfAccountDetailRequest'
- responses:
- 201:
- description: ChartOfAccountDetail created Successfully
- schema:
- $ref: '#/definitions/ChartOfAccountDetailResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /chartofaccountdetails/_update:
- post:
- summary: Update any of the chartofaccountdetails
- description: Update any of the chartofaccountdetails
- tags:
- - Master
- - ChartOfAccountDetail
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: chartOfAccountDetailRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/ChartOfAccountDetailRequest'
- responses:
- 200:
- description: ChartOfAccountDetail updated Successfully
- schema:
- $ref: '#/definitions/ChartOfAccountDetailResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /budgetgroups/_search:
- post:
- summary: Get the list of budgetgroups
- description: budgetgroups
- tags:
- - Master
- - BudgetGroup
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: name
- type: string
- in: query
- description: |
- name of the BudgetGroup
- maxLength: 250
- - name: description
- type: string
- in: query
- description: |
- description of the BudgetGroup
- maxLength: 250
- - name: majorCode
- type: integer
- format: int64
- in: query
- description: |
- major code of the BudgetGroup
- - name: maxCode
- type: integer
- format: int64
- in: query
- description: |
- max code of the BudgetGroup
- - name: minCode
- type: integer
- format: int64
- in: query
- description: |
- min code of the BudgetGroup
- - name: active
- type: boolean
- in: query
- description: |
- Whether BudgetGroup is Active or not. If the value is TRUE, then BudgetGroup is active,If the value is FALSE then BudgetGroup is inactive,Default value is TRUE
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: BudgetGroup retrieved Successfully
- schema:
- $ref: '#/definitions/BudgetGroupResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /budgetgroups/_create:
- post:
- summary: Create new budgetgroups
- description: Create new budgetgroups
- tags:
- - Master
- - BudgetGroup
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: budgetGroupRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/BudgetGroupRequest'
- responses:
- 201:
- description: BudgetGroup created Successfully
- schema:
- $ref: '#/definitions/BudgetGroupResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /budgetgroups/_update:
- post:
- summary: Update any of the budgetgroups
- description: Update any of the budgetgroups
- tags:
- - Master
- - BudgetGroup
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: budgetGroupRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/BudgetGroupRequest'
- responses:
- 200:
- description: BudgetGroup updated Successfully
- schema:
- $ref: '#/definitions/BudgetGroupResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /financialstatuses/_search:
- post:
- summary: Get the list of financialstatuses
- description: financialstatuses
- tags:
- - Master
- - FinancialStatus
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: moduleType
- type: string
- in: query
- description: |
- module type of the FinancialStatus
- - name: code
- type: string
- in: query
- description: |
- code of the FinancialStatus
- - name: name
- type: string
- in: query
- description: |
- name of the FinancialStatus
- - name: description
- type: string
- in: query
- description: |
- description of the FinancialStatus
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: FinancialStatus retrieved Successfully
- schema:
- $ref: '#/definitions/FinancialStatusResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /financialstatuses/_create:
- post:
- summary: Create new financialstatuses
- description: Create new financialstatuses
- tags:
- - Master
- - FinancialStatus
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: financialStatusRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/FinancialStatusRequest'
- responses:
- 201:
- description: FinancialStatus created Successfully
- schema:
- $ref: '#/definitions/FinancialStatusResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /financialstatuses/_update:
- post:
- summary: Update any of the financialstatuses
- description: Update any of the financialstatuses
- tags:
- - Master
- - FinancialStatus
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: financialStatusRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/FinancialStatusRequest'
- responses:
- 200:
- description: FinancialStatus updated Successfully
- schema:
- $ref: '#/definitions/FinancialStatusResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /financialconfigurations/_search:
- post:
- summary: Get the list of financialconfigurations
- description: financialconfigurations
- tags:
- - Master
- - FinancialConfiguration
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: ids
- type: array
- items:
- type: string
- in: query
- maxItems: 50
- description: comma seperated list of Ids
- - name: name
- type: string
- in: query
- description: |
- name of the FinancialConfiguration
- - name: description
- type: string
- in: query
- description: |
- description of the FinancialConfiguration
- - name: module
- type: string
- in: query
- description: |
- module of the FinancialConfiguration
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/offset"
- - name: sortBy
- type: string
- in: query
- description: |
- This takes any field from the Object seperated by comma and asc,desc keywords.
- example name asc,code desc or name,code or name,code desc
- responses:
- 200:
- description: FinancialConfiguration retrieved Successfully
- schema:
- $ref: '#/definitions/FinancialConfigurationResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /financialconfigurations/_create:
- post:
- summary: Create new financialconfigurations
- description: Create new financialconfigurations
- tags:
- - Master
- - FinancialConfiguration
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: financialConfigurationRequest
- in: body
- description: Create new
- schema:
- $ref: '#/definitions/FinancialConfigurationRequest'
- responses:
- 201:
- description: FinancialConfiguration created Successfully
- schema:
- $ref: '#/definitions/FinancialConfigurationResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /financialconfigurations/_update:
- post:
- summary: Update any of the financialconfigurations
- description: Update any of the financialconfigurations
- tags:
- - Master
- - FinancialConfiguration
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: financialConfigurationRequest
- in: body
- description: common Request info
- schema:
- $ref: '#/definitions/FinancialConfigurationRequest'
- responses:
- 200:
- description: FinancialConfiguration updated Successfully
- schema:
- $ref: '#/definitions/FinancialConfigurationResponse'
- 400:
- description: Invalid Input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- definitions:
- Auditable:
- type: object
- properties:
- tenantId:
- type: string
- maxLength: 50
- minLength: 5
- description: |
- tenantId Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
- represents the client for which the transaction is created.
- createdBy:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-user/contracts/v1-0-0.yml#/definitions/User"
- description: |
- createdBy is the logged in user who is conducting transaction
- lastModifiedBy:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-user/contracts/v1-0-0.yml#/definitions/User"
- description: |
- lastModifiedBy is the logged in user who is updating transaction
- createdDate:
- type: string
- format: date
- description: |
-
- lastModifiedDate:
- type: string
- format: date
- description: |
- lastModifiedDate date is on which trnasaction is updated lastly
- Page:
- type: object
- properties:
- totalResults:
- type: integer
- format: int32
- description: total results of the Pagination
- totalPages:
- type: integer
- format: int32
- description: total pages of the Pagination
- pageSize:
- type: integer
- format: int32
- description: Number of records in a per page in the Pagination, Default value is 20
- currentPage:
- type: integer
- format: int32
- description: current page of the Pagination
- offSet:
- type: integer
- format: int32
- description: page number of the Pagination, Default value is 0
-
- Fund:
- type: object
- description: |
- Fund is a defining concept in municipal accounting – where it is required to
- segregate all accounting transactions into designated funds. Each fund needs
- to be treated as an independent accounting entity – in other words, all
- vouchers within a fund must be self-balancing and balance sheets and
- IncomeExpenditure reports must be generated for each fund. A hierarchy of
- funds may be defined – i.e. each fund can have multiple sub-funds and so on.
- properties:
- id:
- type: string
- description: |
- identifier appears as prefix in all the vouchers accounted in the books
- of the Fund. Each fund must have an identifier – each voucher belonging
- to a fund must have the identifier embedded in the voucher number for
- easy identification. Fund is taken at a voucher head level for each
- voucher transaction.
- name:
- type: string
- maxLength: 50
- minLength: 2
- description: |
- name is the name of the fund . Example :Municipal Fund,Capital Fund. Also
- name is unique.
- code:
- type: string
- maxLength: 50
- minLength: 2
- description: |
- code is a unique number given to each fund . ULB may refer this for the
- short name
- identifier:
- type: string
- description: |
- identifier of the Fund
- parent:
- type: integer
- format: int64
- description: |
- parent adding a parent will create the fund as a sub-fund (child) of a
- fund already created (parent fund).
- active:
- type: boolean
- description: |
- active is a boolean value which says whether fund is in use or not . If
- Fund is active, then accounting of transactions under the fund is
- enabled. If Fund becomes inactive, and no transactions can be accounted
- under the Fund.
- isParent:
- type: boolean
- description: |
- isParent is updated internally so that system can identify whether the
- fund is parent or child. Only child which is not parent for any other
- fund can only participate in transaction .
- level:
- type: integer
- format: int64
- description: |
- level identifies what is the level of the fund in the tree structure. Top
- most parent will have level 0 and its child will have level as 1
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - name
- - code
- - identifier
- - active
- - level
- FundRequest:
- description: Contract class for web request. Array of Fund items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- funds:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Fund'
- FundResponse:
- description: Contract class for web response. Array of Fund items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- funds:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Fund'
- page:
- $ref: '#/definitions/Page'
-
- FinancialYear:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- id is the unique identifier. it is generated internally
- finYearRange:
- type: string
- maxLength: 25
- minLength: 1
- description: |
- finYearRange is the name of the Financial Year . for example for
- accounting year 2017 and 2018 it may be named 2017-18
- startingDate:
- type: string
- format: date
- description: |
- startingDate is the date on which Accounting Year starts. Usually it is
- 1st April of that year.
- endingDate:
- type: string
- format: date
- description: |
- endingDate is the date on which Financial Year ends. Usually it is 31st
- march of next year
- active:
- type: boolean
- description: |
- active says whether Financial Year is active or not . Over a period
- system will have number of Financial years. Reports
- ,searches,transactions will need to display this.If the active value is
- true then Financial Year is listed, if value is false it wont be listed
- isActiveForPosting:
- type: boolean
- description: |
- isActiveForPosting refers whether posting allowed for the Financial Year
- or not . This value will be true for current year and few previous year
- for which data entry will be happening. Once the account is closed this
- value is set to false . All transactions will happen if and only if
- isActiveForPosting is true
- isClosed:
- type: boolean
- description: |
- isClosed refers whether the account is closed or not . Once the account
- is closed and balance is transferred this value is set to false if the
- account is closed no transaction can happen on that financial year.
- transferClosingBalance:
- type: boolean
- description: |
- transferClosingBalance informs whether While closing account balance is
- transferred or not .
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - finYearRange
- - startingDate
- - endingDate
- - active
- - isActiveForPosting
- FinancialYearRequest:
- description: Contract class for web request. Array of FinancialYear items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- financialYears:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/FinancialYear'
- FinancialYearResponse:
- description: Contract class for web response. Array of FinancialYear items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- financialYears:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/FinancialYear'
- page:
- $ref: '#/definitions/Page'
-
- FiscalPeriod:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- id is the unique identifier. it is generated internally
- name:
- type: string
- maxLength: 25
- minLength: 1
- description: |
- name of the FiscalPeriod
- financialYear:
- $ref: "#/definitions/FinancialYear"
- description: |
- financial year of the FiscalPeriod
- startingDate:
- type: string
- format: date
- description: |
- startingDate is the date on which period starts.
- endingDate:
- type: string
- format: date
- description: |
- endingDate is the date on which period ends.
- active:
- type: boolean
- description: |
- active says whether fiscal period is active or not . Over a period system
- will have number of fiscal period. Reports ,searches,transactions will
- need to display this.If the active value is true then fiscal period is
- listed, if value is false it wont be listed
- isActiveForPosting:
- type: boolean
- description: |
- isActiveForPosting refers whether posting allowed for the fiscal period
- or not . This value will be true for current year and few previous year
- for which data entry will be happening. Once the account is closed this
- value is set to false . All transactions will happen if and only if
- isActiveForPosting is true
- isClosed:
- type: boolean
- description: |
- isClosed refers whether the account is closed or not . Once the account
- is closed and balance is transferred this value is set to false if the
- account is closed no transaction can happen on that fiscal period.
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - name
- - financialYear
- - startingDate
- - endingDate
- - active
- - isActiveForPosting
- FiscalPeriodRequest:
- description: Contract class for web request. Array of FiscalPeriod items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- fiscalPeriods:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/FiscalPeriod'
- FiscalPeriodResponse:
- description: Contract class for web response. Array of FiscalPeriod items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- fiscalPeriods:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/FiscalPeriod'
- page:
- $ref: '#/definitions/Page'
-
- Function:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- id is the unique identifier .
- name:
- type: string
- maxLength: 128
- minLength: 2
- description: |
- name is the name of the function .
- code:
- type: string
- maxLength: 16
- minLength: 2
- description: |
- code is a unique number given to each function . ULBs may refer this for
- the short name.
- level:
- type: integer
- format: int32
- description: |
- level identifies what is the level of the function in the tree structure.
- Top most parent will have level 0 and its child will have level as 1
- active:
- type: boolean
- description: |
- active is a boolean value which says whether function is in use or not .
- If Function is active, then accounting of transactions under the Function
- is enabled. If Function becomes inactive, and no transactions can be
- accounted under the Function. Only leaf function can be used in
- transaction ie function which is not parent to any other function
- parentId:
- type: integer
- format: int64
- description: |
- parent id of the Function
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - name
- - code
- - level
- - active
- FunctionRequest:
- description: Contract class for web request. Array of Function items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- functions:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Function'
- FunctionResponse:
- description: Contract class for web response. Array of Function items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- functions:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Function'
- page:
- $ref: '#/definitions/Page'
-
- Functionary:
- type: object
- description: |
- Functionary is considered as another cost center. In the government set-up,
- demands for expenditure are drawn by the department discharging the functions
- and become the responsibility center for the assigned functions. Functionary
- group represents this. Each sub-level within this group typically can
- represent the organisational structure within the ULB. This level is used
- only for the internal control of the ULB.
-
- properties:
- id:
- type: string
- description: |
- id is the unique identifier and it is generated internally
- code:
- type: string
- maxLength: 16
- minLength: 1
- description: |
- code is uniue identifier and ULB may refer this for short name.
- name:
- type: string
- maxLength: 256
- minLength: 1
- description: |
- name is the name of the functionary
- active:
- type: boolean
- description: |
- active states whether the functionary is active or not . Only active
- functionaries will be used in transaction
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - code
- - name
- - active
- FunctionaryRequest:
- description: Contract class for web request. Array of Functionary items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- functionaries:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Functionary'
- FunctionaryResponse:
- description: Contract class for web response. Array of Functionary items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- functionaries:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Functionary'
- page:
- $ref: '#/definitions/Page'
-
- Fundsource:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the Fundsource
- code:
- type: string
- maxLength: 25
- minLength: 1
- description: |
- code of the Fundsource
- name:
- type: string
- maxLength: 25
- minLength: 1
- description: |
- name of the Fundsource
- type:
- type: string
- maxLength: 25
- minLength: 1
- description: |
- type of the Fundsource
- parent:
- type: integer
- format: int64
- description: |
- parent of the Fundsource
- llevel:
- type: number
- format: double
- description: |
- llevel of the Fundsource
- active:
- type: boolean
- description: |
- Whether Fundsource is Active or not. If the value is TRUE, then Fundsource is active,If the value is FALSE then Fundsource is inactive,Default value is TRUE
- isParent:
- type: boolean
- description: |
- is parent of the Fundsource
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - code
- - name
- - active
- FundsourceRequest:
- description: Contract class for web request. Array of Fundsource items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- fundsources:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Fundsource'
- FundsourceResponse:
- description: Contract class for web response. Array of Fundsource items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- fundsources:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Fundsource'
- page:
- $ref: '#/definitions/Page'
-
- Scheme:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the Scheme
- fund:
- $ref: "#/definitions/Fund"
- description: |
- fund of the Scheme
- code:
- type: string
- maxLength: 25
- minLength: 1
- description: |
- code of the Scheme
- name:
- type: string
- maxLength: 25
- minLength: 1
- description: |
- name of the Scheme
- validFrom:
- type: string
- format: date
- description: |
- valid from of the Scheme
- validTo:
- type: string
- format: date
- description: |
- valid to of the Scheme
- active:
- type: boolean
- description: |
- Whether Scheme is Active or not. If the value is TRUE, then Scheme is active,If the value is FALSE then Scheme is inactive,Default value is TRUE
- description:
- type: string
- maxLength: 256
- description: |
- description of the Scheme
- boundary:
- type: string
- description: |
- boundary of the Scheme
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - validFrom
- - validTo
- - active
- SchemeRequest:
- description: Contract class for web request. Array of Scheme items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- schemes:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Scheme'
- SchemeResponse:
- description: Contract class for web response. Array of Scheme items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- schemes:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Scheme'
- page:
- $ref: '#/definitions/Page'
-
- Bank:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- id is unique identifier . It is generated internally
- code:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- code is the code of the bank
- name:
- type: string
- maxLength: 100
- minLength: 2
- description: |
- name is the Bank Name .
- description:
- type: string
- maxLength: 250
- description: |
- description more detailed description of the bank
- active:
- type: boolean
- description: |
- active states whether the bank is active in the system or not .
- type:
- type: string
- maxLength: 50
- description: |
- type of the Bank
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - code
- - name
- - active
- - type
- BankRequest:
- description: Contract class for web request. Array of Bank items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- banks:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Bank'
- BankResponse:
- description: Contract class for web response. Array of Bank items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- banks:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Bank'
- page:
- $ref: '#/definitions/Page'
-
- BankBranch:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- id is the unique identifier
- bank:
- $ref: "#/definitions/Bank"
- description: |
- bank is the bank of the branch
- code:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- code is the branch code
- name:
- type: string
- maxLength: 50
- minLength: 1
- pattern: '^[a-zA-Z0-9_]*$'
- description: |
- name is the branch name
- address:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- address2 is the secondary address of the branch
- address2:
- type: string
- maxLength: 50
- description: |
- address2 of the BankBranch
- city:
- type: string
- maxLength: 50
- description: |
- city is the name of the bank branches city
- state:
- type: string
- maxLength: 50
- description: |
- state is the name of the state
- pincode:
- type: string
- maxLength: 50
- description: |
- pincode is the pincode of the branch
- phone:
- type: string
- maxLength: 15
- description: |
- phone is the phone number of the branch
- fax:
- type: string
- maxLength: 15
- description: |
- fax is the fax number of the branch
- contactPerson:
- type: string
- maxLength: 50
- description: |
- contactPerson is the name of the person in contact
- active:
- type: boolean
- description: |
- active states whether branch is active. i.e is usable by the system or not
- if not active it cannot be used
- description:
- type: string
- maxLength: 256
- description: |
- description is the more detailed description of the branch
- micr:
- type: string
- maxLength: 50
- description: |
- micr is the micr code of the bank branch
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - bank
- - code
- - name
- - address
- - active
- BankBranchRequest:
- description: Contract class for web request. Array of BankBranch items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- bankBranches:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/BankBranch'
- BankBranchResponse:
- description: Contract class for web response. Array of BankBranch items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- bankBranches:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/BankBranch'
- page:
- $ref: '#/definitions/Page'
-
- BankAccount:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the BankAccount
- bankBranch:
- $ref: "#/definitions/BankBranch"
- description: |
- bank branch of the BankAccount
- chartOfAccount:
- $ref: "#/definitions/ChartOfAccount"
- description: |
- chart of account of the BankAccount
- fund:
- $ref: "#/definitions/Fund"
- description: |
- fund of the BankAccount
- accountNumber:
- type: string
- maxLength: 25
- description: |
- account number of the BankAccount
- accountType:
- type: string
- description: |
- account type of the BankAccount
- description:
- type: string
- maxLength: 256
- description: |
- description of the BankAccount
- active:
- type: boolean
- description: |
- Whether BankAccount is Active or not. If the value is TRUE, then BankAccount is active,If the value is FALSE then BankAccount is inactive,Default value is TRUE
- payTo:
- type: string
- maxLength: 100
- description: |
- pay to of the BankAccount
- type:
- type: string
- enum:
- - RECEIPTS
- - PAYMENTS
- - RECEIPTS_PAYMENTS
- description: |
- type of the BankAccount
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - bankBranch
- - chartOfAccount
- - fund
- - accountNumber
- - active
- - type
- BankAccountRequest:
- description: Contract class for web request. Array of BankAccount items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- bankAccounts:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/BankAccount'
- BankAccountResponse:
- description: Contract class for web response. Array of BankAccount items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- bankAccounts:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/BankAccount'
- page:
- $ref: '#/definitions/Page'
-
- SubScheme:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the SubScheme
- scheme:
- $ref: "#/definitions/Scheme"
- description: |
- scheme of the SubScheme
- code:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- code of the SubScheme
- name:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- name of the SubScheme
- validFrom:
- type: string
- format: date
- description: |
- valid from of the SubScheme
- validTo:
- type: string
- format: date
- description: |
- valid to of the SubScheme
- active:
- type: boolean
- description: |
- Whether SubScheme is Active or not. If the value is TRUE, then SubScheme is active,If the value is FALSE then SubScheme is inactive,Default value is TRUE
- departmentId:
- type: string
- description: |
- department id of the SubScheme
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - scheme
- - code
- - name
- - validFrom
- - validTo
- - active
- SubSchemeRequest:
- description: Contract class for web request. Array of SubScheme items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- subSchemes:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/SubScheme'
- SubSchemeResponse:
- description: Contract class for web response. Array of SubScheme items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- subSchemes:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/SubScheme'
- page:
- $ref: '#/definitions/Page'
-
- Supplier:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the Supplier
- code:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- code of the Supplier
- name:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- name of the Supplier
- address:
- type: string
- maxLength: 300
- description: |
- address of the Supplier
- mobile:
- type: string
- maxLength: 10
- description: |
- mobile of the Supplier
- email:
- type: string
- maxLength: 25
- description: |
- email of the Supplier
- description:
- type: string
- maxLength: 250
- description: |
- description of the Supplier
- active:
- type: boolean
- description: |
- Whether Supplier is Active or not. If the value is TRUE, then Supplier is active,If the value is FALSE then Supplier is inactive,Default value is TRUE
- panNo:
- type: string
- maxLength: 10
- description: |
- pan no of the Supplier
- tinNo:
- type: string
- maxLength: 20
- description: |
- tin no of the Supplier
- registationNo:
- type: string
- maxLength: 25
- description: |
- registation no of the Supplier
- bankAccount:
- $ref: "#/definitions/BankAccount"
- description: |
- bank account of the Supplier
- ifscCode:
- type: string
- maxLength: 12
- description: |
- ifsc code of the Supplier
- bank:
- $ref: "#/definitions/Bank"
- description: |
- bank of the Supplier
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - code
- - name
- - active
- SupplierRequest:
- description: Contract class for web request. Array of Supplier items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- suppliers:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Supplier'
- SupplierResponse:
- description: Contract class for web response. Array of Supplier items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- suppliers:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Supplier'
- page:
- $ref: '#/definitions/Page'
-
- AccountDetailType:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the AccountDetailType
- name:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- name of the AccountDetailType
- description:
- type: string
- maxLength: 50
- minLength: 1
- description: |
- description of the AccountDetailType
- tableName:
- type: string
- maxLength: 25
- description: |
- table name of the AccountDetailType
- active:
- type: boolean
- description: |
- Whether AccountDetailType is Active or not. If the value is TRUE, then AccountDetailType is active,If the value is FALSE then AccountDetailType is inactive,Default value is TRUE
- fullyQualifiedName:
- type: string
- maxLength: 250
- minLength: 1
- description: |
- fully qualified name of the AccountDetailType
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - name
- - description
- - active
- AccountDetailTypeRequest:
- description: Contract class for web request. Array of AccountDetailType items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- accountDetailTypes:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/AccountDetailType'
- AccountDetailTypeResponse:
- description: Contract class for web response. Array of AccountDetailType items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- accountDetailTypes:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/AccountDetailType'
- page:
- $ref: '#/definitions/Page'
-
- AccountDetailKey:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the AccountDetailKey
- key:
- type: string
- description: |
- key of the AccountDetailKey
- accountDetailType:
- $ref: "#/definitions/AccountDetailType"
- description: |
- account detail type of the AccountDetailKey
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - key
- - accountDetailType
- AccountDetailKeyRequest:
- description: Contract class for web request. Array of AccountDetailKey items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- accountDetailKeys:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/AccountDetailKey'
- AccountDetailKeyResponse:
- description: Contract class for web response. Array of AccountDetailKey items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- accountDetailKeys:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/AccountDetailKey'
- page:
- $ref: '#/definitions/Page'
-
- AccountEntity:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the AccountEntity
- accountDetailType:
- $ref: "#/definitions/AccountDetailType"
- description: |
- account detail type of the AccountEntity
- code:
- type: string
- maxLength: 25
- minLength: 1
- description: |
- code of the AccountEntity
- name:
- type: string
- maxLength: 350
- minLength: 1
- description: |
- name of the AccountEntity
- active:
- type: boolean
- description: |
- Whether AccountEntity is Active or not. If the value is TRUE, then AccountEntity is active,If the value is FALSE then AccountEntity is inactive,Default value is TRUE
- description:
- type: string
- maxLength: 256
- description: |
- description of the AccountEntity
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - accountDetailType
- - code
- - name
- - active
- AccountEntityRequest:
- description: Contract class for web request. Array of AccountEntity items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- accountEntities:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/AccountEntity'
- AccountEntityResponse:
- description: Contract class for web response. Array of AccountEntity items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- accountEntities:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/AccountEntity'
- page:
- $ref: '#/definitions/Page'
-
- AccountCodePurpose:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the AccountCodePurpose
- name:
- type: string
- maxLength: 256
- minLength: 3
- description: |
- name of the AccountCodePurpose
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - name
- AccountCodePurposeRequest:
- description: Contract class for web request. Array of AccountCodePurpose items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- accountCodePurposes:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/AccountCodePurpose'
- AccountCodePurposeResponse:
- description: Contract class for web response. Array of AccountCodePurpose items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- accountCodePurposes:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/AccountCodePurpose'
- page:
- $ref: '#/definitions/Page'
-
- ChartOfAccount:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- id is the Unique Identifier . This data is generated internally
- glcode:
- type: string
- maxLength: 16
- minLength: 1
- description: |
- glcode is the Account Code or Account Head in Accounting terms.It may be
- Major head,Minor head or Detailed head.It is numeric examples are
- 1,110,1101,1101001,2,210,21000,210010
- name:
- type: string
- maxLength: 128
- minLength: 5
- description: |
- name is the name of the account code . for example 110 glcode has the
- name "Tax Revenue"
- accountCodePurpose:
- $ref: "#/definitions/AccountCodePurpose"
- description: |
- accountCodePurpose is the mapped AccountCodePurpose . This mapping can
- happen at any level say Major,minor or detailed. When Account code is
- searched 1. If mapped at major code then it lists major and all other
- codes under that major code 2. If mapped at minor code then it list minor
- code and all other codes under that minor code 3. If mapped at detailed
- code then it lists only that code
- description:
- type: string
- maxLength: 256
- description: |
- description is the more detailed description about the account code
- isActiveForPosting:
- type: boolean
- description: |
- isActiveForPosting true will be considered for transactions. All
- major,minor codes will be false and only detailed code will be true .
- Further any account code can be disabled for transaction by making this
- field false
- parentId:
- type: integer
- format: int64
- description: |
- parentId is the id of other account code in the chart of account .Chart
- of account is created in tree structure. Any code can have other code as
- parent . All minor code will have manjor code as parent . All detailed
- code will have minor code as parent only leaf account code that is which
- is not parent for any account code will used for transactions.
- type:
- type: string
- description: |
- type is a single character representation of account code type I: Income
- E: Expenditure L: Liability A: Asset Account code for all I start with 1
- Account code for all E start with 2 Account code for all L start with 3
- Account code for all A start with 4
- classification:
- type: integer
- format: int64
- description: |
- classification is internal to the system. This tells whether the code is
- Major ,Minor,Subminor or detailed. Major code classification value is 1
- Minor code is 2 Subminor code is 3 Detailed code is 4. Only
- classification 4 and is activeforposting=true will be used in
- transactions. Reports can be generated at any level.
- functionRequired:
- type: boolean
- description: |
- functionRequired field specifies while transacting with this accountcode
- is the function is mandatory or not . For any account code this field is
- set to true then all transactions expect a fun=ction code to be passed
- along with account code
- budgetCheckRequired:
- type: boolean
- description: |
- budgetCheckRequired field specifies whether budgeting check required for
- this account code. Apart from global Budgetcheck configuration this is
- where glcode wise budget check decision is made.
- majorCode:
- type: string
- maxLength: 16
- description: |
- major code of the ChartOfAccount
- isSubLedger:
- type: boolean
- description: |
- is sub ledger of the ChartOfAccount
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - glcode
- - name
- - isActiveForPosting
- - type
- - classification
- - functionRequired
- - budgetCheckRequired
- ChartOfAccountRequest:
- description: Contract class for web request. Array of ChartOfAccount items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- chartOfAccounts:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/ChartOfAccount'
- ChartOfAccountResponse:
- description: Contract class for web response. Array of ChartOfAccount items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- chartOfAccounts:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/ChartOfAccount'
- page:
- $ref: '#/definitions/Page'
-
- ChartOfAccountDetail:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the ChartOfAccountDetail
- chartOfAccount:
- $ref: "#/definitions/ChartOfAccount"
- description: |
- chart of account of the ChartOfAccountDetail
- accountDetailType:
- $ref: "#/definitions/AccountDetailType"
- description: |
- account detail type of the ChartOfAccountDetail
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - chartOfAccount
- - accountDetailType
- ChartOfAccountDetailRequest:
- description: Contract class for web request. Array of ChartOfAccountDetail items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- chartOfAccountDetails:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/ChartOfAccountDetail'
- ChartOfAccountDetailResponse:
- description: Contract class for web response. Array of ChartOfAccountDetail items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- chartOfAccountDetails:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/ChartOfAccountDetail'
- page:
- $ref: '#/definitions/Page'
-
- BudgetGroup:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the BudgetGroup
- name:
- type: string
- maxLength: 250
- minLength: 1
- description: |
- name of the BudgetGroup
- description:
- type: string
- maxLength: 250
- description: |
- description of the BudgetGroup
- majorCode:
- $ref: "#/definitions/ChartOfAccount"
- description: |
- major code of the BudgetGroup
- maxCode:
- $ref: "#/definitions/ChartOfAccount"
- description: |
- max code of the BudgetGroup
- minCode:
- $ref: "#/definitions/ChartOfAccount"
- description: |
- min code of the BudgetGroup
- accountType:
- type: string
- enum:
- - REVENUE_RECEIPTS
- - REVENUE_EXPENDITURE
- - CAPITAL_RECEIPTS
- - CAPITAL_EXPENDITURE
- description: |
- account type of the BudgetGroup
- budgetingType:
- type: string
- enum:
- - ALL
- - DEBIT
- - CREDIT
- description: |
- budgeting type of the BudgetGroup
- active:
- type: boolean
- description: |
- Whether BudgetGroup is Active or not. If the value is TRUE, then BudgetGroup is active,If the value is FALSE then BudgetGroup is inactive,Default value is TRUE
- auditDetails:
- $ref: '#/definitions/Auditable'
- BudgetGroupRequest:
- description: Contract class for web request. Array of BudgetGroup items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- budgetGroups:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/BudgetGroup'
- BudgetGroupResponse:
- description: Contract class for web response. Array of BudgetGroup items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- budgetGroups:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/BudgetGroup'
- page:
- $ref: '#/definitions/Page'
-
- FinancialStatus:
- type: object
- description: |
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the FinancialStatus
- moduleType:
- type: string
- maxLength: 50
- minLength: 3
- description: |
- module type of the FinancialStatus
- code:
- type: string
- maxLength: 20
- minLength: 3
- description: |
- code of the FinancialStatus
- name:
- type: string
- maxLength: 20
- minLength: 3
- description: |
- name of the FinancialStatus
- description:
- type: string
- maxLength: 250
- minLength: 3
- description: |
- description of the FinancialStatus
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - moduleType
- - code
- - name
- - description
- FinancialStatusRequest:
- description: Contract class for web request. Array of FinancialStatus items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- financialStatuses:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/FinancialStatus'
- FinancialStatusResponse:
- description: Contract class for web response. Array of FinancialStatus items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- financialStatuses:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/FinancialStatus'
- page:
- $ref: '#/definitions/Page'
-
- FinancialConfiguration:
- type: object
- description: |
- what s
-
- properties:
- id:
- type: string
- description: |
- Unique Identifier of the FinancialConfiguration
- name:
- type: string
- maxLength: 50
- minLength: 3
- description: |
- name of the FinancialConfiguration
- description:
- type: string
- maxLength: 250
- minLength: 3
- description: |
- description of the FinancialConfiguration
- module:
- type: string
- maxLength: 50
- minLength: 3
- description: |
- module of the FinancialConfiguration
- auditDetails:
- $ref: '#/definitions/Auditable'
- required:
- - id
- - description
- - module
- FinancialConfigurationRequest:
- description: Contract class for web request. Array of FinancialConfiguration items are used in case of create or update
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- financialConfigurations:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/FinancialConfiguration'
- FinancialConfigurationResponse:
- description: Contract class for web response. Array of FinancialConfiguration items are used in case of search ,create or update request.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- financialConfigurations:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/FinancialConfiguration'
- page:
- $ref: '#/definitions/Page'
-
- parameters:
- pageSize:
- name: pageSize
- type: integer
- format: int32
- in: query
- description: pageSize
- offset:
- name: offset
- type: integer
- format: int32
- in: query
- description: offset
-
\ No newline at end of file
diff --git a/business-services/Docs/egov-apportion-service.yml b/business-services/Docs/egov-apportion-service.yml
deleted file mode 100644
index dd771cafe85..00000000000
--- a/business-services/Docs/egov-apportion-service.yml
+++ /dev/null
@@ -1,315 +0,0 @@
-swagger: "2.0"
-info:
- version: 1.0.1
- title: Apportion Servcie
- description: Apportions the paid amount to respective tax heads.
- contact:
- name: eGovernments Foundation
- email: contact@egovernments.org
-
-schemes:
- - https
-basePath: '/apportion'
-x-common-path: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml'
-
-paths:
- /_apportion:
- post:
- summary: Divides the paid amount amoung the tax heads
- description: This API divides the amount paid according to priority
- of the tax heads
- parameters:
- - name: ApportionRequest
- in: body
- description: Receipt Creation Details passed with bill info and instrument info along with common request info.
- required: true
- schema:
- $ref: '#/definitions/ApportionRequest'
- tags:
- - Receipt
- responses:
- '201':
- description: Receipt created sucessfully.
- schema:
- $ref: '#/definitions/ApportionResponse'
- '400':
- description: Invalid input.
-
-
-definitions:
- ApportionRequest:
- type: object
- description: Receipt Request with Request Info.
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- tenantId:
- type: string
- description: Unique id of tenant.
- format: varchar
- businessService:
- type: string
- description: BusinessService of the module
- format: varchar
- Bills:
- type: array
- items:
- $ref: '#/definitions/BillInfo'
-
- ApportionResponse:
- type: object
- description: Receipt Request with Request Info.
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- tenantId:
- type: string
- description: Unique id of tenant.
- format: varchar
- Bills:
- type: array
- items:
- $ref: '#/definitions/BillInfo'
-
- BillInfo:
- type: object
- properties:
- id:
- type: number
- description: id of the billInfo object
- payeerName:
- type: string
- description: Owner/User which needs to be referred from UserService.
- payeerAddress:
- type: string
- description: Consumer address defined in bill.
- payeerEmail:
- type: string
- description: Consumer email defined in bill.
- paidBy:
- type: string
- description: Name of the Person who is making payment.
- isActive:
- type: boolean
- description: active status of the bill.
- isCancelled:
- type: boolean
- description: cancellation state of the bill.
- tenantId:
- type: string
- description: Tenant Id.
- mobileNumber:
- type: string
- description: Consumer mobileNumber defined in bill.
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- billDetails:
- type: array
- items:
- $ref: '#/definitions/BillDetails'
- collectionMap:
- type: object
- properties:
- default:
- type: string
- required:
- - default
- additionalProperties:
- type: number
- additionalDetails:
- type: object
-
- BillDetails:
- type: object
- properties:
- id:
- type: number
- description: id of the BillDetails object
- bill:
- type: string
- description: Bill.
- demandId:
- type: string
- description: Bill.
- billDate:
- type: integer
- format: int64
- description: Bill date.
- billNumber:
- type: string
- description: Bill Number.
- consumerCode:
- type: string
- description: Consumer code defined in bill.
- consumerType:
- type: string
- description: Consumer type defined in bill.
- billDescription:
- type: string
- description: Summarized bill description.
- minimumAmount:
- type: number
- format: bigdecimal
- description: Minimum bill amount to be paid.
- totalAmount:
- type: number
- format: bigdecimal
- description: Total bill amount to be paid.
- collectedAmount:
- type: number
- format: bigdecimal
- description: Total bill amount to be paid.
- amountPaid:
- type: number
- format: double
- description: Amount paid by the citizen.
- collectionModesNotAllowed:
- type: array
- items:
- type: string
- description: List of collection modes not allowed.
- event:
- type: string
- description: CREATED, CANCELLED, INSTRUMENT_BOUNCED
- receiptNumber:
- type: string
- description: Receipt Number generated in Collection system.
- receiptDate:
- type: string
- format: date
- description: Receipt Date.
- receiptType:
- description: Type of Receipt.
- items:
- type: string
- enum:
- - ADHOC
- - BILLBASED
- - CHALLAN
- collectionType:
- description: Type of collection.
- items:
- type: string
- enum:
- - COUNTER
- - FIELD
- - ONLINE
- channel:
- type: string
- description: To be used by third party applications, to send the channel name.
- fund:
- type: string
- description: To be used by third party applications, to send the channel name.
- department:
- type: string
- description: To be used by third party applications, to send the channel name.
- function:
- type: string
- description: To be used by third party applications, to send the channel name.
- voucherHeader:
- description: Voucher header need to refer from Finanicals.
- boundary:
- description: Boundary need to refer from Core services.
- items:
- type: string
- reasonForCancellation:
- description: Remarks to describe Reason For Cancellation.
- items:
- type: string
- cancellationRemarks:
- description: Remarks to describe Reason For Cancellation.
- items:
- type: string
- status:
- description: Status of the BillDetail.
- items:
- type: string
- displayMessage:
- type: string
- description: Remarks to be displayed on receipt.
- tenantId:
- type: string
- description: Tenant Id.
- businessService:
- type: string
- description: businessService details of the bill details.
- callBackForApportioning:
- type: boolean
- description: apportioning call based on this value.
- partPaymentAllowed:
- type: boolean
- description: decides if partpayment is allowed
- manualReceiptNumber:
- type: string
- description: Manual Receipt Number for legacy reciepts.
- manualReceiptDate:
- type: integer
- format: int64
- description: Manual Receipt Date for legacy reciepts.
- stateId:
- type: integer
- description: State id of receipt. Value is set while pushing to kafka from collection workflow and to read in collection services.
- billAccountDetails:
- type: array
- items:
- $ref: '#/definitions/BillAccountDetails'
- fromPeriod:
- type: number
- format: int64
- description: starting date of the demand period referred by the bill detail.
- toPeriod:
- type: number
- format: int64
- description: ending date of the demand period referred by the bill detail.
- additionalDetails:
- type: object
-
-
- BillAccountDetails:
- type: object
- properties:
- id:
- type: number
- description: id of the BillAccountDetails object
- glcode:
- type: string
- description: Chart of account code.
- order:
- type: integer
- format: int32
- description : Order number used for apportioning amount in case of part payment.
- amount:
- type: number
- format: double
- description: Credit account head amount to be paid.
- adjustedAmount:
- type: number
- format: double
- description: Credit account head amount.
- isActualDemand:
- type: boolean
- description: True for tax/charges/penalty. False for advances(if any).
- tenantId:
- type: string
- description: Tenant Id.
- billDetail:
- type: string
- description: Bill Details.
- demandDetailId:
- type: string
- description: unique id of the demand detail object.
- purpose:
- description: Purpose of Account head.
- items:
- type: string
- enum:
- - ARREAR_AMOUNT
- - CURRENT_AMOUNT
- - ADVANCE_AMOUNT
- - ARREAR_LATEPAYMENT_CHARGES
- - CURRENT_LATEPAYMENT_CHARGES
- - CHEQUE_BOUNCE_PENALTY
- - REBATE
- - OTHERS
- additionalDetails:
- type: object
\ No newline at end of file
diff --git a/business-services/billing-service/README.md b/business-services/billing-service/README.md
index 6396166ce9d..8a4c7d0d86c 100644
--- a/business-services/billing-service/README.md
+++ b/business-services/billing-service/README.md
@@ -15,7 +15,7 @@ NA
### Swagger API Contract
-https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/business-services/Docs/billingservice/V-2.0.yml
+https://raw.githubusercontent.com/egovernments/business-services/master/Docs/billingservice/V-2.0.yml
## Service Details
diff --git a/business-services/collection-services/README.md b/business-services/collection-services/README.md
index 975c585832c..0cf8fe347dc 100644
--- a/business-services/collection-services/README.md
+++ b/business-services/collection-services/README.md
@@ -19,7 +19,7 @@ NA
### Swagger API Contract
- https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/business-services/Docs/collection-services/V-2-0.yml#!/
+ https://raw.githubusercontent.com/egovernments/business-services/finance_master_readme/Docs/collection-services/V-2-0.yml
## Service Details
diff --git a/business-services/dashboard-analytics/README.md b/business-services/dashboard-analytics/README.md
index f993195af4c..abb7b14ea94 100644
--- a/business-services/dashboard-analytics/README.md
+++ b/business-services/dashboard-analytics/README.md
@@ -32,7 +32,7 @@ by defining insight in the chartAPI configuration for the required chart.
### Resources
-- Granular details about the API's can be found in the [swagger api definition](https://raw.githubusercontent.com/egovernments/DIGIT-OSS/doc-patch/business-services/Docs/dss-dashboard/DSS%20Analytics%20Dashboard%20YAML%20Spec%201.0.0.yaml)
+- Granular details about the API's can be found in the [swagger api definition](https://raw.githubusercontent.com/egovernments/business-services/master/Docs/dss-dashboard/DSS%20Analytics%20Dashboard%20YAML%20Spec%201.0.0.yaml)
- Postman collection for all the API's can be found in the [postman collection](https://www.getpostman.com/collections/0894f347322bed5bea1a)
diff --git a/business-services/dashboard-ingest/README.md b/business-services/dashboard-ingest/README.md
index 0732781d93e..f6ac05b8f7d 100644
--- a/business-services/dashboard-ingest/README.md
+++ b/business-services/dashboard-ingest/README.md
@@ -12,7 +12,7 @@ Dashboard-Ingest module runs as a pipeline and manages to validate, transform an
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/business-services/Docs/dss-dashboard/DSS%20Ingest%20YAML%20Spec%201.0.0.yaml) for dashboard-ingest to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://raw.githubusercontent.com/egovernments/business-services/master/Docs/dss-dashboard/DSS%20Ingest%20YAML%20Spec%201.0.0.yaml) for dashboard-ingest to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/business-services/egf-master/README.md b/business-services/egf-master/README.md
index 1d82ab8e4bb..4c5b7fdf664 100644
--- a/business-services/egf-master/README.md
+++ b/business-services/egf-master/README.md
@@ -12,7 +12,7 @@ NA
### Swagger API Contract
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/business-services/Docs/egf-master-v1.0.0%20.yaml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/financials/contracts/egf-master/v1-0-0.yml#!/
## Service Details
diff --git a/business-services/egov-apportion-service/README.md b/business-services/egov-apportion-service/README.md
index b7b09daa484..f8d6cda415e 100644
--- a/business-services/egov-apportion-service/README.md
+++ b/business-services/egov-apportion-service/README.md
@@ -38,7 +38,7 @@ The apportion request and respose are stored for audit using persister
### Resources
-- Granular details about the API's can be found in the [swagger api definition](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/business-services/Docs/egov-apportion-service.yml#!/)
+- Granular details about the API's can be found in the [swagger api definition](https://raw.githubusercontent.com/egovernments/docs/collections/contracts/apportion/egov-apportion-service.yml)
- Postman collection for all the API's can be found in the [postman collection](https://raw.githubusercontent.com/egovernments/egov-services/core/egov-apportion-service/Apportion.postman_collection.json)
diff --git a/business-services/egov-hrms/README.md b/business-services/egov-hrms/README.md
index 245f0b3d807..ceb2f235664 100644
--- a/business-services/egov-hrms/README.md
+++ b/business-services/egov-hrms/README.md
@@ -14,7 +14,7 @@ The objective of HRMS is to provide a service that manages all the employees enr
- egov-filestore
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/doc-patch/business-services/Docs/hrms-v1.0.0.yaml#!/) for HRMS service to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/business-services/master/Docs/hrms-v1.0.0.yaml#!/) for HRMS service to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/core-services/chatbot/README.md b/core-services/chatbot/README.md
index 8b3da95280f..68f225ceb05 100644
--- a/core-services/chatbot/README.md
+++ b/core-services/chatbot/README.md
@@ -19,7 +19,7 @@ Chatbot service is a chatbot which provides functionality to the user to access
### Swagger API Contract
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/chatbot-contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/core-services/RAIN-1288/docs/chatbot-contract.yml#!/
## Service Details
diff --git a/core-services/docs/access-control-contract.yml b/core-services/docs/access-control-contract.yml
deleted file mode 100644
index f028825af39..00000000000
--- a/core-services/docs/access-control-contract.yml
+++ /dev/null
@@ -1,683 +0,0 @@
-# Example YAML to get you started quickly.
-# Be aware that YAML has indentation based scoping.
-# Code completion support is available so start typing for available options.
-swagger: '2.0'
-
-# This is your document metadata
-info:
- version: "1.0.1"
- title: Access Control APIs
- description: All APIs available from Access Control services.
- contact:
- name: eGov
- email: info@egovernments.org
-
-# Describe your paths here
-paths:
- # This is a path endpoint. Change it.
- /access/v1/actions/_search:
- # This is a HTTP operation
- post:
- # Describe this verb here. Note: you can use markdown
- summary: Get the list of actions based on either roles or features.
- description: |
- Get the list of actions based on the input parameters.
- # This is array of GET operation parameters:
- parameters:
- - name: requestInfo
- in: body
- description: Request info for getting actions.
- required: true
- schema:
- $ref: '#/definitions/RequestInfo'
- - name: roles
- in: query
- required: false
- description: The list of role codes.
- type: array
- items:
- type: string
- format: int64
- - name: features
- in: query
- required: false
- description: The list of feature id's.
- type: array
- items:
- type: integer
- format: int64
- # Expected responses for this operation:
- responses:
- # Response code
- 200:
- description: Successful response
- # A schema describing your response object.
- # Use JSON Schema format
- schema:
- $ref: "#/definitions/ActionResponse"
- '400':
- description: Invalid input.
- schema:
- $ref: '#/definitions/ErrorRes'
- tags:
- - Action
-
- #####################################################
- /access/v1/actions/_create:
- # This is a HTTP operation
- post:
- # Describe this verb here. Note: you can use markdown
- summary: Create a new action.
- description: |
- To create new action(s) in the system. An action entry is required for each and every path to authenticate the access based on the assigned role of an user.
- parameters:
- - name: actionRequest
- in: body
- description: Details for the new Action(s) entry + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/ActionRequest'
- # Expected responses for this operation:
- responses:
- # Response code
- '200':
- description: Action(s) created sucessfully
- # A schema describing your response object.
- # Use JSON Schema format
- schema:
- $ref: "#/definitions/ActionResponse"
- '400':
- description: Action(s) creation failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - Action
- #####################################################
- /access/v1/actions/_update:
- # This is a HTTP operation
- put:
- # Describe this verb here. Note: you can use markdown
- summary: Update existing action(s).
- description: |
- To update the existing action(s) in the system.
- parameters:
- - name: actionRequest
- in: body
- description: Details for the Action(s) entry with new values + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/ActionRequest'
- # Expected responses for this operation:
- responses:
- # Response code
- '200':
- description: Update action(s) successful
- # A schema describing your response object.
- # Use JSON Schema format
- schema:
- $ref: "#/definitions/ActionResponse"
- '400':
- description: Update action(s) failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - Action
- #####################################################
- /access/v1/actions/_validate:
- # This is a HTTP operation
- post:
- # Describe this verb here. Note: you can use markdown
- summary: Validate a particular action for a given tenant and roles of the tenant
- description: |
- Validate a particular action for a given tenant and roles of the tenant.
- parameters:
- - name: ValidateActionReq
- in: body
- description: Request info for getting actions.
- required: true
- schema:
- $ref: '#/definitions/ValidateActionReq'
- # Expected responses for this operation:
- responses:
- # Response code
- 200:
- description: Successful response without any content
- schema:
- $ref: '#/definitions/ValidateActionRes'
- '400':
- description: Invalid input.
- schema:
- $ref: '#/definitions/ErrorRes'
- tags:
- - Action
-
- /access/v1/feature-role/_create:
- # This is a HTTP operation
- post:
- # Describe this verb here. Note: you can use markdown
- summary: Create mapping for feature and role.
- description: |
- Create mapping for feature and role.
- parameters:
- - name: featureRoleRequest
- in: body
- description: Request info for getting actions.
- required: true
- schema:
- $ref: '#/definitions/FeatureRoleReq'
- # Expected responses for this operation:
- responses:
- # Response code
- 200:
- description: Successful response
- # A schema describing your response object.
- # Use JSON Schema format
- schema:
- $ref: "#/definitions/FeatureRoleRes"
- '400':
- description: Invalid input.
- schema:
- $ref: '#/definitions/ErrorRes'
- tags:
- - Feature-Role
-
- /access/v1/roles/_search:
- # This is a HTTP operation
- post:
- # Describe this verb here. Note: you can use markdown
- summary: Get the list of roles based on role codes.
- description: |
- Get the list of roles based on role codes in the input parameters.
- # This is array of GET operation parameters:
- parameters:
- - name: rolesReq
- in: body
- description: Request info for getting actions.
- required: true
- schema:
- $ref: '#/definitions/RolesReq'
- - name: code
- in: query
- required: false
- description: The list of comma separated codes to filter Roles against. No providing any would end up in all Roles as there is nothing to filter against
- type: array
- items:
- type: string
- format: int64
- # Expected responses for this operation:
- responses:
- # Response code
- 200:
- description: Successful response
- # A schema describing your response object.
- # Use JSON Schema format
- schema:
- $ref: "#/definitions/RoleResponse"
- '400':
- description: Invalid input.
- schema:
- $ref: '#/definitions/ErrorRes'
- tags:
- - Feature-Role
- #####################################################
- /access/v1/roles/_create:
- # This is a HTTP operation
- post:
- # Describe this verb here. Note: you can use markdown
- summary: Create a new role.
- description: |
- To create new Role(s) in the system.
- parameters:
- - name: roleRequest
- in: body
- description: Details for the new role(s) + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/RoleRequest'
- # Expected responses for this operation:
- responses:
- # Response code
- '200':
- description: Role(s) created sucessfully
- # A schema describing your response object.
- # Use JSON Schema format
- schema:
- $ref: "#/definitions/RoleResponse"
- '400':
- description: Role(s) creation failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - Role
- #####################################################
- /access/v1/roles/_update:
- # This is a HTTP operation
- put:
- # Describe this verb here. Note: you can use markdown
- summary: Update existing role(s).
- description: |
- To update the existing role(s) in the system.
- parameters:
- - name: roleRequest
- in: body
- description: Details for the Role(s) entry with new values + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/RoleRequest'
- # Expected responses for this operation:
- responses:
- # Response code
- '200':
- description: Update role(s) successful
- # A schema describing your response object.
- # Use JSON Schema format
- schema:
- $ref: "#/definitions/RoleResponse"
- '400':
- description: Update role(s) failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - Role
- #####################################################
- /access/v1/role-actions/_create:
- # This is a HTTP operation
- post:
- # Describe this verb here. Note: you can use markdown
- summary: Create mapping for role and action(s).
- description: |
- Create mapping for role and action(s).
- parameters:
- - name: roleActionsRequest
- in: body
- description: Details for the Role and Action(s) mapping + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/RoleActionsRequest'
- # Expected responses for this operation:
- responses:
- # Response code
- '200':
- description: Role - Action(s) mapping created sucessfully
- # A schema describing your response object.
- # Use JSON Schema format
- schema:
- $ref: "#/definitions/RoleActionsResponse"
- '400':
- description: Role - Action(s) mapping failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - Role-Action
- #####################################################
-definitions:
-
- Action:
- type: object
- properties:
- id:
- type: integer
- format: int64
- description : Unique identifier of the Action.
- name:
- type: string
- description: The Name of the Action.
- minLength: 2
- maxLength: 100
- queryParams:
- type: string
- description: The Name of the Action.
- minLength: 5
- maxLength: 100
- url:
- type: string
- description: The string url for the action.
- minLength: 10
- maxLength: 100
- parentModule:
- type: integer
- format: int64
- description : Unique identifier of the Parent.
- orderNumber:
- type: integer
- format: int64
- description : Defines order for actions.
- displayName:
- type: string
- description: The Name which is used for displaying.
- minLength: 2
- maxLength: 100
- enabled:
- type: boolean
- description: True if the action is required and False if the action is not required.
- createdBy:
- type: integer
- format: int64
- description: Id of the user who created the record.
- createdDate:
- type: string
- format: date
- description: Date on which the role master data was added into the system.
- lastModifiedBy:
- type: integer
- format: int64
- description: Id of the user who last modified the record.
- lastModifiedDate:
- type: string
- format: date
- description: Date on which the role master data was last modified.
- tenantId:
- type: string
- description: Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
- serviceCode:
- type: integer
- format: int64
- description : Defines service code.
- required:
- - name
- - tenantId
-
- Feature:
- type: object
- properties:
- id:
- type: integer
- format: int64
- description : Unique identifier of the Action.
- code:
- type: integer
- format: int32
- description : Unique code for service.
- name:
- type: string
- description: The Name of the Action.
- minLength: 2
- maxLength: 100
- description:
- type: string
- description: Description of the Feature.
- minLength: 2
- maxLength: 100
- serviceCode:
- type: integer
- format: int64
- description : Defines service code.
- tenantId:
- type: string
- description: Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
- required:
- - name
- - code
- - tenantId
-
- Role:
- type: object
- properties:
- id:
- type: integer
- format: int64
- description : Unique identifier of the role.
- name:
- type: string
- description: The Name of the Role.
- minLength: 2
- maxLength: 100
-
- RoleAction:
- type: object
- properties:
- roleCode:
- type: string
- description : The Role Code which is mapped for the action.
- actionId:
- type: integer
- format: int64
- description: The Id of the Action which is mapped to the role.
- tenantId:
- type: string
- description: Unique Identifier of the tenant to which the role action mapping is done.
-
- ActionRequest:
- type: object
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- actions:
- type: array
- minimum: 1
- maximum: 100
- items:
- $ref: "#/definitions/Action"
- required:
- - requestInfo
- - actions
-
- ActionResponse:
- type: object
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- actions:
- type: array
- maximum: 500
- items:
- $ref: '#/definitions/Action'
-
- RoleRequest:
- type: object
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- roles:
- type: array
- minimum: 1
- maximum: 100
- items:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/Role'
- required:
- - requestInfo
- - roles
-
- RoleResponse:
- type: object
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- roles:
- type: array
- maximum: 500
- items:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/Role'
-
- RoleActionsRequest:
- type: object
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- role:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/Role'
- actions:
- type: array
- minimum: 1
- maximum: 100
- items:
- $ref: '#/definitions/Action'
- tenantId:
- type: string
- description: Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
- required:
- - role
- - actions
- - tenantId
-
- RoleActionsResponse:
- type: object
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- roleActions:
- type: array
- maximum: 500
- items:
- $ref: '#/definitions/RoleAction'
-
- FeatureRoleReq:
- type: object
- properties:
- RequestInfo:
- $ref: '#/definitions/RequestInfo'
- roleId:
- type: string
- description: List of Role Id to be provided for mapping it to feature.
- feature:
- $ref: '#/definitions/Feature'
- tenantId:
- type: string
- description: Unique Identifier of the tenant, Like AP, AP.Kurnool etc.
- required:
- - roleId
- - feature
- - tenantId
-
- ValidateAction:
- type: object
- properties:
- tenantRole:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/TenantRole'
- actionUrl:
- type: string
- description: Url of the action to be validated for given tenant
- required:
- - tenantRole
- - actionUrl
-
- ValidateActionReq:
- type: object
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- validateAction:
- $ref: '#/definitions/ValidateAction'
-
- FeatureRoleRes:
- type: object
- properties:
- RequestInfo:
- $ref: '#/definitions/ResponseInfo'
- role:
- $ref: '#/definitions/Role'
- feature:
- $ref: '#/definitions/Feature'
-
- RolesReq:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
-
- RequestInfo:
- type: object
- properties:
- apiId:
- type: string
- description: unique API ID
- ver:
- type: string
- description: API version
- ts:
- type: string
- description: >-
- response timestamp YYYY-MM-DDThh:mm:ss+/-nn:nn (timezone defaulted to
- +5.30)
- action:
- type: string
- description: api action like GET/POST/PUT/DELETE in case of http calls
- did:
- type: string
- description: device UUID from which API is called
- key:
- type: string
- description: API key (dynamic)
- msgId:
- type: string
- description: 'unique request message id, UUID, for handling API idempotency'
- requesterId:
- type: string
- description: UserId of the user calling
- authToken:
- type: string
- description: //session/jwt/saml token/oauth token
- required:
- - apiId
- - ver
- - ts
-
- ResponseInfo:
- type: object
- properties:
- apiId:
- type: string
- description: unique API ID
- ver:
- type: string
- description: API version
- ts:
- type: string
- description: >-
- response timestamp YYYY-MM-DDThh:mm:ss+/-nn:nn (timezone defaulted to
- +5.30)
- resMsgId:
- type: string
- description: unique response message id (UUID)
- msgId:
- type: string
- description: message id of the request
- status:
- type: string
- description: 'status of request e.g. successful, failed etc'
- required:
- - apiId
- - ver
- - ts
- - status
-
- Error:
- type: object
- properties:
- code:
- type: integer
- format: int32
- message:
- type: string
- description:
- type: string
- fields:
- type: object
- required:
- - code
- - message
-
- ActionValidation:
- type: object
- properties:
- allowed:
- type: string
- enum: ["TRUE", "FALSE"]
- required:
- - allowed
-
- ErrorRes:
- properties:
- responseInfo:
- $ref: '#/definitions/ResponseInfo'
- error:
- $ref: '#/definitions/Error'
- type: object
-
- ValidateActionRes:
- properties:
- responseInfo:
- $ref: '#/definitions/ResponseInfo'
- actionValidation:
- $ref: '#/definitions/ActionValidation'
- type: object
\ No newline at end of file
diff --git a/core-services/docs/common-contract.yml b/core-services/docs/common-contract.yml
index 1195a5cf602..aca93f4f7d4 100644
--- a/core-services/docs/common-contract.yml
+++ b/core-services/docs/common-contract.yml
@@ -1,462 +1,289 @@
-openapi: 3.0.0
+swagger: '2.0'
info:
- version: "1.0.0"
+ version: 1.0.0
title: Common Object Definitions
- description: Definitions of common objects used across the modules. These objects
- will/may be commonly used by all eGov API deicitions. There are no paths
- defined in this spec as these objects cannot be used solely on their own.
+ description: Definitions of common objects used across the modules. These objects will/may be commonly used by all eGov API deicitions. There are no paths defined in this spec as these objects cannot be used solely on their own.
contact:
- name: eGov
+ name: eGov
email: info@egovernments.org
+host: phoenix-qa.egovernments.org
+
+schemes:
+ - https
+basePath: '/common/v1/definitions'
+
paths: {}
-servers:
- # Added by API Auto Mocking Plugin
- - description: SwaggerHub API Auto Mocking
- url: https://virtserver.swaggerhub.com/talele08/common/1.0.0
- - url: https://phoenix-qa.egovernments.org/common/v1/definitions
-components:
- parameters:
- tenantId:
- name: tenantId
- in: query
- description: Unique id for a tenant.
- required: true
- schema:
- type: string
- format: varchar
- lastChangedSince:
- name: lastChangedSince
- description: >
- epoch of the time since when the changes on the object should be picked
- up. Search results from this parameter should include both newly created
- objects since this time as well as any modified objects since this time.
- This criterion is included to help polling clients to get the changes in
- system since a last time they synchronized with the platform.
- in: query
- required: false
- schema:
+
+parameters:
+ requestInfo:
+ name: requestInfo
+ description: Parameter to carry Request metadata in the request body
+ in: body
+ required: false
+ schema:
+ $ref: '#/definitions/RequestInfo'
+
+ tenantId:
+ name: tenantId
+ in: query
+ description: Unique id for a tenant.
+ required: true
+ type: string
+ format: varchar
+
+ lastChangedSince:
+ name: lastChangedSince
+ description: |
+ epoch of the time since when the changes on the object should be picked up. Search results from this parameter should include both newly created objects since this time as well as any modified objects since this time. This criterion is included to help polling clients to get the changes in system since a last time they synchronized with the platform.
+ in: query
+ required: false
+ type: integer
+ format: int64
+
+
+definitions:
+ RequestInfo:
+ type: object
+ description: RequestInfo should be used to carry meta information about the requests to the server as described in the fields below. All eGov APIs will use requestinfo 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 ResponseInfo in the response body to ensure correlation.
+ properties:
+ apiId:
+ type: string
+ description: unique API ID
+ maxLength: 128
+ ver:
+ type: string
+ description: API version - for HTTP based request this will be same as used in path
+ maxLength: 32
+ ts:
type: integer
format: int64
- schemas:
- RequestHeader:
- type: object
- description: 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.
- properties:
- apiInfo:
- $ref: "#/components/schemas/APIInfo"
- deviceDetail:
- $ref: "#/components/schemas/DeviceDetail"
- ts:
- type: integer
- format: int64
- description: time in epoch
- action:
- type: string
- description: API action to be performed like _create, _update, _search (denoting
- POST, PUT, GET) or _oauth etc
- maxLength: 32
- key:
- type: string
- description: API key (API key provided to the caller in case of server to server
- communication)
- maxLength: 256
- msgId:
- type: string
- description: Unique request message id from the caller
- maxLength: 256
- requesterId:
- type: string
- description: UserId of the user calling
- maxLength: 256
- authToken:
- type: string
- description: //session/jwt/saml token/oauth token - the usual value that would go
- into HTTP bearer token
- userInfo:
- $ref: "#/components/schemas/UserInfo"
- correlationId:
- type: string
- readOnly: true
- signature:
- type: string
- description: Hash describing the current RequestHeader
- required:
- - apiId
- - ver
- - ts
- - msgId
- - action
- UserInfo:
- type: object
- description: This is acting ID token of the authenticated user on the server. Any
- value provided by the clients will be ignored and actual user based on
- authtoken will be used on the server.
- readOnly: true
- properties:
- tenantId:
- type: string
- description: Unique Identifier of the tenant to which user primarily belongs
- uuid:
- type: string
- description: System Generated User id of the authenticated user.
- userName:
- type: string
- description: Unique user name of the authenticated user
- password:
- type: string
- description: password of the user.
- idToken:
- type: string
- description: This will be the OTP.
- mobile:
- type: string
- description: mobile number of the autheticated user
- email:
- type: string
- description: email address of the authenticated user
- primaryrole:
- type: array
- description: List of all the roles for the primary tenant
- items:
- $ref: "#/components/schemas/Role"
- additionalroles:
- type: array
- description: array of additional tenantids authorized for the authenticated user
- items:
- $ref: "#/components/schemas/TenantRole"
- required:
- - tenantId
- - userName
- - primaryrole
- Role:
- type: object
- description: >
- minimal representation of the Roles in the system to be carried along in
- UserInfo with RequestHeader meta data. Actual authorization service to
- extend this to have more role related attributes
- properties:
- name:
- type: string
- description: Unique name of the role
- maxLength: 64
- code:
- type: string
- description: Unique code of the role
- maxLength: 64
- tenantId:
- type: string
- description: The tenantId for which the role is available
- maxLength: 64
- description:
- type: string
- description: brief description of the role
- required:
- - code
- - tenantId
- TenantRole:
- type: object
- description: User role carries the tenant related role information for the user. A
- user can have multiple roles per tenant based on the need of the tenant.
- A user may also have multiple roles for multiple tenants.
- properties:
- tenantId:
- type: string
- description: tenantid for the tenant
- roles:
- type: array
- description: Roles assigned for a particular tenant - array of role codes/names
- items:
- $ref: "#/components/schemas/Role"
- required:
- - tenantId
- - roles
- ResponseHeader:
- type: object
- readOnly: true
- description: 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.
- properties:
- ts:
- type: integer
- format: int64
- description: response time in epoch
- resMsgId:
- type: string
- description: unique response message id (UUID) - will usually be the correlation
- id from the server
- maxLength: 256
- msgId:
- type: string
- description: message id of the request
- maxLength: 256
- status:
- type: string
- description: status of request processing
- enum:
- - COMPLETED
- - ACCEPTED
- - FAILED
- signature:
- type: string
- description: Hash describing the current ResponseHeader
- error:
- type: object
- $ref:
- "#/components/schemas/Error"
- description: Error detail from API
- information:
- type: object
- description: Additional information from API
- debug:
- type: object
- description: Debug information when requested
- additionalInfo:
- type: object
- description: Any additional information if required e.g. status url (to find out the current status of an asynchronous processing response), additional links to perform special functions like file
- uploads etc.
- required:
- - resMsgId
- - msgId
- - status
- Error:
- type: object
- description: Error object will be returned as a part of reponse body in conjunction
- with ResponseHeader as part of ErrorResponse whenever the request
- processing status in the ResponseHeader is FAILED. HTTP return in this
- scenario will usually be HTTP 400.
- properties:
- code:
- type: string
- description: Error Code will be module specific error label/code to identiffy the
- error. All modules should also publish the Error codes with their
- specific localized values in localization service to ensure clients
- can print locale specific error messages. Example for error code
- would be User.NotFound to indicate User Not Found by
- User/Authentication service. All services must declare their
- possible Error Codes with brief description in the error response
- section of their API path.
- message:
- type: string
- description: English locale message of the error code. Clients should make a
- separate call to get the other locale description if configured with
- the service. Clients may choose to cache these locale specific
- messages to enhance performance with a reasonable TTL (May be
- defined by the localization service based on tenant + module
- combination).
- description:
- type: string
- description: Optional long description of the error to help clients take remedial
- action. This will not be available as part of localization service.
- params:
- type: array
- description: Some error messages may carry replaceable fields (say $1, $2) to
- provide more context to the message. E.g. Format related errors may
- want to indicate the actual field for which the format is invalid.
- Client's should use the values in the param array to replace those
- fields.
- items:
- type: string
- required:
- - code
- - message
- ErrorRes:
- type: object
- description: All APIs will return ErrorRes in case of failure which will carry
- ResponseHeader as metadata and Error object as actual representation of
- error. In case of bulk apis, some apis may chose to return the array of
- Error objects to indicate individual failure.
- properties:
- ResponseHeader:
- $ref: "#/components/schemas/ResponseHeader"
- Errors:
- description: Error response array corresponding to Request Object array. In case
- of single object submission or _search related paths this may be an
- array of one error element
- type: array
- minLength: 1
- items:
- $ref: "#/components/schemas/Error"
- required:
- - ResponseHeader
- Address:
- type: object
- description: >
- Representation of a address. Indiavidual APIs may choose to extend from
- this using allOf if more details needed to be added in their case.
- properties:
- tenantId:
- type: string
- description: Unique Identifier of the tenant to which user primarily belongs
- doorNo:
- type: string
- description: House number or door number.
- plotNo:
- type: string
- description: Plot number of the house.
- id:
- type: string
- description: System generated id for the address
- readOnly: true
- landmark:
- description: additional landmark to help locate the address
- type: string
- city:
- description: City of the address. Can be represented by the tenantid itself
- type: string
- district:
- description: The district in which the property is located
- type: string
- region:
- description: The Region in which the property is located
- type: string
- state:
- description: The State in which the property is located
- type: string
- country:
- description: The country in which the property is located
- type: string
- pincode:
- type: string
- description: PIN code of the address. Indian pincodes will usually be all numbers.
- additionDetails:
- type: string
- description: more address detail as may be needed
- buildingName:
- type: string
- description: Name of the building
- maxLength: 64
- minLength: 2
- street:
- type: string
- description: Street Name
- maxLength: 64
- minLength: 2
- locality:
- $ref: https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-location/contracts/v11-0-0.yml#/definitions/Boundary
- geoLocation:
- $ref: '#/components/schemas/GeoLocation'
- required:
- - tenantId
- - locality
- AuditDetails:
- type: object
- description: Collection of audit related fields used by most models
- readOnly: true
- properties:
- createdBy:
- type: string
- description: username (preferred) or userid of the user that created the object
- lastModifiedBy:
- type: string
- description: username (preferred) or userid of the user that last modified the
- object
- createdTime:
- type: integer
- format: int64
- description: epoch of the time object is created
- lastModifiedTime:
- type: integer
- format: int64
- description: epoch of the time object is last modified
-
- APIInfo:
- type: object
- description: Info of the API being called
- properties:
- id:
- type: string
- description: The id of the API being called
- maxLength: 64
- minLength: 2
- version:
- type: string
- description: The version of the API
- maxLength: 64
- minLength: 2
- path:
- type: string
- description: The URI of the API
+ description: time in epoch
+ action:
+ type: string
+ description: API action to be performed like _create, _update, _search (denoting POST, PUT, GET) or _oauth etc
+ maxLength: 32
+ did:
+ type: string
+ description: Device ID from which the API is called
+ maxLength: 1024
+ key:
+ type: string
+ description: API key (API key provided to the caller in case of server to server communication)
+ maxLength: 256
+ msgId:
+ type: string
+ description: Unique request message id from the caller
+ maxLength: 256
+ requesterId:
+ type: string
+ description: UserId of the user calling
+ maxLength: 256
+ authToken:
+ type: string
+ description: //session/jwt/saml token/oauth token - the usual value that would go into HTTP bearer token
+ userInfo:
+ $ref: '#/definitions/User'
+ correlationId:
+ type: string
+ readOnly: true
+ required:
+ - apiId
+ - ver
+ - ts
+ - msgId
+ - action
+
+ User:
+ type: object
+ description: This is acting ID token of the authenticated user on the server. Any value provided by the clients will be ignored and actual user based on authtoken will be used on the server.
+ readOnly: true
+ properties:
+ tenantId:
+ type: string
+ description: Unique Identifier of the tenant to which user primarily belongs
+ id:
+ type: integer
+ format: int32
+ description: User id of the authenticated user. Will be deprecated in future
+ uuid:
+ type: string
+ description: UUID of the user
+ userName:
+ type: string
+ description: Unique user name of the authenticated user
+ mobileNumber:
+ type: string
+ description: mobile number of the autheticated user
+ emailId:
+ type: string
+ description: email address of the authenticated user
+ roles:
+ type: array
+ description: List of all the roles
+ items:
+ $ref: '#/definitions/Role'
+ required:
+ - tenantId
+ - userName
+ - roles
+
+ Role:
+ type: object
+ description: |
+ minimal representation of the Roles in the system to be carried along in UserInfo with RequestInfo meta data. Actual authorization service to extend this to have more role related attributes
+ properties:
+ tenantId:
+ type: string
+ description: TenantId for which the role is given
+ id:
+ type: string
+ format: int32
+ description: id of the role
+ name:
+ type: string
+ description: Unique name of the role
+ maxLength: 64
+ description:
+ type: string
+ description: brief description of the role
+ required:
+ - code
+ - tenantId
+
- DeviceDetail:
- type: object
- description: Contains information about the device used to access the api
- properties:
- id:
- type: string
- description: The id of the device which is trying to accessed
- signature:
- type: string
- description: The electronic signature of the device
- Document:
- type: object
- description: >-
- This object holds list of documents attached during the transaciton for
- a property
- properties:
- id:
- type: string
- maxLength: 64
- description: system id of the Document.
- documentType:
- type: string
- description: >-
- unique document type code, should be validated with document type
- master
- fileStore:
- type: string
- description: File store reference key.
- documentUid:
- type: string
- maxLength: 64
- description: 'The unique id(Pancard Number,Adhar etc.) of the given Document.'
- additionalDetails:
- type: object
- description: 'Json object to capture any extra information which is not accommodated by model'
- Institution:
- type: object
- properties:
- id:
- type: string
- maxLength: 64
- description: Unique Identifier of the Institution(UUID).
- tenantId:
- type: string
- description: tenant id of the Property
- maxLength: 256
- type:
- type: string
- description: Institution type.
- maxLength: 64
- designation:
- type: string
- maxLength: 64
- description: Designation of the person creating/updatingentity on behalf of the institution
- nameOfAuthorizedPerson:
- type: string
- maxLength: 256
- description: Name of the person who is taking action on behalf of institution
- additionalDetails:
- type: object
- description: 'Json object to capture any extra information which is not accommodated by model'
- GeoLocation:
- type: object
- properties:
- latitude:
- type: number
- format: double
- description: latitude of the address
- longitude:
- type: number
- format: double
- description: longitude of the address
- additionalDetails:
- type: object
- description: 'Json object to capture any extra information which is not accommodated by model'
-
\ No newline at end of file
+ ResponseInfo:
+ type: object
+ readOnly: true
+ description: ResponseInfo should be used to carry metadata information about the response from the server. apiId, ver and msgId in ResponseInfo should always correspond to the same values in respective request's RequestInfo.
+ properties:
+ apiId:
+ type: string
+ description: unique API ID
+ maxLength: 128
+ ver:
+ type: string
+ description: API version
+ maxLength: 32
+ ts:
+ type: integer
+ format: int64
+ description: response time in epoch
+ resMsgId:
+ type: string
+ description: unique response message id (UUID) - will usually be the correlation id from the server
+ maxLength: 256
+ msgId:
+ type: string
+ description: message id of the request
+ maxLength: 256
+ status:
+ type: string
+ description: status of request processing - to be enhanced in futuer to include INPROGRESS
+ enum:
+ - SUCCESSFUL
+ - FAILED
+ required:
+ - apiId
+ - ver
+ - ts
+ - status
+
+ Error:
+ type: object
+ description: Error object will be returned as a part of reponse body in conjunction with ResponseInfo as part of ErrorResponse whenever the request processing status in the ResponseInfo is FAILED. HTTP return in this scenario will usually be HTTP 400.
+ properties:
+ code:
+ type: string
+ description: Error Code will be module specific error label/code to identiffy the error. All modules should also publish the Error codes with their specific localized values in localization service to ensure clients can print locale specific error messages. Example for error code would be User.NotFound to indicate User Not Found by User/Authentication service. All services must declare their possible Error Codes with brief description in the error response section of their API path.
+ message:
+ type: string
+ description: English locale message of the error code. Clients should make a separate call to get the other locale description if configured with the service. Clients may choose to cache these locale specific messages to enhance performance with a reasonable TTL (May be defined by the localization service based on tenant + module combination).
+ description:
+ type: string
+ description: Optional long description of the error to help clients take remedial action. This will not be available as part of localization service.
+ params:
+ type: array
+ description: Some error messages may carry replaceable fields (say $1, $2) to provide more context to the message. E.g. Format related errors may want to indicate the actual field for which the format is invalid. Client's should use the values in the param array to replace those fields.
+ items:
+ type: string
+ required:
+ - code
+ - message
+
+ ErrorRes:
+ type: object
+ description: All APIs will return ErrorRes in case of failure which will carry ResponseInfo as metadata and Error object as actual representation of error. In case of bulk apis, some apis may chose to return the array of Error objects to indicate individual failure.
+ properties:
+ ResponseInfo:
+ $ref: '#/definitions/ResponseInfo'
+ Errors:
+ description: Error response array corresponding to Request Object array. In case of single object submission or _search related paths this may be an array of one error element
+ type: array
+ minLength: 1
+ items:
+ $ref: '#/definitions/Error'
+ required:
+ - ResponseInfo
+
+ Address:
+ type: object
+ description: |
+ Representation of a address. Indiavidual APIs may choose to extend from this using allOf if more details needed to be added in their case.
+ properties:
+ tenantId:
+ type: string
+ description: Unique Identifier of the tenant to which user primarily belongs
+ latitude:
+ type: number
+ format: double
+ description: latitude of the address
+ longitude:
+ type: number
+ format: double
+ description: longitude of the address
+ addressId:
+ type: string
+ description: System generated id for the address
+ readOnly: true
+ addressNumber:
+ description: House, Door, Building number in the address
+ type: string
+ addressLine1:
+ description: Apartment, Block, Street of the address
+ type: string
+ addressLine2:
+ description: Locality, Area, Zone, Ward of the address
+ type: string
+ landmark:
+ description: additional landmark to help locate the address
+ type: string
+ city:
+ description: City of the address. Can be represented by the tenantid itself
+ type: string
+ pincode:
+ type: string
+ description: PIN code of the address. Indian pincodes will usually be all numbers.
+ detail:
+ type: string
+ description: more address detail as may be needed
+
+ AuditDetails:
+ type: object
+ description: Collection of audit related fields used by most models
+ readOnly: true
+ properties:
+ createdBy:
+ type: string
+ description: username (preferred) or userid of the user that created the object
+ lastModifiedBy:
+ type: string
+ description: username (preferred) or userid of the user that last modified the object
+ createdTime:
+ type: integer
+ format: int64
+ description: epoch of the time object is created
+ lastModifiedTime:
+ type: integer
+ format: int64
+ description: epoch of the time object is last modified
+
diff --git a/core-services/docs/egov-document-uploader-contract.yml b/core-services/docs/egov-document-uploader-contract.yml
deleted file mode 100644
index 3a9cc9ef4bd..00000000000
--- a/core-services/docs/egov-document-uploader-contract.yml
+++ /dev/null
@@ -1,258 +0,0 @@
----
-openapi: 3.0.3
-info:
- title: Api Documentation
- description: Api Documentation
- termsOfService: urn:tos
- contact: {}
- license:
- name: Apache 2.0
- url: http://www.apache.org/licenses/LICENSE-2.0
- version: '1.0'
-servers:
- - url: http://localhost:8080
- description: Inferred Url
-tags:
- - name: document-controller
- description: Document Controller
-paths:
- "/egov-document-uploader/egov-du/document/_create":
- post:
- tags:
- - document-controller
- summary: create
- operationId: createUsingPOST
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/DocumentRequest"
- responses:
- '200':
- description: OK
- content:
- "*/*":
- schema:
- "$ref": "#/components/schemas/DocumentResponse"
- '201':
- description: Created
- '401':
- description: Unauthorized
- '403':
- description: Forbidden
- '404':
- description: Not Found
- "/egov-document-uploader/egov-du/document/_delete":
- post:
- tags:
- - document-controller
- summary: delete
- operationId: deleteUsingPOST
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/DocumentRequest"
- responses:
- '200':
- description: OK
- content:
- "*/*":
- schema:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ResponseInfo
- '201':
- description: Created
- '401':
- description: Unauthorized
- '403':
- description: Forbidden
- '404':
- description: Not Found
- "/egov-document-uploader/egov-du/document/_search":
- post:
- tags:
- - document-controller
- summary: search
- operationId: searchUsingPOST
- parameters:
- - name: category
- in: query
- required: false
- style: form
- schema:
- type: string
- - name: name
- in: query
- required: false
- style: form
- schema:
- type: string
- - name: postedBy
- in: query
- required: false
- style: form
- schema:
- type: string
- - name: tenantIds
- in: query
- required: false
- style: pipeDelimited
- schema:
- type: array
- items:
- type: string
- - name: uuid
- in: query
- required: false
- style: form
- schema:
- type: string
- - name: fromDate
- in: query
- required: false
- style: form
- schema:
- type: integer
- - name: toDate
- in: query
- required: false
- style: form
- schema:
- type: integer
- - name: viewDeletedDocuments
- in: query
- required: false
- style: form
- schema:
- type: boolean
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/RequestInfoWrapper"
- responses:
- '200':
- description: OK
- content:
- "*/*":
- schema:
- "$ref": "#/components/schemas/DocumentResponse"
- '201':
- description: Created
- '401':
- description: Unauthorized
- '403':
- description: Forbidden
- '404':
- description: Not Found
- "/egov-document-uploader/egov-du/document/_update":
- post:
- tags:
- - document-controller
- summary: update
- operationId: updateUsingPOST
- requestBody:
- content:
- application/json:
- schema:
- "$ref": "#/components/schemas/DocumentRequest"
- responses:
- '200':
- description: OK
- content:
- "*/*":
- schema:
- "$ref": "#/components/schemas/DocumentResponse"
- '201':
- description: Created
- '401':
- description: Unauthorized
- '403':
- description: Forbidden
- '404':
- description: Not Found
-components:
- schemas:
- AuditDetails:
- title: AuditDetails
- type: object
- properties:
- createdBy:
- type: string
- createdTime:
- type: integer
- format: int64
- lastModifiedBy:
- type: string
- lastModifiedTime:
- type: integer
- format: int64
- DocumentEntity:
- title: DocumentEntity
- required:
- - tenantIds
- type: object
- properties:
- active:
- type: boolean
- auditDetails:
- "$ref": "#/components/schemas/AuditDetails"
- category:
- type: string
- description:
- maxLength: 140
- minLength: 0
- type: string
- documentLink:
- type: string
- filestoreId:
- type: string
- name:
- type: string
- postedBy:
- type: string
- tenantId:
- type: string
- tenantIds:
- type: array
- items:
- type: string
- uuid:
- type: string
- DocumentRequest:
- title: DocumentRequest
- type: object
- properties:
- DocumentEntity:
- "$ref": "#/components/schemas/DocumentEntity"
- RequestInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo
- DocumentResponse:
- title: DocumentResponse
- type: object
- properties:
- Documents:
- type: array
- items:
- "$ref": "#/components/schemas/DocumentEntity"
- ResponseInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ResponseInfo
- Link:
- title: Link
- type: string
- RequestInfoWrapper:
- title: RequestInfoWrapper
- type: object
- properties:
- RequestInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo
- Role:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/Role
- User:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/UserInfo
diff --git a/core-services/docs/egov-location-contract.yml b/core-services/docs/egov-location-contract.yml
deleted file mode 100644
index fb6cf2dee4a..00000000000
--- a/core-services/docs/egov-location-contract.yml
+++ /dev/null
@@ -1,246 +0,0 @@
-swagger: '2.0'
-info:
- version: 1.1.0
- title: Location Service
- contact:
- name: eGov
- email: info@egovernments.org
-schemes:
- - https
-basePath: /location/v11
-x-api-id: org.egov.boundary
-paths:
- /boundarys/_search:
- post:
- summary: >-
- It Will provide the List of boundaries based on search criteria Like
- "Srikakulam Municipality","Zone-1","Zone-2" etc.
- description: >
- Provides a list of boundaries based on TenantId And List of Boundary
- id's And List Of codes And BoundaryType And HierarchyType
- parameters:
- - $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo
- - $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId
- - name: boundaryType
- in: query
- type: integer
- description: lable of boundary within the tenant boundary structure
- - name: hierarchyTypeCode
- in: query
- description: 'Type Of the BoundaryType Like REVENUE, ADMIN'
- required: false
- type: string
- format: varchar
- - name: codes
- in: query
- description: Unique List of boundary codes.
- required: false
- type: array
- items:
- type: string
- format: varchar
- tags:
- - Boundary
- responses:
- '200':
- description: Successful Response.
- schema:
- $ref: '#/definitions/BoundaryResponse'
- '400':
- description: Tenantid was not provided or General service error
- schema:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes
- /geography/_search:
- post:
- summary: >-
- Handles all requests related to Geographical boundaries by providing appropriate GeoJson and other associated data
- description: >
- Handles all requests related to Geographical boundaries by providing appropriate GeoJson and other associated data based on tenantId or lat/long etc
- parameters:
- - $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId
- - name: filter
- in: query
- type: string
- description: JSON path filter string for filtering the output
- required: false
- - name: requestInfoWapper
- in: body
- description: JSON path filter string for filtering the output
- schema:
- $ref: >-
- #/definitions/RequestInfoWrapper
- tags:
- - Geography
- responses:
- '200':
- description: Successful Response.
- schema:
- $ref: '#/definitions/GeographicalResponse'
- '400':
- description: Invalid tenant Id provided
- schema:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes
- /tenant/_search:
- post:
- summary: >-
- Resolves a given latitude / longitude to the corresponding tenant Id
- description: >
- Tries to resolve a given lat, long to a corresponding tenant, provided there exists a mapping between the reverse geocoded city to tenant.
- parameters:
- - $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId
- - name: lat
- in: query
- type: number
- description: Latitude
- required: true
- - name: lng
- in: query
- type: number
- description: Longitude
- required: true
- - name: requestInfoWapper
- in: body
- description: JSON path filter string for filtering the output
- schema:
- $ref: >-
- #/definitions/RequestInfoWrapper
- tags:
- - Tenant
- responses:
- '200':
- description: Successful Response.
- schema:
- $ref: '#/definitions/TenantResponse'
- '400':
- description: Unable to resolve tenant
- schema:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes
-definitions:
- HierarchyType:
- type: object
- properties:
- id:
- type: string
- description: unique id for the HierarchyType.
- code:
- type: string
- description: Unique Code for HierarchyType.
- name:
- type: string
- format: varchar
- description: HierarchyType Name.
- label:
- type: string
- format: varchar
- description: label in localization service
- required:
- - code
- - name
- Boundary:
- type: object
- properties:
- code:
- type: string
- description: code of the boundary.
- name:
- type: string
- description: name of the boundary.
- label:
- type: string
- description: localized label for the boundry.
- latitude:
- type: string
- description: latitude of the boundary.
- longitude:
- type: string
- description: longitude of the boundary.
- children:
- type: array
- items:
- $ref: '#/definitions/Boundary'
- materializedPath:
- type: string
- readOnly: true
- description: >-
- materialized path of the boundary - this would be of the format
- tenantid.[code] from parentt till teh current boundary
- required:
- - code
- - name
- Geography:
- type: object
- properties:
- name:
- type: string
- description: Name of the Geography.
- division:
- type: string
- description: Geographical division such as State, District, City.
- geoJson:
- type: object
- description: Json Node object containing geoJson of the requested tenant
- geoJsonChildren:
- type: object
- description: Json Node object containing geoJson of the requested tenant's children
- tenantId:
- type: string
- description: Tenant Id whose geographical data is requested.
- required:
- - name
- - division
- - geoJson
- - tenantId
- TenantBoundary:
- type: object
- properties:
- tenantId:
- type: string
- description: Unique id of the boundary tenant.
- hierarchyType:
- $ref: '#/definitions/HierarchyType'
- boundary:
- type: array
- items:
- $ref: '#/definitions/Boundary'
- BoundaryResponse:
- properties:
- ResponseInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo
- Boundary:
- type: array
- items:
- $ref: '#/definitions/TenantBoundary'
- GeographicalResponse:
- properties:
- ResponseInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo
- Geography:
- type: array
- items:
- $ref: '#/definitions/Geography'
- type: object
- TenantResponse:
- properties:
- ResponseInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo
- Tenant:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/tenant/contracts/v1.0.1.yml#/definitions/Tenant
- type: object
-
- RequestInfoWrapper:
- type: object
- properties:
- RequestInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo
\ No newline at end of file
diff --git a/core-services/docs/egov-otp-contract.yml b/core-services/docs/egov-otp-contract.yml
deleted file mode 100644
index 7387740e13f..00000000000
--- a/core-services/docs/egov-otp-contract.yml
+++ /dev/null
@@ -1,137 +0,0 @@
-swagger: '2.0'
-
-info:
- version: "1.1.0"
- title: Egov otp service
- description: Egov-otp service APIs - contains create , validate and search end point
- contact:
- name: eGov
- email: info@egovernments.org
-
-basePath: "/egov-otp/v110"
-x-common-path: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml'
-x-api-id: 'org.egov.egov-otp'
-#########################################################################################
-
-paths:
- /otp/v1/_create:
- post:
- summary: create OTP Configuration entry
- description: create OTP Configuration this API is internaly call from v1/_send end point, this end point present in user-otp service no need of explicity call
- tags:
- - OTPConfig
- parameters:
- - name: OTPConfig
- in: body
- description: required parameters have to be populated
- required: true
- schema:
- $ref: '#/definitions/CreateOTPConfigReq'
- responses:
- '200':
- description: Request acknowledged sucessfully
- schema:
- $ref: "#/definitions/OTPConfigRes"
- '400':
- description: Request failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-#########################################################################################
-
- /otp/v1/_validate:
- post:
- summary: validate OTP Configuration entry
- description: validate OTP Configuration this end point is validate the otp respect to mobilenumber
- tags:
- - OTPConfig
- parameters:
- - name: OTPConfig
- in: body
- description: required parameters have to be populated
- required: true
- schema:
- $ref: '#/definitions/CreateOTPConfigReq'
- responses:
- '200':
- description: Request acknowledged sucessfully
- schema:
- $ref: "#/definitions/OTPConfigRes"
- '400':
- description: Request failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-#########################################################################################
-
- /otp/v1/_search:
- post:
- summary: search OTP Configuration entry using uuid
- description: search the mobile number and otp using uuid ,uuid nothing but otp reference number
- tags:
- - OTPConfig
- parameters:
- - name: OTPConfig
- in: body
- description: required parameters have to be populated
- required: true
- schema:
- $ref: '#/definitions/CreateOTPConfigReq'
- responses:
- '200':
- description: Request acknowledged sucessfully
- schema:
- $ref: "#/definitions/OTPConfigRes"
- '400':
- description: Request failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-#########################################################################################
-
-definitions:
- Createotp:
- type: object
- properties:
- otp:
- type: string
- description : this is the five digit otp number ,this is mandatory in validate end point should pass otp value in /otp/v1/_validate end point, in other end point it is read only
- uuid:
- type: string
- description : this is otp reference id, this is mandatory in search end point (/otp/v1/_search), and in other end point it is read only.
- identity:
- type: string
- description: identity is username or mobile number. this is mandatory field in create and validate end point end point is(/otp/v1/_create, and /otp/v1/_validat) and optional field in /otp/v1/_search end point
- tenantId:
- type: string
- description: Unique Identifier of the tenantId to which user primarily belongs and it is mandatory field in all the end points shoiuld pass this value
- isValidationSuccessful:
- type: string
- description: it return true or false this is optional or read only property in all end point,
- required:
- - identity
- - tenantId
-#########################################################################################
-
- CreateOTPConfigReq:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- otp:
- $ref: '#/definitions/Createotp'
- required:
- - RequestInfo
- - otp
-
-#########################################################################################
- OTPConfigRes:
- type: object
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- otp:
- type: array
- maximum: 20
- items:
- $ref: '#/definitions/Createotp'
-
-
-
\ No newline at end of file
diff --git a/core-services/docs/egov-pg-contract.yml b/core-services/docs/egov-pg-contract.yml
deleted file mode 100644
index f5d586d3107..00000000000
--- a/core-services/docs/egov-pg-contract.yml
+++ /dev/null
@@ -1,278 +0,0 @@
-swagger: '2.0'
-info:
- version: 1.0.0
- title: eGov Payment Gateway Service.
- description: >
- This module acts as a liaison between eGov apps and external payment gateways. It facilitates payments, refunds and look up of transactions' status.
- contact:
- name: Egovernments Foundation
- email: contact@egovernments.org
-schemes:
- - https
-basePath: /egov-pg-service
-x-common-path: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml
-paths:
-#########################################
- /payments/v1/_search:
- post:
- summary: Retrieves the current status of a payment
- description: |
- Returns the current status of a payment in our systems; this does not guarantee live payment gateway status.
- parameters:
- - $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo
- - $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId
- - name: txnId
- in: query
- description: >-
- Transaction id generated by the service during creation.
- required: false
- type: string
- - name: billId
- in: query
- description: Unique module based ID for which the transaction is being initiated, if billId is used, module should be included.
- required: false
- type: string
- format: varchar
- - name: user_uuid
- in: query
- description: User ID of the user as registered in user service, for whom the transaction was carried out.
- required: false
- type: string
- format: varchar
- - name: module
- in: query
- required: false
- description: Module name to which the billId belongs to.
- type: string
- - name: moduleId
- in: query
- required: false
- description: Unique identifier in the module for which the transaction is being initiated
- type: string
- - name: receipt
- in: query
- required: false
- description: Receipt ID generated for this payment
- type: string
- - name: txnStatus
- in: query
- required: false
- description: Current status of the transaction
- type: string
- responses:
- '200':
- description: Successful response
- schema:
- $ref: '#/definitions/TransactionResponse'
- '400':
- description: Invalid input.
- schema:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes
- tags:
- - Payment
-
-#########################################
- /payments/v1/_create:
- post:
- summary: Initiates a new payment transaction.
- description: Initiates a new payment transaction, on successful validation, a redirect is issued to the payment gateway.
- parameters:
- - name: TransactionRequest
- in: "body"
- description: Details of the payment and RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/TransactionRequest'
- responses:
- '302':
- description: Payment Initiated successfully, gateway redirection triggered.
- '400':
- description: Payment initiation failed.
- schema:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes
- tags:
- - Payment
-
-#########################################
-
- /payments/v1/_update:
- post:
- summary: Update an existing payment.
- description: Updates an existing payment transaction, to be used only by payment gateways to update status of payments. Verifies the authenticity of the request with the payment gateway. Forward all query params received from payment gateway
- parameters:
- - name: RequestInfo
- in: "body"
- description: Details of the payment response obtained from the payment gateway.
- schema:
- $ref: '#/definitions/RequestInfoWrapper'
- responses:
- '200':
- description: Payment Status transaction updated successfully
- schema:
- $ref: '#/definitions/TransactionResponse'
- '400':
- description: Payment status update failed
- schema:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes
- tags:
- - Payment
-
-#########################################
-definitions:
- Transaction:
- type: object
- description: Details of the payment object.
- properties:
- tenantId:
- type: string
- description: The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required
- minLength: 2
- maxLength: 50
- txnAmount:
- type: string
- description: Transaction Amount, preferably rounded off to two decimal places
- minLength: 1
- billId:
- type: string
- description: Unique bill ID associated with the transaction
- module:
- type: string
- description: Module business code for which the transaction is being initiated, ex PT, WS, PGR etc
- moduleId:
- type: string
- description: Unique identifier in the module for which the transaction is being initiated
- productInfo:
- type: string
- description: Brief description for which the transaction is being carried out.
- gateway:
- type: string
- description: Gateway to be used, from the available list, such as PAYTM, PHONEPE.
- callbackUrl:
- type: string
- description: URL to which control has to be redirected to from the gateway
- txnId:
- type: string
- readOnly: true
- description: Transaction ID of the payment, generated by the gateway service
- user:
- $ref: '#/definitions/User'
- txnStatus:
- type: string
- readOnly: true
- description: Current status of the transaction
- enum:
- - SUCCESS
- - FAILURE
- - PENDING
- txnStatusMsg:
- type: string
- readOnly: true
- description: Brief status message for the transaction
- gatewayTxnId:
- type: string
- readOnly: true
- description: Transaction ID returned by the gateway, for reference
- gatewayPaymentMode:
- type: string
- readOnly: true
- description: Mode of payment used at the gateway
- gatewayStatusCode:
- type: string
- readOnly: true
- description: Payment Gateway Specific RAW status code
- gatewayStatusMsg:
- type: string
- readOnly: true
- description: Payment Gateway Specific RAW status message
- receipt:
- type: string
- readOnly: true
- description: Receipt ID generated for this payment
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- required:
- - tenantId
- - txnAmount
- - billId
- - module
- - moduleId
- - productInfo
- - gateway
- - callbackUrl
-
-
- User:
- type: object
- readOnly: true
- properties:
- tenantId:
- type: string
- description: Unique Identifier of the tenant to which user primarily belongs
- uuid:
- type: string
- description: UUID for the user.
- userName:
- type: string
- description: The unique username used of the user - this will be used for user login. This needs to be unique within the tenant.
- minLength: 4
- maxLength: 64
- name:
- type: string
- description: The full name of the user.
- minLength: 3
- maxLength: 100
- mobileNumber:
- type: string
- description: Mobile number of the user
- maxLength: 10
- emailId:
- type: string
- description: Email address of the user
- maxLength: 128
- required:
- - uuid
- - userName
- - name
- - mobileNumber
- - tenantId
-
-#########################################
- TransactionRequest:
- description: >-
- The payment object, containing all necessary information for initiating a payment and the request body metadata
- properties:
- requestInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo
- Transaction:
- $ref: '#/definitions/Transaction'
-
- RequestInfoWrapper:
- description: >-
- Wrapper for Request Info
- properties:
- requestInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo
-
-
- TransactionResponse:
- description: >-
- The payment seatch response object, representing the status of the payment
- properties:
- responseInfo:
- $ref: >-
- https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo
- Transaction:
- type: array
- items:
- $ref: '#/definitions/Transaction'
-
-
-#########################################
\ No newline at end of file
diff --git a/core-services/docs/egov-user-contract.yml b/core-services/docs/egov-user-contract.yml
deleted file mode 100644
index 28aa4017c13..00000000000
--- a/core-services/docs/egov-user-contract.yml
+++ /dev/null
@@ -1,509 +0,0 @@
-swagger: '2.0'
-
-info:
- version: "1.1.0"
- title: User Service
- description: User services APIs - to create, update and search users. All individuals interacting with the platform - Citizens, Employees, Contractors, Vendors etc. are considered as users of the platform
- contact:
- name: eGov
- email: info@egovernments.org
-
-basePath: "/users/v110"
-x-common-path: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml'
-x-api-id: 'org.egov.users'
-#####################################################
-paths:
- /_create:
- post:
- summary: Create a new User.
- description: |
- To create new User(s) in the system. API supports bulk creation with max limit as defined in the UserReq. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one user, please pass array with one user object.
-
- Users can be created based on the roles. Users with types as SYSTEM and EMPLOYEE can create other users if their RBAC mapping provides them the permission. Users with CITIZEN type can only create themselves, while EMPLOYEE and SYSTEM type users can also create other EMPLOYEES and CITIZENS.
-
- User registration will always be a two step process, where this API will create a non authenticated user (without password) and after verification (using OTP) other user details (including password) can be updated using update user API to complete the user registration process.
- parameters:
- - name: users
- in: body
- description: Details for the new user + RequestInfo meta data
- required: true
- schema:
- $ref: '#/definitions/UserReq'
- tags:
- - Users
- responses:
- '201':
- description: User(s) created sucessfully
- schema:
- $ref: '#/definitions/UserRes'
- '400':
- description: User(s) creation failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
-#####################################################
- /_update:
- post:
- summary: Update user API
- description: |
- This API will update all user related details based on their type. Following rules apply -
- 1. Username cannot be updated once created
- 2. Password can only be updated by the user itself (CITIZEN or EMPLOYEE) using reissue OTP issued to them
- 3. User can self update mobile number/email by doing OTP verification with old phone/email
- 4. An employee can reset another user mobile number/email after OTP/other necessary validation (need specific privilege)
- parameters:
- - name: users
- in: body
- description: Request header for the user with new of values.
- required: true
- schema:
- $ref: '#/definitions/UserReq'
- tags:
- - Users
- responses:
- '200':
- description: Update user(s) successful
- schema:
- $ref: '#/definitions/UserRes'
- '400':
- description: Update user(s) failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-#####################################################
- /_search:
- post:
- summary: Search the users in the system based on the criterion specified.
- description: |
- Search and get user(s) based on defined search criteria. Currently search parameters are only allowed as HTTP query params. In case multiple parameters are passed user will be searched as an AND combination of all the parameters. Maximum result size is restricted based on the maxlength of Users as defined in UserRes model.
-
- By default results will be sorted by UserName
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo"
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/lastChangedSince"
- - $ref: "#/parameters/userName"
- - $ref: "#/parameters/active"
- - $ref: "#/parameters/id"
- - $ref: "#/parameters/userType"
- - $ref: "#/parameters/roleCodes"
- - $ref: "#/parameters/includeDetails"
- - $ref: "#/parameters/pageSize"
- - $ref: "#/parameters/pageNumber"
- - $ref: "#/parameters/sortUser"
- responses:
- 200:
- description: Successful response
- schema:
- $ref: "#/definitions/UserRes"
- '400':
- description: Invalid input.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - Users
-#####################################################
- /password/_update:
- post:
- summary: The user can update his password after login
- description: |
- This API used for update the password after login
- parameters:
- - name: update password
- in: body
- description: Request header for the user with new of values.
- required: true
- schema:
- $ref: '#/definitions/updatePasswordReq'
- tags:
- - Update password
- responses:
- '200':
- description: Updated password successful
- schema:
- $ref: '#/definitions/PasswordRes'
- '400':
- description: Updated password failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-#####################################################
- /password/nologin/_update:
- post:
- summary: This API act as reset password or forgot password before login
- description: |
- This API used for reset the password when user forgot his password by getting otp Reference through registerd mobile number,
- parameters:
- - name: Reset password before login using five digit otp
- in: body
- description: Request header for the user with new of values.
- required: true
- schema:
- $ref: '#/definitions/resetpasswordreq'
- tags:
- - Update password
- responses:
- '200':
- description: Updated password successful
- schema:
- $ref: '#/definitions/PasswordRes'
- '400':
- description: Updated password failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-#####################################################
-definitions:
- resetpasswordreq:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- otpReference:
- type: string
- description: otp reference number which sent to registered mobile
- userName:
- type: string
- description: Registered User name
- newPassword:
- type: string
- description: New password
- tenantId:
- type: string
- description: Unique Identifier of the tenant to which user primarily belongs
- required:
- - otpReference
- - userName
- - newPassword
- - tenantId
-#####################################################
- updatePasswordReq:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
-
-
- existingPassword:
- type: string
- description: Existing password
- newPassword:
- type: string
- description: New password
- tenantId:
- type: string
- description: Unique Identifier of the tenant to which user primarily belongs
- required:
- - existingPassword
- - newPassword
- - tenantId
-#####################################################
- PasswordRes:
- type: object
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
-#####################################################
- User:
- type: object
- properties:
- tenantId:
- type: string
- description: Unique Identifier of the tenant to which user primarily belongs
- id:
- type: integer
- format: int64
- description: The unique numeric id of an user. To be deprecated in future.
- userName:
- type: string
- description: The unique username used of the user - this will be used for user login. This needs to be unique within the tenant.
- minLength: 4
- maxLength: 64
- authToken:
- type: string
- format: password
- description: |
- Authentication token for the user that may be -
- 1. Password in case of basic auth
- 2. OTP in case of OTP based verification
- 3. OAuth auth token for OAuth based auth
- salutation:
- type: string
- description: The salutation of user name. Example- Mr, Miss, Mrs
- maxLength: 5
- name:
- type: string
- description: The full name of the user.
- minLength: 3
- maxLength: 100
- gender:
- type: string
- description: Gender of the user.
- items:
- type: string
- enum:
- - MALE
- - FEMALE
- - OTHERS
- mobileNumber:
- type: string
- description: Mobile number of the user
- maxLength: 10
- emailId:
- type: string
- description: Email address of the user
- maxLength: 128
- aadhaarNumber:
- type: string
- description: Aadhaar number of the user
- pattern: "[0-9]"
- maxLength: 12
- active:
- type: boolean
- description: True if the user is active and False if the user is inactive.
- pwdExpiryDate:
- type: integer
- format: int64
- readOnly: true
- description: epoch of time when the current auth token (password/OTP) will expire.
- locale:
- type: string
- description: Value will be set to "en_IN".
- maxLength: 5
- type:
- type: string
- maxLength: 20
- description : System set value internally. For employee value will be always "EMPLOYEE". For citizen value will be "CITIZEN".
- items:
- type: string
- enum:
- - EMPLOYEE
- - CITIZEN
- - SYSTEM
- accountLocked:
- type: boolean
- default: false
- description: Set to True if account is locked after several incorrect password attempt. False if account is not locked.
- roles:
- #This should ideally extend from accesscontrol service - for now this should suffice
- type: array
- description: List of roles that are attached to the user.
- items:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/Role"
- userDetails:
- $ref: "#/definitions/UserDetails"
- auditDetails:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails"
- required:
- - userName
- - name
- - gender
- - mobileNumber
- - active
- - locale
- - type
- - tenantId
-#####################################################
- UserDetails:
- type: object
- description: Infrequently used details for the user
- properties:
- firstName:
- type: string
- description: The full name of the user.
- minLength: 1
- maxLength: 32
- middleName:
- type: string
- description: The full name of the user.
- minLength: 1
- maxLength: 32
- lastName:
- type: string
- description: The full name of the user.
- minLength: 1
- maxLength: 32
- dob:
- type: string
- format: date
- description: Date of birth of the user in dd/mm/yyyy format.
- altContactNumber:
- type: string
- description: Alternate contact number of the user
- maxLength: 16
- fatherName:
- type: string
- description: User's father's name if available
- maxLength: 100
- husbandName:
- type: string
- description: Name of user's husband - if applicable
- maxLength: 100
- bloodGroup:
- type: string
- description: Blood group of the user.
- maxLength: 3
- items:
- type: string
- enum:
- - A+
- - B+
- - O+
- - AB+
- - A-
- - B-
- - AB-
- - O-
- pan:
- type: string
- description: PAN number of the user
- maxLength: 10
- permanentAddress:
- type: string
- description: Permanent address of the user.
- maxLength: 300
- permanentCity:
- type: string
- description: City of the permanent address.
- maxLength: 300
- permanentPincode:
- type: string
- description: Permanent address pincode.
- maxLength: 6
- correspondenceCity:
- type: string
- description: City of the correspondence address.
- maxLength: 50
- correspondencePincode:
- type: string
- description: Permanent address pincode.
- maxLength: 6
- correspondenceAddress:
- type: string
- description: Correspondence address of the user.
- maxLength: 300
- signature:
- type: string
- description : Image to be loaded for the signature of the employee
- identificationMark:
- type: string
- description: Any identification mark of the person.
- maxLength: 300
- photo:
- type: string
- description : Image to be loaded for the photo of the user
-#####################################################
- UserReq:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- Users:
- type: array
- minimum: 1
- maximum: 100
- items:
- $ref: '#/definitions/User'
- required:
- - RequestInfo
- - Users
-#####################################################
- UserRes:
- type: object
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- Users:
- type: array
- maximum: 500
- items:
- $ref: '#/definitions/User'
-
-parameters:
- userName:
- name: userName
- in: query
- required: false
- description: The unique user name of the User.
- type: string
- minLength: 0
- maxLength: 64
-
- active:
- name: active
- in: query
- description: True will be set in cases where only active users are needed and False will be set when inactive users are needed and no value will be set when all users are needed.
- required: false
- type: boolean
- format: varchar
- default: true
- allowEmptyValue: true
-
- id:
- name: id
- in: query
- description: List of Unique Id of User
- required: false
- type: array
- items:
- type: integer
- format: int64
-
- userType:
- name: userType
- in: query
- required: false
- description: Defines the type of user. Possible values are as per type enum defined in User object.
- type: string
- minLength: 0
- maxLength: 64
- exclusiveMinimum: true
- exclusiveMaximum: false
-
- roleCodes:
- name: roleCodes
- in: query
- required: false
- description: roles assigned to the user(roleCodes).Search response will have all users having all roles specified in the request.
- type: array
- items:
- type: string
-
- includeDetails:
- name: includeDetails
- description: parameter to indicate whether UserDetails should be included as a part of User object in the response
- in: query
- required: false
- type: boolean
- default: false
-
- pageSize:
- name: pageSize
- in: query
- description: Number of records returned.
- type: integer
- minimum: 0
- exclusiveMinimum: true
- maximum: 100
- exclusiveMaximum: false
- multipleOf: 10
- default: 20
-
- pageNumber:
- name: pageNumber
- in: query
- description: Page number
- type: integer
- default: 1
-
- sortUser:
- name: sort
- in: query
- description: User results will be sorted by name ascending by default if this parameter is not provided.
- type: array
- uniqueItems: true
- minItems: 1
- maxItems: 3
- collectionFormat: pipes
- items:
- type: string
- pattern: '[-+](userName|name|gender)'
- default:
- - +name
\ No newline at end of file
diff --git a/core-services/docs/filestore-service-contract.yml b/core-services/docs/filestore-service-contract.yml
deleted file mode 100644
index b593ffe2edb..00000000000
--- a/core-services/docs/filestore-service-contract.yml
+++ /dev/null
@@ -1,185 +0,0 @@
-swagger: "2.0"
-info:
- version: 2.0.0
- title: Filestore serivce APIs
- description: |
- APIs available for filestore service
- - Uploads different kinds of files to server including images and different document types.
- contact:
- name: eGovernments Foundation
- email: contacts@egovernments.org
-schemes:
- - https
-basePath: /filestore/v1/files/
-paths:
- /upload:
- post:
- summary: Uploads different kinds of files to server.
- description: The endpoint for uploading file in the system.
- tags:
- - Upload File
- consumes:
- - multipart/form-data
- parameters:
- - in: formData
- name: file
- type: file
- required: true
- description: The file to upload.
- - in: formData
- name: tenantId
- type: string
- required: true
- description: Unique ulb identifier.
- - in: formData
- name: module
- type: string
- required: false
- description: module name.
- - in: formData
- name: tag
- type: string
- required: false
- description: tag name.
- responses:
- "200":
- description: Success response with filestoreid and tenantid.
- schema:
- $ref: "#/definitions/UploadFileResponse"
- "400":
- description: Error response in case of failures.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes"
- /url:
- get:
- summary: Search file url based on tenantid and filestoreid.
- description: Search file url.
- tags:
- - Search
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/tenantId"
- - name: fileStoreIds
- in: query
- description: Unique filestoreids.
- required: true
- type: string
- responses:
- "200":
- description: List of urls to access the uploaded file which is map to particular fielstoreid.
- schema:
- $ref: "#/definitions/FilestoreIdResponse"
-
- "400":
- description: Error response in case of failures.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes"
- /tag:
- get:
- summary: Search file url based on tenantid and tag name.
- description: Search file url.
- tags:
- - Search
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/tenantId"
- - name: tag
- in: query
- description: tag name.
- required: true
- type: string
- responses:
- "200":
- description: List of urls to access the uploaded file which is map to particular tag name.
- schema:
- $ref: "#/definitions/TagFileResponse"
-
- "400":
- description: Error response in case of failures.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes"
- /metaData:
- get:
- summary: Get metadata of file based on tenantId and filestoreId.
- description: metadata of file.
- tags:
- - Search
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/tenantId"
- - name: fileStoreId
- in: query
- description: Unique fileStoreId.
- required: true
- type: string
- responses:
- "200":
- description: Metadata of file map to particulare filestoreId.
- schema:
- $ref: "#/definitions/MetaDataResponse"
-
- "400":
- description: Error response in case of failures.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes"
-definitions:
- FilestoreIdResponse:
- type: object
- description: A list of values
- required:
- - filestoreId
- properties:
- filestoreId:
- type: array
- items:
- type: string
- UploadFileResponse:
- type: object
- properties:
- files:
- type: array
- items:
- $ref: "#/definitions/UploadFile"
- TagFileResponse:
- type: object
- properties:
- files:
- type: array
- items:
- $ref: "#/definitions/TagFile"
- MetaDataResponse:
- description: Response data cobtains details of files.
- type: object
- properties:
- fileName:
- description: file name.
- type: string
- contetntType:
- description: contetnt type of file.
- type: string
- tenantId:
- description: Unique ulb identifier.
- type: string
- resource:
- description: resource.
- type: string
- fileSize:
- description: file size.
- type: string
- UploadFile:
- description: Upload file response data with filestoreid and tenantid.
- type: object
- properties:
- fileStoreId:
- description: filestore id of the particular file.
- type: string
- tenantId:
- description: Unique ulb identifier.
- type: string
- TagFile:
- description: Upload file response data with url and contetnt type of file.
- type: object
- properties:
- url:
- description: url to access the particular file belong to the tag.
- type: string
- contetntType:
- description: contetnt type of file.
- type: string
\ No newline at end of file
diff --git a/core-services/docs/idgen-contract.yml b/core-services/docs/idgen-contract.yml
deleted file mode 100644
index 3a1b89a9dcb..00000000000
--- a/core-services/docs/idgen-contract.yml
+++ /dev/null
@@ -1,108 +0,0 @@
-swagger: '2.0'
-info:
- version: 1.0.0
- title: ID Generation service
- description: |
- This service generates a unique ID/Code given the needed format e.g. an id wit format AP-PT-2017/04/11-000001-23 where format is can be decomposed as (- is used as a separator in the above example) -
-
- AP - Fixed string indicating the tenant
-
- PT - fixed string indicating module
-
- 2017/04/11 - Date field indicating YYYY/MM/DD
-
- 000001 - local sequence number
-
- 23 - two random digits
-
- This can be indicated to IDGen service as an ID needed in the format (square brackets indicate the parts that will be replaced by the svc to generate the new id) -
- AP-PT-[YYYY/MM/DD]-[SEQ_ACK_NUM]-[d{2}]
-
- Please note that are replaceable elements will be enclosed within []. Following construct are supported -
-
- 1. Date patterns as per java SimpleDateFormat (https://docs.oracle.com/javase/7/docs/api/java/util/regex/Pattern.html)
- 2. Regex patterns as per Java regex paterns (http://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html)
- 3. SEQ_ where X is the name of a sequence to be used, e.g. SEQ_ACK_NUM
- 4. Static elements will be without enclosing square brackets
-
- contact:
- name: Pranav
-host: egov-micro-dev.egovernments.org
-schemes:
- - https
-basePath: /id/v1/
-paths:
- /_genearte:
- post:
- summary: Create new id.
- description: API to generate new id based on the id formats passed.
- parameters:
- - name: idRequests
- in: body
- required: true
- schema:
- $ref: '#/definitions/IdGenerationRequest'
- responses:
- '201':
- description: Id generated sucessfully.
- schema:
- $ref: '#/definitions/IdGenerationResponse'
- '400':
- description: Invalid input.
- schema:
- $ref: '#/definitions/IDGenErrorRes'
- tags:
- - Property
-definitions:
- IdRequest:
- type: object
- properties:
- idName:
- type: string
- description: |
- It would indicate the type of id, we would like to generate, ex upic no or acknowledgement number. Please nite that the id format can also be configured with idGen service with theis name in case calling services wishes to do so, so as to not needing to pass the format each time. In such a case if the format is passed at the runtime then the passed format will take precedence over configured format. idName should be namespaced with module/functionality e.g. propertytax.acknumber or propertytax.assessmentnumber
- tenantId:
- type: string
- description: |
- tenantid for which Id has to be generated. Please note that an id configuration can be overwritten for a particular tenant using tenantid prefix, e.g. mycity.propertytax.acknumber configuration will be evaluated for mycity if both propertytax.acknumber and mycity.propertytax.acknumber are configured
- format:
- type: string
- description: format of the id to be generated. Supported as per the description of the service.
- required:
- - tenantId
- - idName
- IdResponse:
- type: object
- properties:
- id:
- type: string
- description: This is the generated id
- IdGenerationRequest:
- description: Contract class to receive request.
- properties:
- requestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- idRequests:
- type: array
- items:
- $ref: '#/definitions/IdRequest'
- IdGenerationResponse:
- description: Contract class to send response.
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- idResponses:
- type: array
- items:
- $ref: '#/definitions/IdResponse'
- IDGenErrorRes:
- allOf:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- - type: object
- properties:
- codes:
- type: string
- enum:
- - InvalidIDFormat
- - IDSeqOverflow
- - IDSeqNotFound
\ No newline at end of file
diff --git a/core-services/docs/localisation-contract.yml b/core-services/docs/localisation-contract.yml
deleted file mode 100644
index d6fe72130fe..00000000000
--- a/core-services/docs/localisation-contract.yml
+++ /dev/null
@@ -1,239 +0,0 @@
-swagger: '2.0'
-
-info:
- version: "1.1.0"
- title: egov-localization
- description: egov-localization services APIs,
- contact:
- name: eGov
- email: info@egovernments.org
-basePath: /messages
-x-common-path: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml'
-x-api-id: 'org.egov.localization'
-produces:
- - application/json
-
-#################################################
-paths:
- /v1/_search:
- post:
- summary: Get messages by locale and tenantId
- description: |
- Returns all the messages by locale and tenantId.
- parameters:
- - name: tenantId
- in: query
- description: Unique id for ulb.
- required: true
- type: string
- format: varchar
- - name: locale
- in: query
- description: locale for message.
- required: true
- type: string
- format: varchar
- - name : module
- in : query
- description : Module name for message
- required: true
- type : string
- format : varchar
- tags:
- - Messages
- responses:
- 200:
- description: An array of Messages
- schema:
- type: array
- items:
- $ref: '#/definitions/MessagesResponse'
- '400':
- description: tenantId and locale is not present
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
-#################################################
- /v1/_create:
- post:
- summary: Create messages for different locale
- description: |
- Create messages for different locale.
- parameters:
- - name: messageRequest
- in: body
- description: Message Object to create messages for different locale
- required: true
- schema:
- $ref: '#/definitions/MessagesRequest'
- tags:
- - Messages
- responses:
- 200:
- description: MessagesResponse as object
- schema:
- type: object
- items:
- $ref: '#/definitions/MessagesResponse'
- '400':
- description: Invalid message request input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
-#################################################
- /v1/_update:
- post:
- summary: update messages for different locale
- description: |
- update messages for different locale.
- parameters:
- - name: messageRequest
- in: body
- description: Message Object to update messages for different locale
- required: true
- schema:
- $ref: '#/definitions/UpdateMessageRequest'
- tags:
- - Messages
- responses:
- 200:
- description: MessagesResponse as object
- schema:
- $ref: '#/definitions/MessagesResponse'
- '400':
- description: Invalid message request input
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
-#################################################
- /v1/_delete:
- post:
- summary: delete messages
- description: |
- delete messages
- parameters:
- - name: messageRequest
- in: body
- description: Message Object to update messages for different locale
- required: true
- schema:
- $ref: '#/definitions/DeleteMessagesRequest'
- tags:
- - Messages
- responses:
- 200:
- description: MessagesResponse as object
- schema:
- $ref: '#/definitions/DeleteMessagesResponse'
- '400':
- description: Invalid delete message request
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-#################################################
-
-definitions:
-
- MessagesResponse:
- type: object
- properties:
- messages:
- type: array
- items:
- $ref: '#/definitions/Message'
- responseInfo :
- type: object
- items :
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
-#################################################
-
- DeleteMessagesResponse:
- type: object
- properties:
- successful:
- type: boolean
- responseInfo :
- type: object
- items :
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
-
-#################################################
- Message:
- type: object
- properties:
- code:
- type: string
- description: Code of message.
- message:
- type: string
- description: Description of Message.
- module :
- type : string
- description : module for message
- locale :
- type : string
- description : locale for message
-
-
-#################################################
- MessagesRequest:
- type: object
- properties:
- RequestInfo:
- items:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- messages:
- type: array
- items:
- $ref: '#/definitions/Message'
- tenantId :
- type : string
- description : Unique tenant id.
-
-
-#################################################
- UpdateMessageRequest:
- type: object
- properties:
- RequestInfo:
- items:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- locale :
- type: string
- description: Locale of message.
- tenantId :
- type: string
- description: Tenant of message.
- module :
- type: string
- description: Module of message..
- messages:
- type: array
- items:
- $ref: '#/definitions/UpdateMessage'
-
-#################################################
- UpdateMessage:
- type: object
- properties:
- code:
- type: string
- description: Code of message
- message:
- type: string
- description: Message
-
-#################################################
- DeleteMessagesRequest:
- type: object
- properties:
- RequestInfo:
- items:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- tenantId :
- type: string
- description: tenant id of message.
- messages:
- type: array
- items:
- $ref: '#/definitions/Message'
-
\ No newline at end of file
diff --git a/core-services/docs/mdms-contract.yml b/core-services/docs/mdms-contract.yml
deleted file mode 100644
index aeaf190c16b..00000000000
--- a/core-services/docs/mdms-contract.yml
+++ /dev/null
@@ -1,184 +0,0 @@
-swagger: '2.0'
-info:
- version: 1.0.0
- title: Master Data Management Service
- description: APIs available to get the master data for perticuler tenant and module master.
- contact:
- name: Abhishek Jain
-schemes:
- - https
-basePath: '/mdms/v1/[API endpoint]'
-paths:
- /_search:
- post:
- summary: Get list of masters for a particular module and tenantId.
- description: Get list of masters for a perticulare module and tenantId.
- parameters:
- - name: MdmsCriteriaReq
- in: body
- description: Details of module and master which need to be search using MDMS .
- required: true
- schema:
- $ref: '#/definitions/MdmsCriteriaReq'
- tags:
- - MDMS
- responses:
- '201':
- description: Designation created sucessfully.
- schema:
- $ref: '#/definitions/MdmsResponse'
- '400':
- description: Invalid input.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
- /_create:
- post:
- summary: Creates/Updates master data on github.
- description: Creates/Updates the module master data json files on the github through UI input.
- parameters:
- - name: MDMSCreateRequest
- in: body
- description: Details of the masterdata that is to be created/updated on github.
- required: true
- schema:
- $ref: '#/definitions/MDMSCreateRequest'
- tags:
- - MDMS
- responses:
- '201':
- description: Designation created sucessfully.
- schema:
- $ref: '#/definitions/MdmsCreateResponse'
- '400':
- description: Invalid input.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-
-definitions:
-
- MdmsCriteriaReq:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
-
- MdmsCriteria:
- $ref: '#/definitions/MdmsCriteria'
-
- MdmsCriteria:
- type: object
- properties:
- tenantId:
- description: Unique id for for a tenant.
- type: string
- minLength: 1
- maxLength: 100
-
- moduleDetails:
- type: array
- items:
- $ref: '#/definitions/ModuleDetail'
- required:
- - tenantId
- - moduleDetails
-
- ModuleDetail:
- type: object
- properties:
- moduleName:
- description: Name of the module for which master are required.
- type: string
- minLength: 1
- maxLength: 100
-
- masterDetails:
- type: array
- items:
- $ref: '#/definitions/MasterDetail'
-
- required:
- - moduleName
- - masterDetails
-
-
- MasterDetail:
- type: object
- properties:
- name:
- description: Unique id for for a tenant.
- type: string
- minLength: 1
- maxLength: 100
- filter:
- description: Pass JsonPath predicate to get ther filtered data for a master.
- type: string
- minLength: 1
- maxLength: 500
- required:
- - name
-
- MdmsResponse:
- type: object
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- mdms:
- type: array
- description: array of modules
- items:
- type: array
- description: array of masters
- items:
- type: object
-
- MDMSCreateRequest:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
-
- MasterMetaData:
- $ref: '#/definitions/MasterMetaData'
-
- MdmsCreateResponse:
- type: object
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
-
- Data:
- type: object
- description: content written on the file
-
- MasterMetaData:
- type: object
- properties:
- tenantId:
- description: Unique id for for a tenant.
- type: string
- minLength: 1
- maxLength: 100
-
- filePath:
- description: file path on git that is to be created/updated.
- type: string
- minLength: 1
- maxLength: 1000
-
- masterName:
- description: Master name to be created/updated.
- type: string
- minLength: 1
- maxLength: 100
-
- masterData:
- description: content of be written on the file.
- type: object
-
- required:
- - tenantId
- - filePath
- - masterName
- - masterData
-
diff --git a/core-services/docs/national-dashboard-ingest.yml b/core-services/docs/national-dashboard-ingest.yml
deleted file mode 100644
index 03297c9eba5..00000000000
--- a/core-services/docs/national-dashboard-ingest.yml
+++ /dev/null
@@ -1,213 +0,0 @@
-openapi: 3.0.0
-info:
- version: 1.0.0
- title: National Dashboard Data Ingest
- description: |
- ### API specs for Data ingest in National Dashboard ###
- The API provides a way to ingest key performance metrics for modules in the National Dashboard system so as to provide a combined view of all states data metrics in National Dashboards`
- contact:
- name: Client Placeholder
- email: client@email.com
-x-module: DSS
-x-common-path: 'https://raw.githubusercontent.com/egovernments/municipal-services/common-contract/docs/common-contract-v2-0-0.yml'
-paths:
- /national-dashboard/metric/_ingest:
- post:
- summary: API to ingest metrics in national dashboards on daily basis
- description: Ingest data metrics for given module
- tags:
- - Data Ingest
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/IngestRequest'
- description: Request schema.
- required: true
- responses:
- '202':
- description: Data ingested successfully
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/IngestResponse'
- '400':
- description: Failed to ingest the data
- content:
- '*/*':
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/municipal-services/common-contract/docs/common-contract-v2-0-0.yml#/components/schemas/ErrorRes'
- /national-dashboard/masterdata/_ingest:
- post:
- summary: Ingests master data in DSS system
- description: Ingest data master data like target metrics for given module
- tags:
- - Master Data Ingest
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/MasterDataRequest'
- description: Request schema.
- required: true
- responses:
- '202':
- description: Data ingested successfully
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/MasterDataResponse'
- '400':
- description: Failed to ingest the data
- content:
- '*/*':
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/municipal-services/common-contract/docs/common-contract-v2-0-0.yml#/components/schemas/ErrorRes'
-components:
- schemas:
- Data:
- type: object
- description: 'Data object containing metrics that are to be ingested for DSS Dashboards'
- properties:
- date:
- type: string
- description: Date of data ingestion in dd-MM-yyyy format
- example: "30-01-2022"
- module:
- type: string
- description: Module code for which data is ingested. Module code mapping is as follows
- "PT" -> "Property Tax",
- "TL" -> "Trade License",
- "WS" -> "Water and Sewerage",
- "OBPS" -> "Online Building Permission System",
- "FIRENOC" ->"Fire Noc" ,
- "PGR"-> "Public Grievance Redressal",
- "MCOLLECT" -> "Miscellaneous Collection",
- "COMMON" -> "Common attributes required for overview"
-
- enum: [PT, PGR, WS, SW, OBPS, FIRENOC, TL, MCOLLECT, COMMON]
- example: PT
- ward:
- type: string
- description: Ward Name
- minLength: 1
- maxLength: 64
- example: "Ajit Nagar"
- ulb:
- type: string
- description: ULB name
- minLength: 1
- maxLength: 64
- example: "amritsar"
- region:
- type: string
- description: The Region or District
- minLength: 1
- maxLength: 64
- example: "Amritsar-MC"
- state:
- type: string
- description: Name of the state which is pushing data
- example: Punjab
- minLength: 1
- maxLength: 64
- metrics:
- type: object
- description: Key-value pairs of metric_names to metric_values
- example: '{"tenantId":"pb.amritsar","state":"Punjab","ward":"Ajit Nagar","DDR":"Amritsar","transactions":2345,"totalApplications":2100,"assessedProperties":1400,"propertiesRegistered":[{"groupBy":"FinancialYear","buckets":[{"name":"2019-20","value":300},{"name":"2020-21","value":1100},{"name":"2021-22","value":100}]}],"totalCollection":[{"groupBy":"UsageCategory","buckets":[{"name":"RESIDENTIAL","value":8000},{"name":"COMMERCIAL","value":7500},{"name":"INDUSTRIAL","value":8500}]}],"propertyTax":[{"groupBy":"UsageCategory","buckets":[{"name":"RESIDENTIAL","value":8000},{"name":"COMMERCIAL","value":1000},{"name":"INDUSTRIAL","value":2000}]}],"cess":[{"groupBy":"UsageCategory","buckets":[{"name":"RESIDENTIAL","value":1500},{"name":"COMMERCIAL","value":700},{"name":"INDUSTRIAL","value":800}]}],"rebate":[{"groupBy":"UsageCategory","buckets":[{"name":"RESIDENTIAL","value":1000},{"name":"COMMERCIAL","value":0},{"name":"INDUSTRIAL","value":0}]}],"penalty":[{"groupBy":"UsageCategory","buckets":[{"name":"RESIDENTIAL","value":3000},{"name":"COMMERCIAL","value":1000},{"name":"INDUSTRIAL","value":2000}]}],"interest":[{"groupBy":"UsageCategory","buckets":[{"name":"RESIDENTIAL","value":1800},{"name":"COMMERCIAL","value":1000},{"name":"INDUSTRIAL","value":1200}]}]}'
- required:
- - date
- - module
- - ulb
- - ward
- - region
- - state
- - metrics
- IngestRequest:
- type: object
- description: Request object to ingest data in DSS system
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/schemas/RequestHeader'
- Data:
- $ref: '#/components/schemas/Data'
- required:
- - RequestInfo
- - Data
-
- IngestResponse:
- type: object
- description: Response object
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/municipal-services/common-contract/docs/common-contract-v2-0-0.yml#/components/schemas/ResponseHeader'
-
-
- MasterData:
- type: object
- description: 'Data object containing static master data to be ingested for DSS Dashboards'
- properties:
- financialYear:
- type: string
- description: Financial Year for which the master data is configured
- example: "2022-23"
- module:
- type: string
- description: Module for which data is ingested
- example: PT
- ulb:
- type: string
- description: ULB name
- minLength: 1
- maxLength: 64
- example: "amritsar"
- region:
- type: string
- description: The Region or District
- minLength: 1
- maxLength: 64
- example: "Amritsar-MC"
- state:
- type: string
- description: Name of the state which is pushing data
- example: Punjab
- minLength: 1
- maxLength: 64
- metrics:
- type: object
- description: Key-value pairs of metric_names to metric_values
- example: '{
- "snoForMuninipalCorporation": "1",
- "ulbName": "Amritsar",
- "budgetProposedForMunicipalCorporation": 10000000
- }'
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/municipal-services/common-contract/docs/common-contract-v2-0-0.yml#/components/schemas/AuditDetails'
- required:
- - financialYear
- - module
- - ulb
- - region
- - state
- - metrics
-
- MasterDataRequest:
- type: object
- description: Request object to ingest data in DSS system
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/schemas/RequestHeader'
- MasterData:
- $ref: '#/components/schemas/MasterData'
- required:
- - RequestInfo
- - MasterData
-
- MasterDataResponse:
- type: object
- description: Response object
- properties:
- responseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/municipal-services/common-contract/docs/common-contract-v2-0-0.yml#/components/schemas/ResponseHeader'
-
-
diff --git a/core-services/docs/report-contract.yml b/core-services/docs/report-contract.yml
deleted file mode 100644
index a81dcfc046c..00000000000
--- a/core-services/docs/report-contract.yml
+++ /dev/null
@@ -1,347 +0,0 @@
-swagger: '2.0'
-# eGSP YAML Template Version: 1.0
-# This is a version number for the YAML template. This must not be changed.
-
-info:
- version: 1.0.0
- title: Report Infrastructure
- description: |
- API specs to enable configurable reports in needed modules - the paths here will become subpath for the given modules base path. Please note that this cannot run as a standalone service and needs to be included in any module that requires configuration based reports. This module will then add aditional report sub-paths to existing module path and provide the sub paths to get report metadata and report data
-
- Mainly designed to take care of RDBMS/SQL based reports
- contact:
- name: info
-host: phoenix-qa.egovernments.org
-schemes:
- - https
-basePath: '/[module_base_path]/reports/v1'
-
-paths:
- /metadata/_get:
- post:
- summary: Metadata API for report definition
- description: |
- Gets the report description, column definitions, labels and types.
- parameters:
- - name: reportRequest
- in: body
- description: Report request
- required: true
- schema:
- $ref: "#/definitions/MetadataRequest"
- responses:
- 200:
- description: Successful response
- schema:
- $ref: "#/definitions/MetadataResponse"
- '400':
- description: Invalid input.
- schema:
- $ref: '#/definitions/ReportErrorRes'
- tags:
- - Report Meta
-
- /_get:
- post:
- summary: Search API for report data
- description: |
- Get the report data based on the given search parameters.
- parameters:
- - name: reportRequest
- in: body
- description: Report request
- required: true
- schema:
- $ref: "#/definitions/ReportRequest"
- responses:
- 200:
- description: Successful response
- schema:
- $ref: "#/definitions/ReportResponse"
- '400':
- description: Invalid input.
- schema:
- $ref: '#/definitions/ReportErrorRes'
- tags:
- - Report
-
-definitions:
-
- MetadataRequest:
- type: object
- description: Request object to fetch the report data
- properties:
- requestInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo"
- tenantId:
- description: tenantId for which the report is needed
- type: string
- reportName:
- description: |
- name of the report. A tenant specific report can be defined with tenantId as the prefix of the report name. So if the system finds two reports - report1 and mytenant.report1 and the tenantId for this request is mytenant then report definition mytenant.report1 will be picked
- type: string
- required:
- - requestInfo
- - tenantId
- - reportName
-
- MetadataResponse:
- type: object
- description: Response to the metadata request
- properties:
- requestInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo"
- tenantId:
- description: tenantId for which the report is needed
- type: string
- reportDetails:
- $ref: "#/definitions/ReportMetadata"
-
- ReportRequest:
- allOf:
- - $ref: "#/definitions/MetadataRequest"
- - type: object
- description: Request object to fetch the report data
- properties:
- searchParams:
- description: |
- array of search parameters to use in report query
- type: array
- items:
- $ref: "#/definitions/SearchParam"
-
- ReportResponse:
- type: object
- description: Response object that has fetched report data
- properties:
- requestInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo"
- reportHeader:
- description: Array of report columns
- type: array
- items:
- $ref: "#/definitions/ColumnDetail"
- ttl:
- description: UTC epoch upto which report data can be cached
- type: integer
- format: int64
- reportData:
- description: two dimensional array containing the report data
- type: array
- items:
- type: array
- items:
- type: object
-
- ColumnDef:
- type: object
- description: Header information for the report
- properties:
- name:
- description: column names of the report
- type: string
- required:
- - name
-
- SearchParam:
- allOf:
- - $ref: "#/definitions/ColumnDef"
- - type: object
- properties:
- input:
- description: |
- User provided input of this parameter that will be used in query. Please note that value will be format checked against the value definition of this parameter in report definition. This field has been made an object so that multiple values from things like multivalue list can be accepted.
- type: object
-
- ColumnDetail:
- allOf:
- - $ref: '#/definitions/ColumnDef'
- - type: object
- properties:
- label:
- description: localization label for the column. In case label is not provided, name would be used as a label.
- type: string
- type:
- description: |
- column type to help the consumer. EPOCH means time being carried over in epoch format, while date means time in given display format
- URL - will be used to indicate taht the column value is basically a URL to some other resource
- type: string
- enum:
- - number
- - string
- - date
- - datetime
- - epoch
- - url
- - singlevaluelist
- - multivaluelist
- defaultValue:
- type: object
- description: |
- any default value for the column if the column type is number, string, date, datetime, epoch or URL
- collection contaning possible list value pairs for singlevaluelist and multivaluelist
- the parameterized next click URL in case of drill down - the value inside {} needs to be replaced with the actual value of the column with that name
- isMandatory:
- type: boolean
- default: true
- showColumn:
- description: |
- whether to display the column value on the page, useful in cases like drill downs where teh value is needed for next search but is not meaningful to be shown to the user
- type: boolean
- default: true
- required:
- - type
-
- ReportMetadata:
- type: object
- description: meta information about the report
- properties:
- reportName:
- description: |
- name of the report. A tenant specific report can be defined with tenantId as the prefix of the report name. So if the system finds two reports - report1 and mytenant.report1 and the tenantId for this request is mytenant then r eport definition mytenant.report1 will be picked.
-
- Please note that by convention reportname.title and reportname.summary will be teh localization key for the report title and brief description.
- type: string
- summary:
- description: |
- Brief description about the report and its usage. E.g. "This report gives you a list of active reources within the date range provided in the search criteria"
- reportHeader:
- description: |
- List of display columns in the report
- type: array
- items:
- $ref: "#/definitions/ColumnDetail"
- searchParams:
- description: |
- array of search parameters to use in report query
- type: array
- items:
- $ref: "#/definitions/ColumnDetail"
-
- ReportErrorRes:
- allOf:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- - type: object
- properties:
- codes:
- type: string
- enum:
- - ReportDefNotFound
- - InvalidSearchParams
- - TenantNotFound
-
- #Let's try to define the report structure also here - will decide later whether to move it to a different YAML
-
- SourceColumn:
- description: |
- This is the column definition for the purpose of defining the report. Please note that in case of external column (basicaly columns fetched from external service) dependsOn indicates the internal column which needs to be send as the paarmeter for teh external url to respond with result that will contain the value at the configured JSONpath.
- allOf:
- - $ref: '#/definitions/ColumnDetail'
- - type: object
- properties:
- source:
- type: string
- description: |
- Table/Index path to which the column belongs
- colName:
- type: string
- description: |
- column name in the table/index
- linkPattern:
- type: string
- description: |
- pattern to indicate to UI about additional serach param names and their values
- _parent?reportName={drillDownReportName}&columnname={sourceColumnValue}&columnname={sourceColumnValue}
- isExternal:
- type: boolean
- default: false
- description: |
- flag to indicate that this column value can be fetched from external service. This will be useful when we start segragating the services in their own physical data stores
- url:
- type: string
- description: |
- parameterized URL to external system if isExternal is true - Please note that all placeholders parameters in the URL (represented within {} e.g. {username}) should match one available within the report definition sourceColumn or searchParam as the case may be.
- jsonPath:
- type: string
- description: |
- JSONPath of the field in the response JSON from the external service
- dependsOn:
- $ref: '#/definitions/SourceColumn'
- required:
- - source
- - colName
-
- SearchColumn:
- description: |
- This is the column definition for the purpose of defining the search columns
- allOf:
- - $ref: '#/definitions/ColumnDetail'
- - type: object
- properties:
- source:
- type: string
- description: |
- Table/Index path to which the column belongsor the URL from which to fecth the data if it is a singlevalue or multivalue list
- colName:
- type: string
- description: |
- column name in the table/index
- pattern:
- type: string
- description: |
- 1. display format for the column - in case of epoch type datatypes.
- 2. In case of single/multivalue list this will be pipe separated url|keyJSONPath|valueJSONPath (URL to fetch the list values, jsonPath of the key value, jsonPath of what to display)
- 2.1 In case the URL wants the values to be statically defined as a list use list://pipe_separated_values!
- 3. In case the other datatype - this will be the parametarized URL that consumer can then use to call the next drill down/action - for drill down use _parent?key=value&key=value (where key would be name of additional params and value search value to construct new search params)
- required:
- - source
- - colName
-
- ReportDefinition:
- type: object
- description: |
- Combination of below properties provides the decription of a report that can be generically obtained from the framework. Please note that in this version, only reports out of RDBMS are supported - but later the framework will be enhanced to support reports out of RDBMS/Cross service non join reports from RDBMS/Elastic search and mashups.
- required:
- - reportName
- - summary
- - version
- - query
- - sourceColumns
- - searchParams
- properties:
- reportName:
- description: |
- name of the report. A tenant specific report can be defined with tenantId as the prefix of the report name. So if the system finds two reports - report1 and mytenant.report1 and the tenantId for this request is mytenant then report definition mytenant.report1 will be picked.
-
- Please note that by convention reportname.title and reportname.summary will be the localization key for the report title and brief description.
- type: string
- summary:
- description: |
- Brief description about the report and its usage. E.g. "This report gives you a list of active reources within the date range provided in the search criteria"
- type: string
- version:
- description: |
- Version of the report farmework - this will help in enhancing the reporting framework in phased manner - planning to support upto two recent versions of backward compatibility. Versioning scheme is purely number based and decided by the framework and not indivdual Report definitions
- type: string
- query:
- description: |
- SQL style search clause with display column mapping and replaceable search parameters. Please note that all placeholders column in the query (represented within {} e.g. {username}) should match corresponding sourceColumn or searchParam as the case may be.
- type: string
- sourceColumns:
- description: |
- list of columns to to select from the source tables. This should then correspond to the list of report columns that are send back to the caller in report metadata. Please note that all columns must have one one of the sources from above list as their source or the report definition will not be loaded.
- type: array
- items:
- $ref: "#/definitions/SourceColumn"
- searchParams:
- description: |
- list of the supported parameters for search.
- type: array
- items:
- $ref: "#/definitions/SearchColumn"
- linkPattern:
- type: string
- description: |
- pattern to indicate to UI about additional serach param names and their values
- _parent?reportName={drillDownReportName}&columnname={sourceColumnValue}&columnname={sourceColumnValue}
-
\ No newline at end of file
diff --git a/core-services/egov-accesscontrol/README.md b/core-services/egov-accesscontrol/README.md
index 056c3fa2915..41558060c45 100644
--- a/core-services/egov-accesscontrol/README.md
+++ b/core-services/egov-accesscontrol/README.md
@@ -12,7 +12,7 @@ Access Control Service(ACS) main job is to Authorize end user based on their rol
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/access-control-contract.yml#!/) for access control service to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-accesscontrol/contracts/v1-0-1.yml#!/) for access control service to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/core-services/egov-enc-service/README.md b/core-services/egov-enc-service/README.md
index 0c5dfdad69f..1e212408101 100644
--- a/core-services/egov-enc-service/README.md
+++ b/core-services/egov-enc-service/README.md
@@ -13,7 +13,7 @@ Encryption Service is used to secure the data. It provides functionality to encr
### Swagger API Contract
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/enc-service-contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/core-services/gopesh67-patch-8/docs/enc-service-contract.yml#!/
## Service Details
diff --git a/core-services/egov-filestore/README.md b/core-services/egov-filestore/README.md
index 96d2499efb9..02b941d6a4c 100644
--- a/core-services/egov-filestore/README.md
+++ b/core-services/egov-filestore/README.md
@@ -13,7 +13,6 @@ Filestore provides file upload capability for all the rest of the modules in the
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/filestore-service-contract.yml) for Filestore service to understand the structure of APIs and to have visualization of all internal APIs.
diff --git a/core-services/egov-idgen/README.md b/core-services/egov-idgen/README.md
index d6f562d6f08..86bbcf2c816 100644
--- a/core-services/egov-idgen/README.md
+++ b/core-services/egov-idgen/README.md
@@ -14,7 +14,7 @@ The egov-idgen service generates new id based on the id formats passed. The appl
Link to the swagger API contract yaml and editor link like below
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/idgen-contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/idgen/contracts/v1-0-0.yml#!/
## Service Details
diff --git a/core-services/egov-indexer/README.md b/core-services/egov-indexer/README.md
index e4acac83e28..4854a7a90ff 100644
--- a/core-services/egov-indexer/README.md
+++ b/core-services/egov-indexer/README.md
@@ -13,7 +13,7 @@
### Swagger API Contract
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/indexer-contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/core-services/RAIN-1284/docs/indexer-contract.yml#!/
## Service Details
diff --git a/core-services/egov-localization/README.md b/core-services/egov-localization/README.md
index 24c4b351a25..fc6bcef0a19 100644
--- a/core-services/egov-localization/README.md
+++ b/core-services/egov-localization/README.md
@@ -14,7 +14,6 @@ This service provides localisation capacity to the Digit suite of services.
### Swagger API Contract
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/localisation-contract.yml#!/
diff --git a/core-services/egov-location/README.md b/core-services/egov-location/README.md
index 24949f4d26b..b10d9061064 100644
--- a/core-services/egov-location/README.md
+++ b/core-services/egov-location/README.md
@@ -10,7 +10,7 @@ An eGov core application which provides location details of the tenant for which
### Swagger API Contract
-Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/egov-location-contract.yml#!/) for egov-location service to understand the structure of APIs and to have visualization of all internal APIs.
+Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-location/contracts/v11-0-0.yml#!/) for egov-location service to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/core-services/egov-mdms-service/README.md b/core-services/egov-mdms-service/README.md
index db075eb9740..b2fc7a24cc1 100644
--- a/core-services/egov-mdms-service/README.md
+++ b/core-services/egov-mdms-service/README.md
@@ -12,7 +12,7 @@ Master Data Management Service is a core service that is made available on the D
### Swagger API Contract
Please refer to the below Swagger API contarct for MDMS service to understand the structure of APIs and to have visualization of all internal APIs.
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/mdms-contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/mdms/contract/v1-0-0.yml#!/
## Service Details
diff --git a/core-services/egov-otp/README.md b/core-services/egov-otp/README.md
index 878458a3111..d7c5efb0bfb 100644
--- a/core-services/egov-otp/README.md
+++ b/core-services/egov-otp/README.md
@@ -22,7 +22,7 @@ The functionality is exposed via REST API.
Link to the swagger API contract yaml and editor link like below
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/egov-otp-contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-otp/contract/v1-0-0.yml#!/
diff --git a/core-services/egov-pg-service/README.md b/core-services/egov-pg-service/README.md
index fff1d835f58..8cc35435665 100644
--- a/core-services/egov-pg-service/README.md
+++ b/core-services/egov-pg-service/README.md
@@ -15,7 +15,7 @@ Module acts as a liaison between eGov apps and external payment gateways. It fac
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/egov-pg-contract.yml#!/) for egov-pg service to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/core/egov-pg-service/egov-pg-service.yml#!/) for egov-pg service to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/core-services/egov-url-shortening/README.md b/core-services/egov-url-shortening/README.md
index c1b90d86bcd..81a88009d8f 100644
--- a/core-services/egov-url-shortening/README.md
+++ b/core-services/egov-url-shortening/README.md
@@ -14,7 +14,7 @@ NA
### Swagger API Contract
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/url-shortening_contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/core-services/gopesh67-patch-8/docs/url-shortening_contract.yml#!/
## Service Details
The egov-url-shortening is used to compress long urls. The converted short urls contains id, which is used by this service to identify and get longer urls. When user opens
diff --git a/core-services/egov-user/README.md b/core-services/egov-user/README.md
index 92cbdb01ec5..d4f450f75e2 100644
--- a/core-services/egov-user/README.md
+++ b/core-services/egov-user/README.md
@@ -16,7 +16,7 @@
### Swagger API Contract
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/egov-user-contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-user/contracts/v1-1-0.yml#!/
## Service Details
diff --git a/core-services/egov-workflow-v2/README.md b/core-services/egov-workflow-v2/README.md
index 804482362f5..759e7364cc9 100644
--- a/core-services/egov-workflow-v2/README.md
+++ b/core-services/egov-workflow-v2/README.md
@@ -11,7 +11,7 @@ Workflows are a series of steps that moves a process from one state to another s
### Swagger API Contract
-Please refer to the [Swagger API contract](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/worfklow-2.0.yml#!/) for egov-workflow-v2 service to understand the structure of APIs and to have visualization of all internal APIs.
+Please refer to the [Swagger API contract](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/core-services/master/docs/worfklow-2.0.yml#!/) for egov-workflow-v2 service to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/core-services/report/README.md b/core-services/report/README.md
index b3d90bf8410..3b1e354c0ad 100644
--- a/core-services/report/README.md
+++ b/core-services/report/README.md
@@ -12,8 +12,7 @@ couple of APIS.
- `egov-mdms-service`: used by encryption library to load encryption configs
### Swagger API Contract
-
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/report-contract.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/reportinfra/contracts/reportinfra-1-0-0.yml#!/
## Service Details
diff --git a/municipal-services/bpa-calculator/README.md b/municipal-services/bpa-calculator/README.md
index dbbc99a3840..1651d906e04 100644
--- a/municipal-services/bpa-calculator/README.md
+++ b/municipal-services/bpa-calculator/README.md
@@ -19,7 +19,7 @@ bpa-calculator service used to generate Application Fee, Sanction Fee, Low Appli
### Swagger API Contract
- - [Swagger API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/bpa/bpa-calculator.yaml#!/)
+ - [Swagger API](https://github.com/egovernments/municipal-services/blob/master/docs/bpa/bpa-calculator.yaml)
## Service Details
diff --git a/municipal-services/bpa-services/README.md b/municipal-services/bpa-services/README.md
index 34609e1ab41..1b04e4850b4 100755
--- a/municipal-services/bpa-services/README.md
+++ b/municipal-services/bpa-services/README.md
@@ -52,7 +52,7 @@ Module is used to apply for Building Plan Approval, Building Plan Occupancy Cert
### Swagger API Contract
-- [Swagger API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/bpa/bpa-service.yaml#!/)
+- [Swagger API](https://github.com/egovernments/municipal-services/blob/master/docs/bpa/bpa-service.yaml)
## Service Details
diff --git a/municipal-services/docs/fire_noc_calculation_service.yaml b/municipal-services/docs/fire_noc_calculation_service.yaml
deleted file mode 100644
index 5450cbab7ec..00000000000
--- a/municipal-services/docs/fire_noc_calculation_service.yaml
+++ /dev/null
@@ -1,339 +0,0 @@
-swagger: "2.0"
-info:
- version: 2.0.0
- title: Fire NOC Calculation APIs
- description: |
- APIs available for Fire NOC
- - Calculate Fire NOC Fee.
- contact:
- name: eGovernments Foundation
- email: contacts@egovernments.org
-schemes:
- - https
-basePath: /firenoc-calculator/
-paths:
- /v1/_calculate:
- post:
- summary: Calculates Fire NOC fee and generates the respective demands in the system.
- description: Calculate Fire NOC Fee based on criteria.
- tags:
- - Fire NOC Calculation
- parameters:
- - name: calculationReq
- in: body
- description: required parameters have to be populated
- required: true
- schema:
- $ref: "#/definitions/CalculationReq"
- responses:
- "200":
- description: Success response with calculated tax amount.
- schema:
- $ref: "#/definitions/CalculationRes"
- "400":
- description: Error response in case of failures.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes"
- /v1/_getbill:
- post:
- summary: Updates demand with time based penalty if applicable and Generates bill for the given criteria.
- description: Generates bill for payment.
- tags:
- - Fire NOC Bill
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/requestInfo"
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/tenantId"
- - name: consumerCode
- in: query
- description: Unique Fire NOC application number.
- required: true
- type: string
- responses:
- "200":
- description: Success response calculated tax amount.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/billingservice/contracts/v1-0-0.yml#/definitions/Bill"
- "400":
- description: Error response in case of failures.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes"
- /billingslab/_search:
- post:
- summary: Get the list of bill slabs defined in the system for Fire NOC calculation.
- description: |
- Get the properties list based on the input parameters.
- tags:
- - BillingSlab
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/requestInfo"
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: isActive
- in: query
- description: True will be set in cases where only active billslab entries are needed and False will be set when inactive billslab entries are needed .
- required: false
- type: boolean
- format: varchar
- allowEmptyValue: true
- - name: fireNOCType
- in: query
- description: Fire NOC type for bulling slab.
- required: false
- type: string
- format: varchar
- enum:
- - NEW
- - PROVISIONAL
- - name: buildingUsageType
- in: query
- required: false
- description: buildingUsageType of property.
- type: string
- minLength: 4
- maxLength: 128
- exclusiveMinimum: true
- exclusiveMaximum: false
- - name: calculationType
- in: query
- required: false
- description: Enum for billing slab type.
- type: string
- minLength: 4
- maxLength: 128
- exclusiveMinimum: true
- exclusiveMaximum: false
- enum:
- - SINGLESLAB
- - MULTISLAB
- - FLAT
- responses:
- "200":
- description: Successful response
- schema:
- $ref: "#/definitions/BillingSlabRes"
- "400":
- description: Invalid input.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes"
- /billingslab/_create:
- post:
- summary: Create new billing slabs for Fire NOC calculation.
- description: API to billing slabs for Fire NOC calculation.
- tags:
- - BillingSlab
- parameters:
- - name: billingSlab
- in: body
- description: Details for the new slab + RequestInfo meta data.
- required: true
- schema:
- $ref: "#/definitions/BillingSlabReq"
- responses:
- "201":
- description: Billing Slab(s) created sucessfully
- schema:
- $ref: "#/definitions/BillingSlabRes"
- "400":
- description: Billing Slab(s) creation failed
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes"
- /billingslab/_update:
- post:
- summary: Update existing billing slabs.
- description: Updates a given billing slab with new properties
- parameters:
- - name: billingSlab
- in: body
- description: Request header for the update of billing slab.
- required: true
- schema:
- $ref: "#/definitions/BillingSlabReq"
- tags:
- - BillingSlab
- responses:
- "200":
- description: Update Billing Slab(s) successful
- schema:
- $ref: "#/definitions/BillingSlabRes"
- "400":
- description: Update Billing Slab(s) failed
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes"
-definitions:
- CalulationCriteria:
- description: Either Fire NOC object or the application number is mandatory apart from tenantid.
- type: object
- properties:
- fireNOC:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/noc/rainmaker/firenoc-services/docs/contract/fire_noc_contract.yaml#/definitions/FireNOC"
- applicationNumber:
- type: string
- minLength: 2
- maxLength: 64
- tenantId:
- type: string
- minLength: 2
- maxLength: 256
- required:
- - tenantId
- Calculation:
- type: object
- properties:
- applicationNumber:
- type: string
- description: Fire NOC application number.
- fireNoc:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/noc/rainmaker/firenoc-services/docs/contract/fire_noc_contract.yaml#/definitions/FireNOC"
- tenantId:
- type: string
- minLength: 2
- maxLength: 256
- taxHeadEstimates:
- type: array
- items:
- $ref: "#/definitions/taxHeadEstimate"
-
- description: Total Exemption amount if applicable.
- BillingSlab:
- type: object
- properties:
- tenantId:
- type: string
- description: Unique ulb identifier
- maxLength: 128
- minLength: 4
- id:
- type: string
- description: unique identifier of the billing slab uuid
- maxLength: 64
- minLength: 2
- isActive:
- type: boolean
- description: boolean value to specify if billslab entry is active or not
- fireNOCType:
- type: string
- description: FireNOCType, is unique enum value for a noc
- enum:
- - NEW
- - PROVISIONAL
- buildingUsageType:
- type: string
- description: buildingUsageType, this is mdms data which specifies builiding usage and one of the factor to decide rate.
- maxLength: 64
- minLength: 2
- calculationType:
- type: string
- description: Type will define the rate value is flat amount or rate.
- enum:
- - SINGLESLAB
- - MULTISLAB
- - FLAT
- rate:
- type: number
- format: double
- description: Rate of the Fire NOC, this can be the rate of flat amount based on type or can be slab rate per unit based on type.
- uom:
- type: string
- description: unit of measurement of bill slab.
- maxLength: 32
- minLength: 2
- fromUom:
- type: number
- format: double
- description: uom value lower bound.
- toUom:
- type: number
- format: double
- description: uom value upper bound.
- fromDate:
- type: integer
- format: int64
- description: Epoch Date for starting of billing slab.
- toDate:
- type: integer
- format: int64
- description: Epoch Date for ending of billing slab.
- auditDetails:
- $ref: "#/definitions/AuditDetails"
-
- required:
- - tenantId
- - calculationType
- - rate
- - uom
- - buildingUsageType
- - fireNOCType
- - fromDate
- CalculationReq:
- type: object
- properties:
- RequestInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo"
- CalulationCriteria:
- type: array
- maximum: 100
- items:
- $ref: "#/definitions/CalulationCriteria"
- required:
- - RequestInfo
- - CalulationCriteria
- CalculationRes:
- type: object
- properties:
- ResponseInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo"
- Calculation:
- type: array
- items:
- $ref: "#/definitions/Calculation"
- BillingSlabReq:
- type: object
- properties:
- RequestInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo"
- BillingSlabs:
- type: array
- maximum: 100
- items:
- $ref: "#/definitions/BillingSlab"
- required:
- - RequestInfo
- - BillingSlabs
- BillingSlabRes:
- type: object
- properties:
- ResponseInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ResponseInfo"
- BillingSlabs:
- type: array
- items:
- $ref: "#/definitions/BillingSlab"
- AuditDetails:
- type: object
- properties:
- createdBy:
- type: string
- description: Id of the user who created the record.
- createdDate:
- type: integer
- format: int64
- description: Epoch Date on which the user master data was added into the system.
- lastModifiedBy:
- type: string
- description: Id of the user who last modified the record.
- lastModifiedDate:
- type: integer
- format: int64
- description: Epoch Date on which the user master data was last modified.
- taxHeadEstimate:
- type: object
- properties:
- category:
- type: string
- description: Category of taxhead
- taxHeadCode:
- type: string
- description: Taxhead code from billing service for estimate
- setimateAmount:
- type: number
- format: double
- description: Calculated amount for taxhead
\ No newline at end of file
diff --git a/municipal-services/docs/fire_noc_contract.yaml b/municipal-services/docs/fire_noc_contract.yaml
deleted file mode 100644
index 5450cbab7ec..00000000000
--- a/municipal-services/docs/fire_noc_contract.yaml
+++ /dev/null
@@ -1,339 +0,0 @@
-swagger: "2.0"
-info:
- version: 2.0.0
- title: Fire NOC Calculation APIs
- description: |
- APIs available for Fire NOC
- - Calculate Fire NOC Fee.
- contact:
- name: eGovernments Foundation
- email: contacts@egovernments.org
-schemes:
- - https
-basePath: /firenoc-calculator/
-paths:
- /v1/_calculate:
- post:
- summary: Calculates Fire NOC fee and generates the respective demands in the system.
- description: Calculate Fire NOC Fee based on criteria.
- tags:
- - Fire NOC Calculation
- parameters:
- - name: calculationReq
- in: body
- description: required parameters have to be populated
- required: true
- schema:
- $ref: "#/definitions/CalculationReq"
- responses:
- "200":
- description: Success response with calculated tax amount.
- schema:
- $ref: "#/definitions/CalculationRes"
- "400":
- description: Error response in case of failures.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes"
- /v1/_getbill:
- post:
- summary: Updates demand with time based penalty if applicable and Generates bill for the given criteria.
- description: Generates bill for payment.
- tags:
- - Fire NOC Bill
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/requestInfo"
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/tenantId"
- - name: consumerCode
- in: query
- description: Unique Fire NOC application number.
- required: true
- type: string
- responses:
- "200":
- description: Success response calculated tax amount.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/billingservice/contracts/v1-0-0.yml#/definitions/Bill"
- "400":
- description: Error response in case of failures.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes"
- /billingslab/_search:
- post:
- summary: Get the list of bill slabs defined in the system for Fire NOC calculation.
- description: |
- Get the properties list based on the input parameters.
- tags:
- - BillingSlab
- parameters:
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/requestInfo"
- - $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId"
- - name: isActive
- in: query
- description: True will be set in cases where only active billslab entries are needed and False will be set when inactive billslab entries are needed .
- required: false
- type: boolean
- format: varchar
- allowEmptyValue: true
- - name: fireNOCType
- in: query
- description: Fire NOC type for bulling slab.
- required: false
- type: string
- format: varchar
- enum:
- - NEW
- - PROVISIONAL
- - name: buildingUsageType
- in: query
- required: false
- description: buildingUsageType of property.
- type: string
- minLength: 4
- maxLength: 128
- exclusiveMinimum: true
- exclusiveMaximum: false
- - name: calculationType
- in: query
- required: false
- description: Enum for billing slab type.
- type: string
- minLength: 4
- maxLength: 128
- exclusiveMinimum: true
- exclusiveMaximum: false
- enum:
- - SINGLESLAB
- - MULTISLAB
- - FLAT
- responses:
- "200":
- description: Successful response
- schema:
- $ref: "#/definitions/BillingSlabRes"
- "400":
- description: Invalid input.
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes"
- /billingslab/_create:
- post:
- summary: Create new billing slabs for Fire NOC calculation.
- description: API to billing slabs for Fire NOC calculation.
- tags:
- - BillingSlab
- parameters:
- - name: billingSlab
- in: body
- description: Details for the new slab + RequestInfo meta data.
- required: true
- schema:
- $ref: "#/definitions/BillingSlabReq"
- responses:
- "201":
- description: Billing Slab(s) created sucessfully
- schema:
- $ref: "#/definitions/BillingSlabRes"
- "400":
- description: Billing Slab(s) creation failed
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes"
- /billingslab/_update:
- post:
- summary: Update existing billing slabs.
- description: Updates a given billing slab with new properties
- parameters:
- - name: billingSlab
- in: body
- description: Request header for the update of billing slab.
- required: true
- schema:
- $ref: "#/definitions/BillingSlabReq"
- tags:
- - BillingSlab
- responses:
- "200":
- description: Update Billing Slab(s) successful
- schema:
- $ref: "#/definitions/BillingSlabRes"
- "400":
- description: Update Billing Slab(s) failed
- schema:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes"
-definitions:
- CalulationCriteria:
- description: Either Fire NOC object or the application number is mandatory apart from tenantid.
- type: object
- properties:
- fireNOC:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/noc/rainmaker/firenoc-services/docs/contract/fire_noc_contract.yaml#/definitions/FireNOC"
- applicationNumber:
- type: string
- minLength: 2
- maxLength: 64
- tenantId:
- type: string
- minLength: 2
- maxLength: 256
- required:
- - tenantId
- Calculation:
- type: object
- properties:
- applicationNumber:
- type: string
- description: Fire NOC application number.
- fireNoc:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/noc/rainmaker/firenoc-services/docs/contract/fire_noc_contract.yaml#/definitions/FireNOC"
- tenantId:
- type: string
- minLength: 2
- maxLength: 256
- taxHeadEstimates:
- type: array
- items:
- $ref: "#/definitions/taxHeadEstimate"
-
- description: Total Exemption amount if applicable.
- BillingSlab:
- type: object
- properties:
- tenantId:
- type: string
- description: Unique ulb identifier
- maxLength: 128
- minLength: 4
- id:
- type: string
- description: unique identifier of the billing slab uuid
- maxLength: 64
- minLength: 2
- isActive:
- type: boolean
- description: boolean value to specify if billslab entry is active or not
- fireNOCType:
- type: string
- description: FireNOCType, is unique enum value for a noc
- enum:
- - NEW
- - PROVISIONAL
- buildingUsageType:
- type: string
- description: buildingUsageType, this is mdms data which specifies builiding usage and one of the factor to decide rate.
- maxLength: 64
- minLength: 2
- calculationType:
- type: string
- description: Type will define the rate value is flat amount or rate.
- enum:
- - SINGLESLAB
- - MULTISLAB
- - FLAT
- rate:
- type: number
- format: double
- description: Rate of the Fire NOC, this can be the rate of flat amount based on type or can be slab rate per unit based on type.
- uom:
- type: string
- description: unit of measurement of bill slab.
- maxLength: 32
- minLength: 2
- fromUom:
- type: number
- format: double
- description: uom value lower bound.
- toUom:
- type: number
- format: double
- description: uom value upper bound.
- fromDate:
- type: integer
- format: int64
- description: Epoch Date for starting of billing slab.
- toDate:
- type: integer
- format: int64
- description: Epoch Date for ending of billing slab.
- auditDetails:
- $ref: "#/definitions/AuditDetails"
-
- required:
- - tenantId
- - calculationType
- - rate
- - uom
- - buildingUsageType
- - fireNOCType
- - fromDate
- CalculationReq:
- type: object
- properties:
- RequestInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo"
- CalulationCriteria:
- type: array
- maximum: 100
- items:
- $ref: "#/definitions/CalulationCriteria"
- required:
- - RequestInfo
- - CalulationCriteria
- CalculationRes:
- type: object
- properties:
- ResponseInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo"
- Calculation:
- type: array
- items:
- $ref: "#/definitions/Calculation"
- BillingSlabReq:
- type: object
- properties:
- RequestInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo"
- BillingSlabs:
- type: array
- maximum: 100
- items:
- $ref: "#/definitions/BillingSlab"
- required:
- - RequestInfo
- - BillingSlabs
- BillingSlabRes:
- type: object
- properties:
- ResponseInfo:
- $ref: "https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ResponseInfo"
- BillingSlabs:
- type: array
- items:
- $ref: "#/definitions/BillingSlab"
- AuditDetails:
- type: object
- properties:
- createdBy:
- type: string
- description: Id of the user who created the record.
- createdDate:
- type: integer
- format: int64
- description: Epoch Date on which the user master data was added into the system.
- lastModifiedBy:
- type: string
- description: Id of the user who last modified the record.
- lastModifiedDate:
- type: integer
- format: int64
- description: Epoch Date on which the user master data was last modified.
- taxHeadEstimate:
- type: object
- properties:
- category:
- type: string
- description: Category of taxhead
- taxHeadCode:
- type: string
- description: Taxhead code from billing service for estimate
- setimateAmount:
- type: number
- format: double
- description: Calculated amount for taxhead
\ No newline at end of file
diff --git a/municipal-services/docs/noc-v-1.0.0.yaml b/municipal-services/docs/noc-v-1.0.0.yaml
deleted file mode 100644
index 79ef105d60a..00000000000
--- a/municipal-services/docs/noc-v-1.0.0.yaml
+++ /dev/null
@@ -1,281 +0,0 @@
-openapi: 3.0.0
-info:
- version: "1.0.0"
- title: eGov Noc(No objection certificate) application registry
- description: |
- Noc registry store and serve the NOC related information using rest APIs
- Mainly it has below functionalities
- 1. Apply for new NOC
- 2. Allow user to search the existing NOC information based on roles
- 3. Allow user to take action on the application based on the user role
- 4. Update the NOC information for an existing application based state and role configuration
-
- contact:
- name: Egovernments Foundation
- email: contact@egovernments.org
-x-module: NOC
-x-common-path: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml'
-paths:
-
- /v1/noc/_create:
- post:
- summary: Apply for an NOC.
- description: Citizen or Employee, can apply for new build plan approval
- x-roles: 'BPA_ARCHITECT,CITIZEN,EMPLOYEE'
- responses:
- '202':
- description: Application submitted successfully
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/NocResponse'
- '400':
- description: Failed to process the application
- content:
- '*/*':
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/schemas/ErrorRes'
- tags:
- - Noc Apply
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/NocRequest'
- description: Fill Bpa application details and submit the request.
- required: true
- /v1/noc/_update:
- post:
- summary: Update existing application.
- description: Updates a given `application` with newer details.
- x-roles: 'BPA_ARCHITECT,CITIZEN,EMPLOYEE'
- tags:
- - Noc Apply
- responses:
- '202':
- description: Application updated successfully
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/NocResponse'
- '400':
- description: Failed to update
- content:
- '*/*':
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/schemas/ErrorRes'
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/NocRequest'
- description: Request to update existing application details.
- required: true
- /v1/noc/_search:
- post:
- summary: Get the list of application by passing the diffrent search criteria.
- description: |
- Get the properties list based on the input parameters.
- x-roles: 'CITIZEN,EMPLOYEE'
- parameters:
-
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/parameters/tenantId'
- - name: ids
- in: query
- description: List of system generated ids of Noc applications.
- required: false
- schema:
- type: array
- items:
- type: string
- - name: applicationNo
- in: query
- description: application numbers
- required: false
- schema:
- type: string
- - name: nocNo
- in: query
- description: approval no
- required: false
- schema:
- type: string
-
- responses:
- '200':
- description: Successful response
- content:
- '*/*':
- schema:
- $ref: '#/components/schemas/NocResponse'
- '400':
- description: Invalid input.
- content:
- '*/*':
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/schemas/ErrorRes'
- requestBody:
- content:
- application/json:
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo'
- required: true
- tags:
- - Noc Apply
-
-servers:
-# Added by API Auto Mocking Plugin
- - url: 'https://egov-micro-dev.egovernments.org'
-components:
- schemas:
-
- Noc:
- type: object
- description: NOC application object to capture the details of noc related information, landid and related documents.
- properties:
- id:
- type: string
- description: Unique Identifier(UUID) of the bpa application for internal reference.
- readOnly: true
- minLength: 1
- maxLength: 64
- tenantId:
- type: string
- description: Unique ULB identifier.
- maxLength: 256
- minLength: 2
- nullable: false
- applicationNo:
- type: string
- description: Generate formatted Unique Identifier of the Noc. Keep the format in mdms
- readOnly: true
- minLength: 1
- maxLength: 64
- nocNo:
- type: string
- description: Generate Noc number based on wf status. When to generate Nocno will be depends on wf state so make it configurable at application level
- readOnly: true
- minLength: 1
- maxLength: 64
- applicationType:
- type: string
- description: noc application type.
- enum:
- - PROVISIONAL
- - NEW
- - RENEW
- nullable: false
- nocType:
- maxLength: 64
- minLength: 1
- type: string
- description: |
- Mdms master data to configure types of noc(ex:fire noc, airport authority etc)
- nullable: false
- accountId:
- maxLength: 64
- minLength: 1
- type: string
- description: Initiator User UUID
- source:
- type: string
- description: Who is creating the record in the system(ex:BPA,Property etc)
- minLength: 1
- maxLength: 64
- nullable: false
- sourceRefId:
- type: string
- description: Unique Identifier of integrator(Source system) to link the noc application.
- minLength: 1
- maxLength: 64
- landId:
- maxLength: 64
- minLength: 1
- type: string
- description: Unique Identifier(UUID) of the land for internal reference.
- status:
- type: string
- description: state of the record.
- enum:
- - ACTIVE
- - INACTIVE
-
- applicationStatus:
- type: string
- description: Application status should get populate from wf engine
- maxLength: 64
- minLength: 1
- readOnly: true
- documents:
- description: The documents attached by owner for exemption.
- type: array
- items:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/schemas/Document'
- workflow:
- $ref: '#/components/schemas/Workflow'
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/schemas/AuditDetails'
- additionalDetails:
- type: object
- description: 'The json to capturing the custom fields'
-
-
- Workflow:
- type: object
- description: BPA application object to capture the details of land, land owners, and address of the land.
- properties:
- action:
- type: string
- description: Action on the application in certain
- minLength: 1
- maxLength: 64
- nullable: false
- assignes:
- type: array
- items:
- type: string
- comment:
- type: string
- description: Comment by actor.
- minLength: 1
- maxLength: 64
- documents:
- description: Attach the workflow varification documents.
- type: array
- items:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/PT_APPLY_PAY/docs/common/contracts/v1-1-1.yml#/components/schemas/Document'
- NocType:
- type: object
- description: NOC type is the master data.
- properties:
- code:
- type: string
- description: Action on the application in certain
- minLength: 1
- maxLength: 64
- nullable: false
- isActive:
- type: boolean
- description: If true then new application can not be created for the perticular noc type.
- minLength: 1
- maxLength: 64
- nullable: false
- default: false
-
-
- NocRequest:
- description: A object to bind the metadata contract and main application contract
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo'
- Noc:
- $ref: '#/components/schemas/Noc'
-
- NocResponse:
- description: Contains the ResponseMetadate and the main application contract
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ResponseInfo'
- Noc:
- $ref: '#/components/schemas/Noc'
-
\ No newline at end of file
diff --git a/municipal-services/docs/property-services/pt-service-v2-contract.yml b/municipal-services/docs/property-services/pt-service-v2-contract.yml
deleted file mode 100644
index e2564214660..00000000000
--- a/municipal-services/docs/property-services/pt-service-v2-contract.yml
+++ /dev/null
@@ -1,928 +0,0 @@
-swagger: '2.0'
-info:
- version: 2.0.0
- title: eGov Property Tax Information System.
- description: |
- APIs for Property Tax module. This modules handles assessment of new properties, changes to existing properties (Detail Updates, division of property, etc.), search of required properties and property tax calculation, demand generation, notices to enable ULBs to cmpletely manage the proeprties within their jurisdiction.
- contact:
- name: Ghanshyam Rawat
- email: ghanshyam.rawat@egovernments.org
-schemes:
- - https
-basePath: /properties/v2
-x-module: PT
-x-common-path: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml'
-paths:
- /_search:
- post:
- summary: Get the list of properties defined in the system.
- description: |
- Get the properties list based on the input parameters.
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/requestInfo'
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId'
- - name: name
- in: query
- description: Name of owner whose property is to be searched.
- required: false
- type: string
- format: varchar
- allowEmptyValue: true
- - name: ids
- in: query
- description: List of system generated ids of properties.
- required: false
- type: string
- format: varchar
- - name: propertyDetailids
- in: query
- required: false
- description: List of assessmentNumbers to search.
- type: string
- minLength: 4
- maxLength: 128
- exclusiveMinimum: true
- exclusiveMaximum: false
- - name: oldpropertyids
- in: query
- required: false
- description: List of oldassessmentNumbers to search..
- type: string
- minLength: 4
- maxLength: 128
- exclusiveMinimum: true
- exclusiveMaximum: false
- - name: mobileNumber
- in: query
- description: MobileNumber of owner whose property is to be searched.
- required: false
- type: integer
- format: int64
- - name: accountId
- in: query
- required: false
- description: The uuid of the user who created the property.
- type: string
- minLength: 1
- maxLength: 64
- exclusiveMinimum: true
- exclusiveMaximum: false
- responses:
- '200':
- description: Successful response
- schema:
- $ref: '#/definitions/PropertyResponse'
- '400':
- description: Invalid input.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - Property
- /_create:
- post:
- summary: Create new properties.
- description: API to create new properties.
- parameters:
- - name: property
- in: body
- description: Details for the new property + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/PropertyRequest'
- responses:
- '201':
- description: Property(s) created sucessfully
- schema:
- $ref: '#/definitions/PropertyResponse'
- '400':
- description: Property(s) creation failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - Property
- /_update:
- post:
- summary: Update existing properties.
- description: Updates a given `Property` with newer details.
- parameters:
- - name: property
- in: body
- description: Request header for the property Request.
- required: true
- schema:
- $ref: '#/definitions/PropertyRequest'
- tags:
- - Property
- responses:
- '200':
- description: Update Property(s) successful
- schema:
- $ref: '#/definitions/PropertyResponse'
- '400':
- description: Update Property(s) failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-definitions:
- PropertyType:
- type: object
- properties:
- name:
- type: string
- description: name of the propertytype
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the propertytype
- maxLength: 64
- minLength: 2
- active:
- type: boolean
- description: describes Whether propertyType is Active or not.
- required:
- - code
- Exemption:
- type: object
- properties:
- isEnabled:
- type: boolean
- description: 'if Exemption are applicable, the value will be true.'
- rate:
- type: number
- format: double
- description: Exemption rate in percentage.
- maxLength: 128
- minLength: 2
- maxAmount:
- type: number
- format: double
- description: 'Maximum exemption amount, it is applicable if exemption are applied using exemptionRate.'
- maxLength: 128
- minLength: 2
- flatAmount:
- type: number
- format: double
- description: Flat amount exemption.
- maxLength: 128
- minLength: 2
- fromFY:
- type: string
- description: Exemption are applicable from the defined date.
- maxLength: 128
- minLength: 2
- Rebate:
- type: object
- properties:
- rate:
- type: number
- format: double
- description: Exemption rate in percentage.
- maxLength: 128
- minLength: 2
- maxAmount:
- type: number
- format: double
- description: 'Maximum exemption amount, it is applicable if exemption are applied using exemptionRate.'
- maxLength: 128
- minLength: 2
- flatAmount:
- type: number
- format: double
- description: Flat amount exemption.
- maxLength: 128
- minLength: 2
- fromFY:
- type: string
- description: Exemption are applicable from the defined date.
- maxLength: 128
- minLength: 2
- endDate:
- type: string
- description: 'this is the rebate end date, this will be date and month.'
- Penalty:
- type: object
- properties:
- rate:
- type: number
- format: double
- description: Exemption rate in percentage.
- maxLength: 128
- minLength: 2
- minAmount:
- type: number
- format: double
- description: 'Maximum exemption amount, it is applicable if exemption are applied using exemptionRate.'
- maxLength: 128
- minLength: 2
- flatAmount:
- type: number
- format: double
- description: Flat amount exemption.
- maxLength: 128
- minLength: 2
- fromFY:
- type: string
- description: Exemption are applicable from the defined date.
- maxLength: 128
- minLength: 2
- startDate:
- type: string
- description: 'this is the rebate end date, this will be date and month.'
- PropertySubType:
- type: object
- properties:
- name:
- type: string
- description: name of the PropertySubType
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the propertySubType
- maxLength: 64
- minLength: 2
- propertyType:
- $ref: '#/definitions/PropertyType'
- active:
- type: boolean
- description: provides info on whether the propertySubType is active for usage.
- required:
- - code
- UsageCategoryMajor:
- allOf:
- - $ref: '#/definitions/Exemption'
- type: object
- properties:
- name:
- type: string
- description: name of the UsageCategoryMajor
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the UsageCategoryMajor
- maxLength: 64
- minLength: 2
- active:
- type: boolean
- description: Whether UsageCategoryMajor is Active or not.
- required:
- - code
- UsageCategoryMinor:
- allOf:
- - $ref: '#/definitions/Exemption'
- type: object
- properties:
- name:
- type: string
- description: name of the UsageCategoryMinor
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the Sub UsageCategoryMinor
- maxLength: 64
- minLength: 2
- usageCategoryMajor:
- $ref: '#/definitions/UsageCategoryMajor'
- active:
- type: boolean
- description: 'Whether UsageCategoryMinor is Active or not. If the value is TRUE, then UsageCategoryMinor is active, if the value is FALSE then UsageCategoryMinor is inactive, default value is TRUE'
- required:
- - code
- - usageCategoryMajor
- UsageCategorySubMinor:
- allOf:
- - $ref: '#/definitions/Exemption'
- type: object
- properties:
- name:
- type: string
- description: name of the UsageCategorySubMinor
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the UsageCategorySubMinor
- maxLength: 64
- minLength: 2
- usageCategoryMinor:
- $ref: '#/definitions/UsageCategoryMinor'
- active:
- type: boolean
- description: 'Whether UsageCategorySubMinor is Active or not. If the value is TRUE, then UsageCategorySubMinor is active, if the value is FALSE then UsageCategorySubMinor is inactive, default value is TRUE'
- required:
- - code
- - usageCategoryMinor
- UsageCategoryDetail:
- allOf:
- - $ref: '#/definitions/Exemption'
- type: object
- properties:
- name:
- type: string
- description: name of the UsageCategoryDetail
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code for unique identification
- maxLength: 64
- minLength: 2
- usageCategorySubMinor:
- $ref: '#/definitions/UsageCategorySubMinor'
- active:
- type: boolean
- description: 'Whether UsageCategorySubMinor is Active or not. If the value is TRUE, then UsageCategorySubMinor is active, if the value is FALSE then UsageCategorySubMinor is inactive, default value is TRUE'
- required:
- - code
- - usageCategorySubMinor
- ConstructionType:
- type: object
- properties:
- name:
- type: string
- description: name of the construction type.
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: unique code of the construction type.
- maxLength: 64
- minLength: 2
- active:
- type: boolean
- description: 'Whether UsageCategorySubMinor is Active or not. If the value is TRUE, then UsageCategorySubMinor is active, if the value is FALSE then UsageCategorySubMinor is inactive, default value is TRUE'
- required:
- - code
- ConstructionSubType:
- type: object
- properties:
- name:
- type: string
- description: name of the
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the UsageMaster
- maxLength: 64
- minLength: 2
- constructionTypeCode:
- $ref: '#/definitions/ConstructionType'
- active:
- type: boolean
- description: 'Whether UsageCategorySubMinor is Active or not. If the value is TRUE, then UsageCategorySubMinor is active, if the value is FALSE then UsageCategorySubMinor is inactive, default value is TRUE'
- required:
- - code
- OwnerShipCategory:
- type: object
- properties:
- name:
- type: string
- description: name of the OwnerShipCategory
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: unique code for Ownership category.
- maxLength: 64
- minLength: 2
- active:
- type: boolean
- description: 'Whether UsageCategorySubMinor is Active or not. If the value is TRUE, then UsageCategorySubMinor is active, if the value is FALSE then UsageCategorySubMinor is inactive, default value is TRUE'
- required:
- - code
- SubOwnerShipCategory:
- type: object
- properties:
- name:
- type: string
- description: name of the SubOwnerShipCategory
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the Owner Type.
- maxLength: 64
- minLength: 2
- ownerShipCategoryCode:
- $ref: '#/definitions/OwnerShipCategory'
- active:
- type: boolean
- description: 'Whether UsageCategorySubMinor is Active or not. If the value is TRUE, then UsageCategorySubMinor is active, if the value is FALSE then UsageCategorySubMinor is inactive, default value is TRUE'
- required:
- - code
- - ownerShipCategoryCode
- OwnerType:
- allOf:
- - $ref: '#/definitions/Exemption'
- type: object
- properties:
- name:
- type: string
- description: name of the
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the Owner Type.
- maxLength: 64
- minLength: 2
- active:
- type: boolean
- description: 'Whether UsageCategorySubMinor is Active or not. If the value is TRUE, then UsageCategorySubMinor is active, if the value is FALSE then UsageCategorySubMinor is inactive, default value is TRUE'
- required:
- - code
- Floor:
- type: object
- properties:
- name:
- type: string
- description: Floor Number.
- maxLength: 64
- minLength: 2
- code:
- type: string
- description: Code of Floor Number.
- maxLength: 64
- minLength: 2
- active:
- type: boolean
- description: 'Whether UsageCategorySubMinor is Active or not. If the value is TRUE, then UsageCategorySubMinor is active, if the value is FALSE then UsageCategorySubMinor is inactive, default value is TRUE'
- required:
- - code
- OccupancyType:
- type: object
- properties:
- name:
- type: string
- description: name of the occupancy
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the OccupancyType
- maxLength: 64
- minLength: 2
- active:
- type: boolean
- description: 'Whether OccupancyType is Active or not. If the value is TRUE, then OccupancyType is active, if the value is FALSE then OccupancyType is inactive, default value is TRUE'
- required:
- - code
- BillingSlab:
- type: object
- properties:
- tenantId:
- type: string
- description: Unique ulb identifier
- maxLength: 128
- minLength: 4
- name:
- type: string
- description: name of the slab
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: unique identifier of the billing slab object from business perspective
- maxLength: 64
- minLength: 2
- propertyType:
- type: string
- description: Based on property type charges will change.
- maxLength: 64
- minLength: 2
- usage:
- type: string
- description: Floor Number.
- maxLength: 64
- minLength: 2
- fromFloor:
- type: string
- description: Floor Number.
- maxLength: 64
- minLength: 2
- toFloor:
- type: string
- description: Floor Number.
- maxLength: 64
- minLength: 2
- area:
- type: string
- description: Floor Number.
- maxLength: 64
- minLength: 2
- fromPlotSize:
- type: string
- description: Floor Number.
- maxLength: 64
- minLength: 2
- toPlotSize:
- type: string
- description: Floor Number.
- maxLength: 64
- minLength: 2
- unitRate:
- description: Floor Number.
- type: number
- format: double
- required:
- - tenantId
- - code
- DocumentType:
- type: object
- description: This object holds type of documents to be uploaded during the transaction for each application type.
- properties:
- id:
- type: integer
- format: int64
- description: unique id of the ApplicationType.
- tenantId:
- type: string
- description: tenant id of the Property
- maxLength: 128
- minLength: 4
- name:
- type: string
- description: name of the document
- code:
- type: string
- description: 'code of the document, should be unique to the combination of name, application and tenentid'
- application:
- type: string
- description: Application type.
- enum:
- - CREATE
- - TITLE_TRANSFER
- - BIFURCATION
- - ALTER
- - EDIT
- - AMALGAMATION
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- required:
- - tenantId
- - name
- - code
- - application
- PropertyInfo:
- type: object
- description: This is lightweight property object that can be used as reference by definitions needing property linking. Actual Property Object extends this to include more elaborate attributes of the property.
- properties:
- propertyId:
- type: string
- description: Unique Identifier of the Property.
- readOnly: true
- minLength: 1
- maxLength: 64
- tenantId:
- type: string
- description: tenant id of the Property
- maxLength: 256
- minLength: 2
- acknowldgementNumber:
- type: string
- description: Acknowldgement number given to citizen on submitting the application for creation or modification of the property.
- maxLength: 64
- minLength: 1
- readOnly: true
- oldPropertyId:
- type: string
- description: 'Old upic no of the Property. ULBs have the existing property in their system/manual records with their identification number, they want to continue the old reference number in this case the same identification number will be captured here.'
- maxLength: 256
- minLength: 1
- status:
- type: string
- description: status of the Property
- enum:
- - ACTIVE
- - INACTIVE
- address:
- $ref: '#/definitions/Address'
- required:
- - address
- Property:
- allOf:
- - $ref: '#/definitions/PropertyInfo'
- - type: object
- description: A Object holds the basic data for a property
- properties:
- creationReason:
- type: string
- description: New property comes into system either property is newly constructed or existing property got sub divided. Here the reason for creation will be captured.
- enum:
- - NEWPROPERTY
- - SUBDIVISION
- occupancyDate:
- type: integer
- format: int64
- description: Property is constructed but the tax will be applicable only from the occupation date (time in epoch). System capture that date here.
- propertyDetail:
- type: array
- items:
- $ref: '#/definitions/PropertyDetail'
- required:
- - propertyDetail
- PropertyDetail:
- description: Financial year wise property details will be capture here. For each financial year property details may change.
- type: object
- properties:
- financialYear:
- type: string
- description: Latest tax paid year.
- assessmentNumber:
- type: string
- description: unique assesment number for each financial year.
- maxLength: 64
- readOnly: true
- assessmentDate:
- type: integer
- format: int64
- description: There will be work flow to create a new property in a system. The assessment date is the final approval and UPIC no generation date.
- propertyType:
- type: string
- description: 'Type of a property like Private, Vacant Land, State Government, Central Government etc.'
- maxLength: 64
- propertySubType:
- type: string
- description: Sub Type of a property defined in mdms 'PropertySubType' Masetr.
- maxLength: 64
- usageCategoryMajor:
- type: string
- description: 'This is about the usage of the property like Residential, Non-residential, Mixed(Property witch is gettiong used for Residential, Non-residential purpose)'
- maxLength: 64
- usageCategoryMinor:
- type: string
- description: Sub category of 'UsageCategoryMajor' defined in 'UsageCategoryMinor' master of mdms.
- maxLength: 64
- ownershipCategory:
- type: string
- description: The type of ownership of the property.
- maxLength: 64
- subOwnershipCategory:
- type: string
- description: Sub category of 'OwnershipCategory' defined in 'SubOwnershipCategory' master ofmdms.
- maxLength: 64
- owners:
- description: 'Property owners, these will be citizen users in system.'
- type: array
- items:
- $ref: '#/definitions/OwnerInfo'
- citizenInfo:
- description: 'The ownerInfo of the user to whose account the property is to be assigned in case of assessment done by employee.'
- type: array
- items:
- $ref: '#/definitions/OwnerInfo'
- source:
- type: string
- description: Source of a assessment data. The properties will be created in a system based on the data avaialble in their manual records or during field survey. There can be more from client to client.
- enum:
- - MUNICIPAL_RECORDS
- - FIELD_SURVEY
- noOfFloors:
- type: integer
- format: int64
- description: no of floors in the property
- landArea:
- type: number
- format: float
- description: Land area of the property in sq ft
- buildUpArea:
- type: number
- format: float
- description: Total built up area in sq ft
- adhocExemption:
- type: number
- format: double
- description: 'Exemption applied by the employee.'
- adhocPenalty:
- type: number
- format: double
- description: 'Penalty applied by the employee.'
- adhocExemptionReason:
- type: string
- description: The reason for giving adhocExemption.
- maxLength: 1024
- adhocPenaltyReason:
- type: string
- description: The type of ownership of the property.
- maxLength: 1024
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- units:
- description: 'List of Units in the property. E.g. A property might have 2 units in ground floor and 1 ion first floor. Unit can be Room, floor or any bounded area with a defined usage.'
- type: array
- items:
- $ref: '#/definitions/Unit'
- documents:
- description: 'The documents attached during assessment, modification or any transaction happened on the property.'
- type: array
- items:
- $ref: '#/definitions/Document'
- additionalDetails:
- type: string
- description: 'The json (array of ''#/definitions/Factor'')'
- channel:
- type: string
- description: 'Property can be created from different channels Eg. System (properties created by ULB officials), CFC Counter (From citizen faciliation counters) etc. Here we are defining some known channels, there can be more client to client.'
- enum:
- - SYSTEM
- - CFC_COUNTER
- - CITIZEN
- - DATA_ENTRY
- - MIGRATION
- institution:
- description: 'The details of institution if the ownershipCategory is institutional'
- type: array
- items:
- $ref: '#/definitions/Institution'
- calculation:
- description: 'The calculation details of the property'
- type: object
- items:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/rainmaker/property-tax/property-calculation-service.yml#/definitions/Calculation'
- Institution:
- type: object
- properties:
- id:
- type: string
- maxLength: 64
- description: Unique Identifier of the Property(UUID).
- tenantId:
- type: string
- description: tenant id of the Property
- maxLength: 256
- name:
- type: string
- description: Name of the Instituion
- maxLength: 64
- type:
- type: string
- description: Institution type.
- maxLength: 64
- designation:
- type: string
- maxLength: 64
- description: Designation of the person doing the assessment
- OwnerInfo:
- allOf:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-user/contracts/v1-0-0.yml#/definitions/User'
- - type: object
- properties:
- isPrimaryOwner:
- type: boolean
- description: The owner is primary or not
- ownerShipPercentage:
- type: number
- format: double
- description: Ownership percentage.
- ownerType:
- type: string
- description: 'Type of owner, based on this option Exemptions will be applied. This is master data defined in mdms.'
- maxLength: 256
- institutionId:
- type: string
- description: 'The id of the institution if the owner is the authorized person for one'
- maxLength: 64
- documents:
- description: The documents attached by owner for exemption.
- type: array
- items:
- $ref: '#/definitions/Document'
- relationship:
- type: string
- description: 'The relationship of gaurdian.'
- enum:
- - FATHER
- - HUSBAND
- Address:
- allOf:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-0.yml#/definitions/Address'
- - type: object
- description: Address of the property.
- properties:
- buildingName:
- type: string
- description: Name of the building
- maxLength: 64
- minLength: 2
- street:
- type: string
- description: Street Name
- maxLength: 64
- minLength: 2
- locality:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-location/contracts/v11-0-0.yml#/definitions/Boundary'
- Document:
- type: object
- description: This object holds list of documents attached during the transaciton for a property
- properties:
- id:
- type: string
- maxLength: 64
- description: system id of the Document.
- documentType:
- type: string
- description: 'unique document type code, should be validated with document type master'
- fileStore:
- type: string
- description: File store reference key.
- documentUid:
- type: string
- maxLength: 64
- description: The unique id(Pancard Number,Adhar etc.) of the given Document.
-
- Unit:
- type: object
- properties:
- id:
- type: string
- description: Unique Identifier of the Property(UUID).
- tenantId:
- type: string
- description: tenant id of the Property
- maxLength: 256
- minLength: 2
- floorNo:
- type: string
- description: floor no for the floor
- maxLength: 64
- minLength: 1
- unitType:
- type: string
- description: Unit type.
- maxLength: 64
- minLength: 1
- unitArea:
- type: number
- format: float
- description: Area of the defined Unit.
- usageCategoryMajor:
- type: string
- description: 'This is about the usage of the property like Residential, Non-residential, Mixed(Property witch is gettiong used for Residential, Non-residential purpose)'
- maxLength: 64
- minLength: 1
- usageCategoryMinor:
- type: string
- description: Sub category of 'UsageCategoryMajor' defined in 'UsageCategoryMinor' master of mdms.
- maxLength: 64
- minLength: 1
- usageCategorySubMinor:
- type: string
- description: Sub category of 'usageCategoryMinor' defined in 'UsageCategorySubMinor' master of mdms.
- maxLength: 64
- minLength: 1
- usageCategoryDetail:
- type: string
- description: Sub category of 'usageCategorySubMinor' defined in 'usageCategoryDetail' master of mdms.
- maxLength: 64
- minLength: 1
- occupancyType:
- type: string
- description: end date for the unit usage.
- enum:
- - Owner
- - Tenant
- maxLength: 64
- minLength: 1
- occupancyDate:
- type: number
- format: int64
- description: Date on which unit is occupied.
- constructionType:
- type: string
- description: Construction type is defined in MDMS ConstructionTypeMaster.
- maxLength: 64
- minLength: 1
- constructionSubType:
- type: string
- description: 'Construction Sub type is defined in MDMS ''ConstructionSubType'' master, this is sub category of constructionType.'
- maxLength: 64
- minLength: 1
- arv:
- type: number
- format: double
- description: 'Annual rental value(arv), if occupancy type is Tenant.'
- PropertyRequest:
- description: Contract class to receive request. Array of Property items are used in case of create . Where as single Property item is used for update
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
- Properties:
- description: Used for search result and create only
- type: array
- minimum: 1
- maximum: 100
- items:
- $ref: '#/definitions/Property'
- PropertyResponse:
- description: Contract class to send response. Array of Property items are used in case of search results or response for create. Where as single Property item is used for update
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- Properties:
- description: Used for search result and create only
- type: array
- items:
- $ref: '#/definitions/Property'
diff --git a/municipal-services/docs/rainmaker-pgr-contract.yml b/municipal-services/docs/rainmaker-pgr-contract.yml
deleted file mode 100644
index 72934dde2ef..00000000000
--- a/municipal-services/docs/rainmaker-pgr-contract.yml
+++ /dev/null
@@ -1,394 +0,0 @@
-swagger: '2.0'
-info:
- version: 1.0.0
- title: Public Grievance Redressal
- description: |
-
- ### API specs for PGR ###
- Application to Raise Grivances and track the progress.
- . It allows any citizen registered in the system to raise a complaint (based on the Service definition provided in the master data, Please Refer MDMS service to Service Definition master) for any ulb belonging to the state.
- . Notifications will be provided on progress of the complaint in evevry step.
- . Feedback can be provided by the citizen once the complint is resolved.
- . If not satisfied the citizen can reopen the complaint.
-
- contact:
- name: info
-host: egov-micro-dev.egovernments.org
-schemes:
- - https
-basePath: /rainmaker-pgr/v2
-paths:
- /requests/_search:
- post:
- summary: Get service requests
- description: |
- Gets the list of service requests for a particular ULB based on search criteria.
- - name: group
- in: query
- description: Attribute of service config, it indicate the "Department" for which service type is defined.
- required: false
- type: string
- format: varchar
- - name: serviceCode
- in: query
- description: Allows search for service type - comma separated list.
- type: array
- items:
- type: string
- format: varchar
- - name: startDate
- in: query
- description: Earliest epoch time to include in search - request created time |
- required: false
- type: integer
- format: int64
- - name: endDate
- in: query
- description: Latest epoch time to include in search - request created time |
- If search is on start date then end date is mandatory, if end date is null then server will take current date as end date.
- required: false
- type: integer
- format: int64
- - name: lastUpdatedSince
- in: query
- description: searches all requests that have been modified/created since last modified epoch time as provided here
- required: false
- type: integer
- format: int64
- responses:
- '200':
- description: Successful response sorted by reverse chrnological order of creation
- schema:
- $ref: '#/definitions/ServiceResponse'
- '400':
- description: Invalid input.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-0.yml#/definitions/ErrorRes'
- tags:
- - Service Request
- /requests/_create:
- post:
- summary: Create service requests
- description: Create new service requests - supports batch - please note that in case of errors entire batch is rejected
- parameters:
- - name: serviceRequest
- in: body
- description: RequestInfo + ServiceRequest array for updation
- required: true
- schema:
- $ref: '#/definitions/ServiceRequest'
- tags:
- - Service Request
- responses:
- '200':
- description: Service Request Created
- schema:
- $ref: '#/definitions/ServiceResponse'
- '400':
- description: Response Info + List of errors
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-0.yml#/definitions/ErrorRes'
- /requests/_update:
- post:
- summary: Update service requests
- description: Updates service request - supports batch - please note that in case of errors entire batch is rejected
- parameters:
- - name: serviceRequest
- in: body
- description: RequestInfo + ServiceRequest array for updation
- required: true
- schema:
- $ref: '#/definitions/ServiceRequest'
- tags:
- - Service Request
- responses:
- '200':
- description: Service Request updated
- schema:
- $ref: '#/definitions/ServiceResponse'
- '400':
- description: Response Info + List of errors
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-0.yml#/definitions/ErrorRes'
-definitions:
- ServiceDef:
- type: object
- description: |
-
- This will be the MDMS data.
-
- Defines the structure of a service provided by the administration. This is based on Open311 standard, but extends it in follwoing important ways -
-
- 1. metadata is changed from boolean to strign and represents a valid swgger 2.0 definition url of the metadata definition. If this is null then it is assumed taht service does not have any metadata, else the metadata is defined in the OpenAPI definition. This allows for a well structured powerful metadata definition.
-
- 2. Due to this ServiceRequest object has been enhanced to include metadata values (aka attribute value in Open311) as an JSON object.
- properties:
- tenantId:
- type: string
- description: The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required
- minLength: 2
- maxLength: 50
- serviceCode:
- type: string
- description: The unique identifier for Service
- minLength: 2
- maxLength: 64
- serviceName:
- type: string
- description: Service name.
- minLength: 2
- maxLength: 100
- description:
- type: string
- description: Services description.
- minLength: 2
- maxLength: 500
- metadata:
- type: string
- description: Schema url to valid OpenAPI swagger difinition. As described in the definition above these are the additional service specific attributes defined as a swagger definition
- type:
- type: string
- description: realtime (Currently we only support real time srevices)
- enum:
- - realtime
- - batch
- - blackbox
- keywords:
- type: string
- description: 'tags for this service, we can provide multiple keywords as dot(.) seprated.'
- group:
- type: string
- description: This field we will use to capture department.
- slaHours:
- type: number
- description: Service Level Agreement in hours for Service.
- required:
- - tenantId
- - serviceName
- - serviceCode
- Service:
- type: object
- description: |
- Instance of Service request raised for a particular service. As per extension propsed in the Service definition "attributes" carry the input values requried by metadata definition in the structure as described by the corresponding schema.
-
- * Any one of 'address' or '(lat and lang)' or 'addressid' is mandatory
- properties:
- citizen:
- $ref: '#/definitions/Citizen'
- tenantId:
- type: string
- description: The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required
- minLength: 2
- maxLength: 50
- serviceCode:
- type: string
- description: Code of the service being requested (as per the service definition)
- minLength: 2
- maxLength: 64
- serviceRequestId:
- type: string
- readOnly: true
- description: The server generated unique ID of the service request.
- minLength: 2
- maxLength: 64
- description:
- type: string
- description: A full description of the request provided by the user
- minLength: 2
- maxLength: 250
- lat:
- type: integer
- description: Latitude of the location.
- long:
- type: integer
- description: Longitude of location.
- address:
- type: string
- description: Human readable address or description of location.
- minLength: 2
- maxLength: 256
- addressId:
- type: string
- description: The internal address ID used by a tenant master address repository or other addressing system - for eGov it can be boundary id in the boundary service
- email:
- type: string
- description: The email address of the person submitting the request.
- minLength: 5
- maxLength: 50
- deviceId:
- type: string
- description: The unique device ID of the device submitting the request.
- accountId:
- type: string
- description: userid of the user requesting the srervice - in our case it may be same as phone as we are using mobile number as the userid
- minLength: 2
- maxLength: 64
- firstName:
- type: string
- description: The given name of the person submitting the request.
- minLength: 2
- maxLength: 32
- lastName:
- type: string
- description: The family name of the person submitting the request.
- minLength: 2
- maxLength: 32
- phone:
- type: string
- description: The phone number of the person submitting the request.
- maxLength: 12
- attributes:
- type: object
- description: This is the json object that will carry the actual input (whereever the metadata requries input). Structure should be same as the schema definition provided in the metadata of the service (schema compliance check to be performed at client/server)
- status:
- type: string
- description: The current status of the service request.
- enum:
- - New
- - InProgress
- - Closed
- - Cancelled
- - Rejected
- source:
- type: string
- description: 'source of the complaint - Text, Mobile app, Phone, CSC, WhatsApp'
- enum:
- - sms
- - email
- - ivr
- - mobileapp
- - whatsapp
- - csc
- - web
- expectedTime:
- type: integer
- format: int64
- description: epoch of the time object is last modified.
- x-format: dd/mm/yyyy HH-MM-SS
- feedback:
- type: string
- description: FeedBack of the service by citizen.
- minLength: 2
- maxLength: 64
- rating:
- type: string
- description: Rating about service from 1 to 5.
- landmark:
- type: string
- description: land mark close to the adress
- minLength: 2
- maxLength: 50
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-0.yml#/definitions/AuditDetails'
- required:
- - tenantId
- - serviceCode
- - phone
- ActionInfo:
- type: object
- description: Capture the details of action on service request.
- properties:
- tenantId:
- type: string
- description: The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required
- minLength: 2
- maxLength: 50
- by:
- type: string
- description: 'who made the Action Citizen/Employee, it''s a combination of userid and role delimited by colon (ex- userid:citizen).'
- readOnly: true
- isInternal:
- type: string
- description: If employee is making an action with isInteral as true then server will not return that action info to citizen search result.
- when:
- type: integer
- format: int64
- description: epoch time of when the action made.
- x-format: dd/mm/yyyy HH-MM-SS
- readOnly: true
- businessKey:
- type: string
- readOnly: true
- description: The server generated unique ID of the service request.
- minLength: 2
- maxLength: 64
- action:
- type: string
- description: 'Action will be Reject, Approve, Reassign, Forward.'
- status:
- type: string
- readOnly: true
- description: Each action will have a mapping with status at server side.
- assignee:
- type: string
- description: user id of the employee to whom request id need to be assigne.
- media:
- type: array
- maximum: 10
- items:
- type: string
- comment:
- type: string
- description: Capture the comments made by Employee/Citizen.
- ServiceRequest:
- type: object
- description: Request object to fetch the report data
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-0.yml#/definitions/RequestInfo'
- services:
- type: array
- maximum: 100
- items:
- $ref: '#/definitions/Service'
- actionInfo:
- type: array
- maximum: 100
- items:
- $ref: '#/definitions/ActionInfo'
- required:
- - RequestInfo
- - services
- ServiceResponse:
- type: object
- description: Response to the service request
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-0.yml#/definitions/ResponseInfo'
- services:
- type: array
- maximum: 100
- items:
- $ref: '#/definitions/Service'
- actionHistory:
- type: array
- maximum: 100
- items:
- $ref: '#/definitions/ActionHistory'
- required:
- - ResponseInfo
- - services
- ActionHistory:
- type: object
- description: Each Object of action History will point to the Service.
- properties:
- actions:
- type: array
- maximum: 100
- items:
- $ref: '#/definitions/ActionInfo'
- Citizen:
- type: object
- description: Capture the details of Citizen on service request when csr creates the complaint.
- properties:
- tenantId:
- type: string
- description: The unique identifier for Service - this is equivalent to jurisdiction_id in Open311. As the platform intends to be multi tenanted - this is always required
- minLength: 2
- maxLength: 50
- name:
- type: string
- description: name of the citizen on behalf of whom the complaint is being created
- mobileNumber:
- type: string
- description: mobile number of the citizen.
\ No newline at end of file
diff --git a/municipal-services/docs/tl-calculator.yml b/municipal-services/docs/tl-calculator.yml
deleted file mode 100644
index 35e1a11f032..00000000000
--- a/municipal-services/docs/tl-calculator.yml
+++ /dev/null
@@ -1,309 +0,0 @@
-swagger: '2.0'
-info:
- version: 2.0.0
- title: Trade License Calculation APIs
- description: |
- APIs available for Trade License
- - Calculate Trade License.
- contact:
- name: eGovernments Foundation
- email: contacts@egovernments.org
-schemes:
- - https
-basePath: /tl-calculator/
-paths:
- /v1/_calculate:
- post:
- summary: Calculates Trade License and generates the respective demands in the system.
- description: Calculate Trade License Fee based on criteria.
- tags:
- - Trade License Calculation
- parameters:
- - name: calculationReq
- in: body
- description: required parameters have to be populated
- required: true
- schema:
- $ref: '#/definitions/CalculationReq'
- responses:
- '200':
- description: Success response with calculated tax amount.
- schema:
- $ref: '#/definitions/CalculationRes'
- '400':
- description: Error response in case of failures.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes'
- /v1/_getbill:
- post:
- summary: Updates demand with time based penalty if applicable and Generates bill for the given criteria.
- description: Generates bill for payment.
- tags:
- - Trade License Bill
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/requestInfo'
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/tenantId'
- - name: applicationNumber
- in: query
- description: Unique Trade application number.
- required: true
- type: string
- responses:
- '200':
- description: Success response calculated tax amount.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/billingservice/contracts/v1-0-0.yml#/definitions/Bill'
- '400':
- description: Error response in case of failures.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes'
- /billingslab/_search:
- post:
- summary: Get the list of properties defined in the system for trade license calculation.
- description: |
- Get the properties list based on the input parameters.
- tags:
- - BillingSlab
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/requestInfo'
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/parameters/tenantId'
- - name: active
- in: query
- description: True will be set in cases where only active properties are needed and False will be set when inactive properties are needed and no value will be set when all properties are needed.
- required: false
- type: boolean
- format: varchar
- allowEmptyValue: true
- - name: propertyId
- in: query
- description: Primary key of Property object.
- required: false
- type: string
- format: varchar
- - name: assessmentNumber
- in: query
- required: false
- description: The unique reference number for a property.
- type: string
- minLength: 4
- maxLength: 128
- exclusiveMinimum: true
- exclusiveMaximum: false
- - name: oldAssessmentNumber
- in: query
- required: false
- description: The unique old assessment no for a Property.
- type: string
- minLength: 4
- maxLength: 128
- exclusiveMinimum: true
- exclusiveMaximum: false
- - name: locality
- in: query
- description: Locality boundary where the property is located.
- required: false
- type: integer
- format: int64
- responses:
- '200':
- description: Successful response
- schema:
- $ref: '#/definitions/BillingSlabRes'
- '400':
- description: Invalid input.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /billingslab/_create:
- post:
- summary: Create new billing slabs for trade license calculation.
- description: API to billing slabs for trade license calculation.
- tags:
- - BillingSlab
- parameters:
- - name: billingSlab
- in: body
- description: Details for the new slab + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/BillingSlabReq'
- responses:
- '201':
- description: Billing Slab(s) created sucessfully
- schema:
- $ref: '#/definitions/BillingSlabRes'
- '400':
- description: Billing Slab(s) creation failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- /billingslab/_update:
- post:
- summary: Update existing billing slabs.
- description: Updates a given billing slab with new properties
- parameters:
- - name: billingSlab
- in: body
- description: Request header for the update of billing slab.
- required: true
- schema:
- $ref: '#/definitions/BillingSlab'
- tags:
- - BillingSlab
- responses:
- '200':
- description: Update Billing Slab(s) successful
- schema:
- $ref: '#/definitions/BillingSlab'
- '400':
- description: Update Billing Slab(s) failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
-definitions:
- CalulationCriteria:
- description: Either tradelicense object or the application number is mandatory apart from tenantid.
- type: object
- properties:
- tradelicense:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/rainmaker/trade-license/tl-service.yml#/definitions/TradeLicense'
- applicationNumber:
- type: string
- minLength: 2
- maxLength: 64
- tenantId:
- type: string
- minLength: 2
- maxLength: 256
- required:
- - tenantId
- Calculation:
- type: object
- properties:
- applicationNumber:
- type: string
- description: TradeLicense application number.
- totalAmount:
- type: number
- format: double
- description: Total payable tax amount.
- penalty:
- type: number
- format: double
- description: Total Penality if applicable.
- exemption:
- type: number
- format: double
- description: Total Exemption amount if applicable.
- rebate:
- type: number
- format: double
- description: Total Rebate amount if applicable.
- tenantId:
- type: string
- minLength: 2
- maxLength: 256
- BillingSlab:
- type: object
- properties:
- tenantId:
- type: string
- description: Unique ulb identifier
- maxLength: 128
- minLength: 4
- id:
- type: string
- description: unique identifier of the billing slab uuid
- maxLength: 64
- minLength: 2
- licenseType:
- type: string
- description: LicenseType, is unique enum value for a license
- enum:
- - TEMPORARY
- - PERMANENT
- structureType:
- type: string
- description: StructureType and Structure subtype, this mdms data.
- maxLength: 64
- minLength: 2
- tradeType:
- type: string
- description: value from Trade type master of mdms .
- maxLength: 64
- minLength: 2
- accessoryCategory:
- type: string
- description: Accessory Category is a master from mdms .
- maxLength: 64
- minLength: 2
- type:
- type: string
- description: Type will define the rate value is flat amount or rate.
- enum:
- - RATE
- - FLAT
- rate:
- type: string
- description: Rate of the trade license, this can be the rate of flat amount based on type.
- maxLength: 64
- minLength: 2
- uom:
- type: string
- description: unit of measurement of trade type.
- maxLength: 32
- minLength: 2
- from:
- type: string
- description: uom value lower bound.
- maxLength: 64
- minLength: 2
- to:
- type: string
- description: uom value upper bound.
- maxLength: 64
- minLength: 2
- required:
- - tenantId
- CalculationReq:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo'
- CalulationCriteria:
- type: array
- maximum: 100
- items:
- $ref: '#/definitions/CalulationCriteria'
- required:
- - RequestInfo
- - calulationCriteria
- CalculationRes:
- type: object
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- Calculation:
- type: array
- items:
- $ref: '#/definitions/Calculation'
- BillingSlabReq:
- type: object
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo'
- BillingSlab:
- type: array
- maximum: 100
- items:
- $ref: '#/definitions/BillingSlab'
- required:
- - RequestInfo
- - billingSlab
- BillingSlabRes:
- type: object
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ResponseInfo'
- BillingSlab:
- type: array
- items:
- $ref: '#/definitions/BillingSlab'
-
\ No newline at end of file
diff --git a/municipal-services/docs/tl-service.yml b/municipal-services/docs/tl-service.yml
deleted file mode 100644
index ee4bdef9a31..00000000000
--- a/municipal-services/docs/tl-service.yml
+++ /dev/null
@@ -1,570 +0,0 @@
-swagger: '2.0'
-info:
- version: 1.0.0
- title: eGov Trade License System.
- description: |
- APIs for Trade License module. This modules handles Below functionality.
- 1. Apply for new trade license.(Generate application number)
- 2. Payment for Trade License
- 3. Search existing trade application.
- 4. Search existing trade license
- contact:
- name: eGovernments Foundation
- email: contacts@egovernments.org
-schemes:
- - https
-basePath: /tl-service
-x-api-id: org.egov.tl.services
-x-common-path: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml'
-paths:
- /v1/_search:
- post:
- summary: Get the list of Trade License defined in the system.
- description:
- 1. Search and get Trade License(s) based on defined search criteria.
-
- 2. In case multiple parameters are passed Trade License(s) will be searched as an AND combination of all the parameters.
- parameters:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/requestInfo'
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/parameters/tenantId'
- - $ref: '#/parameters/pageNumber'
- - name: status
- in: query
- description: Search based on status.
- type: string
- allowEmptyValue: true
- - name: ids
- type: array
- items:
- type: integer
- format: int64
- in: query
- maxItems: 50
- description: unique identifier of trade licence
- - name: applicationNumber
- in: query
- description: Unique application number for a trade license application.
- type: string
- minLength: 2
- maxLength: 64
- - name: licenseNumber
- in: query
- description: The unique license number for a Trade license.
- type: string
- minLength: 2
- maxLength: 64
- - name: oldLicenseNumber
- in: query
- description: The unique Old license number for a Trade license.
- type: string
- minLength: 2
- maxLength: 64
- - name: mobileNumber
- in: query
- description: The mobile number of a Trade owner.
- type: string
- pattern: '[0-9]'
- responses:
- '200':
- description: Trade License(s) Retrived Successfully
- schema:
- $ref: '#/definitions/TradeLicenseResponse'
- '400':
- description: Invalid input.
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/ErrorRes'
- tags:
- - TradeLicense
- /v1/_create:
- post:
- summary: Create new Trade Licenses.
- description: |
- To create new Trade License in the system. API supports bulk creation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To create one Trade License, please pass array with one Trade License object.
-
-
- Following Conditions are applied -
- 1. PropertyId and OldPropertyId is not mandatory, If entered then validate. Invalid number fails trade license creation
- 2. supportDocuments for a given Trade License will created. In case of not attaching the Mandatory Supported Documents creation of New Trade License Fails.
- 3. LicenseNumber will be autogenerated on final approval for new License.
- 4. ApplicationNumber will be autogenerated for new Trade License
- parameters:
- - name: TradeLicenseRequest
- in: body
- description: Details for the new TradeLicense(s) + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/TradeLicenseRequest'
- responses:
- '201':
- description: ReponseInfo with Trade License(s) created successfully
- schema:
- $ref: '#/definitions/TradeLicenseResponse'
- '400':
- description: TradeLicense(s) creation failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - TradeLicense
- /v1/_update:
- post:
- summary: update existing licenses.
- description: |
- To update existing Trade License in the system. API supports bulk updation with max limit as defined in the Trade License Request. Please note that either whole batch succeeds or fails, there's no partial batch success. To update one Trade License, please pass array with one Trade License object.
-
- Following Conditions are applied -
- 1. Before payment Employee or Citizen can update any details of trade license
- 2. After payment Citizen or Employee can't change any details of TL.
-
- parameters:
- - name: TradeLicenseRequest
- in: body
- description: Details for the new TradeLicense(s) + RequestInfo meta data.
- required: true
- schema:
- $ref: '#/definitions/TradeLicenseRequest'
- responses:
- '201':
- description: ReponseInfo with Trade License(s) updated sudcessfully
- schema:
- $ref: '#/definitions/TradeLicenseResponse'
- '400':
- description: TradeLicense(s) updation failed
- schema:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ErrorRes'
- tags:
- - TradeLicense
-definitions:
-
-
-
-#################### Master Data ##########################
-
- TradeType:
- type: object
- description: 1. This is the detail classification, based on which fees are defined. In Goods, these are the products dealt with and in Service, these are the names of different services. .
- 2. License Transactions are enabled at TradeCategoryDetail.
- License API only allow transactions for active trade category, TradeSubCategory and TradeCategoryDetail.
- 3. Consumer of TradeCategoryDetail api should not enable transactions for 'active=false' category,
- 4. This is the master data for trade license, it's defined under mdms service.
- 5. To get data from mdms 'moduleName=TradeLicense, masterName=TradeCategoryDetail and tradeSubCategory={code of trade sub category master}'.
- 6. Multiple TradeCategoryDetail can be defined under single TradeSubCategory
- 7. Cobination of tradeSubCategory and code is unique.
- 8. License Fees is defined at tradeCategoryDetail level.
- 9. Each tradeCategoryDetail is map to a single TradeCategoryUOM
- properties:
- name:
- type: string
- description: name of the UsageCategorySubMinor
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: code of the UsageCategorySubMinor
- maxLength: 64
- minLength: 2
- uom:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/Uom'
- active:
- type: boolean
- description: if the value is true then only any transaction is applicable for perticular TradeCategoryDetail.
- required:
- - code
- - uom
-##############################################
- AccessoryCategory:
- type: object
- description: 1. This is the master data for accessory.
- 2. We can add accessories only for active AccessoryCategory .
- 4. This is the master data for trade license, it's defined under mdms service.
- 5. To get data from mdms 'moduleName=TradeLicense, masterName=AccessoryCategory and tradeSubCategory={code of trade sub category master}'.
- 6. Multiple TradeCategoryDetail can be defined under single TradeSubCategory
- 7. Cobination of tradeSubCategory and code is unique.
- 8. License Fees is defined at tradeCategoryDetail level.
- 9. Each tradeCategoryDetail is map to a single TradeCategoryUOM
- properties:
- name:
- type: string
- description: Unit of measurement name.
- maxLength: 128
- minLength: 2
- code:
- type: string
- description: Unique code of uom.
- maxLength: 64
- minLength: 2
- uom:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/Uom'
- active:
- type: boolean
- description: if the value is true then only any transaction is applicable.
- required:
- - code
-
-##############################################
-
- OwnerInfo:
- allOf:
- - $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/egov-user/contracts/v1-0-0.yml#/definitions/User'
- - type: object
- properties:
- isPrimaryOwner:
- type: boolean
- description: The owner is primary or not
- ownerShipPercentage:
- type: number
- format: double
- description: Ownership percentage.
- ownerType:
- type: string
- description: 'Type of owner, based on this option Exemptions will be applied. This is master data defined in mdms.'
- maxLength: 256
- minLength: 4
- relationship:
- type: string
- description: Relationship with owner.
- enum:
- - FATHER
- - HUSBAND
- documents:
- description: Document of the owner.
- items:
- $ref: '#/definitions/Document'
-
-
-##############################################
-
- Document:
- type: object
- description: A Object holds the basic data for a Trade License
- properties:
- tenantId:
- type: string
- description: Unique Identifier of ULB
- maxLength: 128
- minLength: 2
- documentType:
- type: string
- minLength: 2
- maxLength: 64
- description: 1.Unique document type code from common master.
- 2. This is defined under mdms common master.
- 3. Object defination is defined under 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/DocumentType'
- fileStoreId:
- type: string
- minLength: 2
- maxLength: 64
- description: Unique file store id of uploaded document.
- documentUid:
- type: string
- minLength: 2
- maxLength: 64
- description: document number(eg.Pan number, aadhar number).
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- required:
- - tenantId
- - documentType
- - fileStoreId
-
-
-##############################################
-
- TradeLicense:
- type: object
- description: A Object holds the basic data for a Trade License
- properties:
- id:
- type: string
- minLength: 2
- maxLength: 64
- description: Unique Identifier of the Trade License (UUID)
- readOnly: true
- tenantId:
- type: string
- description: Unique Identifier of ULB
- maxLength: 128
- minLength: 2
- name:
- type: string
- description: Name of the trade.
- maxLength: 256
- minLength: 2
- licenseType:
- type: string
- description: Unique Identifier of the Trade License (UUID)
- enum:
- - TEMPORARY
- - PERMANENT
- licenseNumber:
- type: string
- description: Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
- maxLength: 64
- minLength: 2
- readOnly: true
- oldLicenseNumber:
- type: string
- description: Unique Old License Number of the Trade. This is unique in system for a tenant. This is mandatory for legacy license(DataEntry).
- maxLength: 64
- minLength: 2
- propertyId:
- type: string
- description: Unique property id.
- maxLength: 64
- minLength: 2
- oldPropertyId:
- type: string
- description: Unique Old property id.
- maxLength: 64
- minLength: 2
- applicationDate:
- type: integer
- format: int64
- description: date on which applicaiton has been generated for new Trade License.
- readOnly: true
- commencementDate:
- type: integer
- format: int64
- description: Commencement Date of the trade as epoch
- issuedDate:
- type: integer
- format: int64
- description: 1. License issued Date of the trade as epoch.
- 2. Application approval date.
- readOnly: true
- financialYear:
- type: string
- description: TradeLicense applicable for financial year.
- maxLength: 64
- minLength: 2
- validFrom:
- type: integer
- format: int64
- description: Date from when license is valid as epoch
- validTo:
- type: integer
- format: int64
- description: Expiry Date of the Trade License as epoch
- action:
- type: string
- description: 1. Perform action to change the state of the trade license.
- 2. INITIATE, if application is getting submitted without required document.
- 3. APPLY, if application is getting submitted with application documents, in that case api will validate all the required application document.
- 4. APPROVE action is only applicable for specific role, that role has to be configurable at service level.
- Employee can approve a application only if application is in APPLIED state and Licesance fees is paid.
- enum:
- - INITIATE
- - APPLY
- - APPROVE
- - REJECT
- - CANCEL
- status:
- type: string
- description: Unique identifier (code) of the Trade license Status
- enum:
- - INITIATED
- - APPLIED
- - APPROVED
- - REJECTED
- - CANCELED
- tradeLicenseDetail:
- $ref: '#/definitions/TradeLicenseDetail'
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- required:
- - tenantId
- - licenseType
- - commencementDate
- - tradeLicenseDetail
-
- TradeLicenseDetail:
- type: object
- description: A Object holds the basic data for a Trade License
- properties:
- surveyNo:
- type: string
- description: Survey number.
- subOwnerShipCategory:
- type: string
- description: Unique code of SubOwnerShipCategory from SubOwnerShipCategory master of MDMS.
- structureType:
- type: string
- description: StructureType and Structure subtype, this mdms data.
- maxLength: 64
- minLength: 2
- operationalArea:
- type: number
- format: double
- description: This is always in sq yard.
- maxLength: 128
- minLength: 2
- owners:
- description: 'Trade owners, these will be citizen users in system.'
- type: array
- items:
- $ref: '#/definitions/OwnerInfo'
- channel:
- type: string
- description: 'License can be created from different channels'
- maxLength: 64
- minLength: 2
- enum:
- - COUNTER
- - CITIZEN
- - DATAENTRY
- address:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/Address'
- tradeUnits:
- description: Send list of trades here.
- type: array
- items:
- $ref: '#/definitions/TradeUnit'
- accessories:
- description: Send list of accessories here.
- type: array
- items:
- $ref: '#/definitions/Accessory'
- applicationDocuments:
- description: 1. List of all the required documents.
- 2. Application can be submitted without required document
- 3. Once all the document submitted then only application submition process will be completed.
- 4. Mandatry application documents for a trade type are defined under ApplicationDocument master which is defined under MDMS.
- type: array
- items:
- $ref: '#/definitions/Document'
- verificationDocuments:
- description: 1. Verification Documents will uploaded at the time of approval.
- 2. Mandatry verification documents for a trade type are defined under VerificationDocument master which is defined under MDMS.
- type: array
- items:
- $ref: '#/definitions/Document'
- additionalDetail:
- type: string
- description: 'Json object to store additional details about license'
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- required:
- - tenantId
- - subOwnerShipCategory
- - owners
- - channel
- - tradeUnits
-
- TradeUnit:
- type: object
- description: A Object holds the basic data for a Trade License
- properties:
- tenantId:
- type: string
- description: Unique Identifier of ULB
- maxLength: 128
- minLength: 2
- tradeType:
- type: string
- minLength: 2
- maxLength: 64
- description: Unique Identifier of the Trade License (UUID)
- uom:
- type: string
- description: Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
- maxLength: 32
- minLength: 2
- uomValue:
- type: string
- description: Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
- maxLength: 32
- minLength: 2
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- required:
- - tenantId
-
- Accessory:
- type: object
- description: A Object holds the basic data for a Trade License
- properties:
- tenantId:
- type: string
- description: Unique Identifier of ULB
- maxLength: 128
- minLength: 2
- accessoryCategory:
- type: string
- minLength: 2
- maxLength: 64
- description: Unique Identifier of the Trade License (UUID)
- uom:
- type: string
- description: Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
- maxLength: 32
- minLength: 2
- uomValue:
- type: string
- description: Unique License Number of the Trade. This is unique in system for a tenant. This is mandatory but always be generated on the final approval. In Case of Legacy License User will enter the Old License Number.
- maxLength: 32
- minLength: 2
- auditDetails:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/AuditDetails'
- required:
- - tenantId
-
- TradeLicenseRequest:
- description: 'Contract class to receive request. Array of TradeLicense items are used in case of create, whereas single TradeLicense item is used for update'
- properties:
- RequestInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-1-1.yml#/definitions/RequestInfo'
- Licenses:
- description: Used for search result and create only
- type: array
- minimum: 1
- maximum: 100
- items:
- $ref: '#/definitions/TradeLicense'
-
- TradeLicenseResponse:
- description: 'Contract class to send response. Array of TradeLicense items are used in case of search results or response for create, whereas single TradeLicense item is used for update'
- properties:
- ResponseInfo:
- $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/ResponseInfo'
- Licenses:
- description: Used for search result and create only
- type: array
- maximum: 500
- items:
- $ref: '#/definitions/TradeLicense'
-parameters:
- pageSize:
- name: pageSize
- in: query
- description: Number of records returned.
- type: integer
- minimum: 0
- exclusiveMinimum: true
- maximum: 100
- exclusiveMaximum: false
- multipleOf: 10
- default: 20
- pageNumber:
- name: pageNumber
- in: query
- description: Page number
- type: integer
- default: 1
- sortProperty:
- name: sort
- in: query
- description: TradeLicense results will be sorted by licenseNumber ascending by default if this parameter is not provided.
- type: array
- uniqueItems: true
- minItems: 1
- maxItems: 3
- collectionFormat: pipes
- items:
- type: string
- pattern: '[-+](licenseNumber|tradeTitle|ownerName)'
- default:
- - +licenseNumber
-tags:
- - name: TradeLicense
- description: APIs required for Trade License.
- - name: NoticeDocument
- description: APIs required to handle Notice Doucments.
\ No newline at end of file
diff --git a/municipal-services/echallan-calculator/README.md b/municipal-services/echallan-calculator/README.md
index 0eab1b70145..e8ab5d15e7f 100644
--- a/municipal-services/echallan-calculator/README.md
+++ b/municipal-services/echallan-calculator/README.md
@@ -16,7 +16,8 @@ This service is used to calculate the echallan amount based on the details prese
Link to the swagger API contract yaml and editor link like below
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/e-Challan-v1.0.0.yaml#!/
+https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/municipal-services/develop/docs/e-Challan-v1.0.0.yaml#!/
+
## Service Details
diff --git a/municipal-services/echallan-services/README.md b/municipal-services/echallan-services/README.md
index 1145726cee4..69ed9401b76 100644
--- a/municipal-services/echallan-services/README.md
+++ b/municipal-services/echallan-services/README.md
@@ -19,7 +19,7 @@ eChallan system enables employees to generate the challans for Adhoc services so
Link to the swagger API contract yaml and editor link like below
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/e-Challan-v1.0.0.yaml#!/
+https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/municipal-services/develop/docs/e-Challan-v1.0.0.yaml#!/
## Service Details
diff --git a/municipal-services/egov-user-event/README.md b/municipal-services/egov-user-event/README.md
index 221c4ede557..7f188a1f1ac 100644
--- a/municipal-services/egov-user-event/README.md
+++ b/municipal-services/egov-user-event/README.md
@@ -17,7 +17,6 @@ This service provides APIs to create , update and search such events for the use
Link to the swagger API contract yaml and editor link like below
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/user-events.yml#!/
https://github.com/egovernments/DIGIT-Dev/blob/master/municipal-services/docs/user-events.yml
diff --git a/municipal-services/firenoc-calculator/README.md b/municipal-services/firenoc-calculator/README.md
index 35e86e37bb9..1dcafcfe58b 100644
--- a/municipal-services/firenoc-calculator/README.md
+++ b/municipal-services/firenoc-calculator/README.md
@@ -12,7 +12,7 @@ The main objective of the Firenoc calculator module is to create, update, search
### Swagger API Contract
-Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/fire_noc_calculation_service.yaml#!/) for firenoc calculator to understand the structure of APIs and to have visualization of all internal APIs.
+Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/municipal-services/master/firenoc-calculator/config/docs/contract/fire_noc_calculation_service.yaml#!/) for firenoc calculator to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/municipal-services/firenoc-services/README.md b/municipal-services/firenoc-services/README.md
index a5bd4312483..719f46ad8f7 100644
--- a/municipal-services/firenoc-services/README.md
+++ b/municipal-services/firenoc-services/README.md
@@ -14,7 +14,7 @@ The main objective of the Fire-NOC module is to provide **No Objection Certifica
### Swagger API Contract
-Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/fire_noc_contract.yaml#!) for Fire-NOC service to understand the structure of APIs and to have visualization of all internal APIs.
+Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/municipal-services/master/firenoc-services/docs/contract/fire_noc_contract.yaml#!/) for Fire-NOC service to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/municipal-services/fsm-calculator/README.md b/municipal-services/fsm-calculator/README.md
index dfe9940a4d1..9dec0e4db3a 100644
--- a/municipal-services/fsm-calculator/README.md
+++ b/municipal-services/fsm-calculator/README.md
@@ -20,7 +20,7 @@ Generates the Demand after calculating the charges for the given application usi
### Swagger API Contract
-Link to the swagger API contract [yaml](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/fsm/Fsm_Apply_Contract.yaml#!/) and editor link like below
+Link to the swagger API contract [yaml](https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/fsm/Fsm_Apply_Contract.yaml) and editor link like below
### Postman Collection
diff --git a/municipal-services/fsm/CHANGELOG.md b/municipal-services/fsm/CHANGELOG.md
index 18f484d3f1a..a96e226111a 100644
--- a/municipal-services/fsm/CHANGELOG.md
+++ b/municipal-services/fsm/CHANGELOG.md
@@ -2,6 +2,10 @@
# Changelog
All notable changes to this module will be documented in this file.
+## 1.2.0 - 2022-08-04
+- Unrestricted service request assignment in ULB employee flow
+- Unrestricted service request assignment in DSO flow
+
## 1.1.0 - 2022-03-29
- Pay now and post payment preference options provided at citizen and employee UI
diff --git a/municipal-services/fsm/README.md b/municipal-services/fsm/README.md
index 4e8a9495d2e..c0a5dd62f01 100644
--- a/municipal-services/fsm/README.md
+++ b/municipal-services/fsm/README.md
@@ -27,7 +27,7 @@ Faecal sludge management (FSM) is a system that enables citizen to raise a reque
### Swagger API Contract
-Link to the swagger API contract [yaml](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/fsm/Fsm_Apply_Contract.yaml#!/) and editor link like below
+Link to the swagger API contract [yaml](https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/fsm/Fsm_Apply_Contract.yaml) and editor link like below
### Postman Collection
diff --git a/municipal-services/fsm/pom.xml b/municipal-services/fsm/pom.xml
index afd208bbf05..f4ab3d186c2 100755
--- a/municipal-services/fsm/pom.xml
+++ b/municipal-services/fsm/pom.xml
@@ -10,7 +10,7 @@
org.egov
fsm
- 1.1.0-SNAPSHOT
+ 1.2.0-SNAPSHOT
fsm-services
fsm services
diff --git a/municipal-services/inbox/README.md b/municipal-services/inbox/README.md
index b101ada5cfa..9a3d5a35c3c 100644
--- a/municipal-services/inbox/README.md
+++ b/municipal-services/inbox/README.md
@@ -16,7 +16,7 @@ and returns applications and workflow data in paginated manner. The service also
### Swagger API Contract
-Link to the swagger API contract [yaml](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/inbox.yml#!/) and editor link like below
+Link to the swagger API contract [yaml](https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/inbox.yml) and editor link like below
### Postman Collection
diff --git a/municipal-services/land-services/README.md b/municipal-services/land-services/README.md
index c2d34aad196..e73c6b24d2c 100644
--- a/municipal-services/land-services/README.md
+++ b/municipal-services/land-services/README.md
@@ -27,7 +27,7 @@ This service is the major service supporting bpa-services which handles the data
### Swagger API Contract
-- [Swagger API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/bpa/bpa-service.yaml#!/)
+- [Swagger API](https://github.com/egovernments/municipal-services/blob/master/docs/bpa/bpa-service.yaml)
## Service Details
diff --git a/municipal-services/noc-services/README.md b/municipal-services/noc-services/README.md
index f5f306bfa09..7b43b57edf6 100755
--- a/municipal-services/noc-services/README.md
+++ b/municipal-services/noc-services/README.md
@@ -28,7 +28,7 @@ Module is used to apply NOC application for approval of respective noc users.
### Swagger API Contract
- - [Swagger API](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/noc-v-1.0.0.yaml#!)
+ - [Swagger API](https://github.com/egovernments/municipal-services/blob/Noc-Contract/docs/noc/noc-v-1.0.0.yaml)
## Service Details
diff --git a/municipal-services/pgr-services/README.md b/municipal-services/pgr-services/README.md
index dbbc294d9d8..f574f122a5c 100644
--- a/municipal-services/pgr-services/README.md
+++ b/municipal-services/pgr-services/README.md
@@ -19,7 +19,7 @@ the citizen and will be updated by notifications whenever the status of the comp
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/pgr-services.yml) for PGR service to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/pgr-services.yml) for PGR service to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/municipal-services/property-services/README.md b/municipal-services/property-services/README.md
index 8ec173d2af2..73855246b2d 100644
--- a/municipal-services/property-services/README.md
+++ b/municipal-services/property-services/README.md
@@ -17,7 +17,7 @@ NA
### Swagger API Contract
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/property-services/property-services.yml#!/
+https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/property-services/property-services.yml
## Service Details
diff --git a/municipal-services/sw-calculator/README.MD b/municipal-services/sw-calculator/README.MD
index fc68f800d51..fd019a803a7 100644
--- a/municipal-services/sw-calculator/README.MD
+++ b/municipal-services/sw-calculator/README.MD
@@ -14,7 +14,7 @@ This module created to manage the bill calculation for the registered sewerage s
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/water-sewerage-services.yaml#!/) to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://github.com/egovernments/municipal-services/blob/master/docs/water-sewerage-services.yaml) to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/municipal-services/sw-services/README.MD b/municipal-services/sw-services/README.MD
index 2cee1bb3401..1330a78425a 100644
--- a/municipal-services/sw-services/README.MD
+++ b/municipal-services/sw-services/README.MD
@@ -15,7 +15,7 @@ This module created to manage Sewerage Service connections against a Property in
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/water-sewerage-services.yaml#!/) for ws-services to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://github.com/egovernments/municipal-services/blob/master/docs/water-sewerage-services.yaml) for ws-services to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/municipal-services/tl-calculator/README.md b/municipal-services/tl-calculator/README.md
index 704b9969235..b8bb16eb571 100644
--- a/municipal-services/tl-calculator/README.md
+++ b/municipal-services/tl-calculator/README.md
@@ -16,7 +16,8 @@ This service is used to calculate the Tradelicense fees based on the defined bil
Link to the swagger API contract yaml and editor link like below
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/tl-calculator.yml#!/
+http://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/egov-services/master/docs/rainmaker/trade-license/tl-calculator.yml#!/
+
## Service Details
diff --git a/municipal-services/tl-services/README.md b/municipal-services/tl-services/README.md
index 0234146e7cc..64716282523 100644
--- a/municipal-services/tl-services/README.md
+++ b/municipal-services/tl-services/README.md
@@ -21,7 +21,8 @@ the steps for approval of the application.
Link to the swagger API contract yaml and editor link like below
-https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/tl-service.yml#!/
+http://editor.swagger.io/?url=https://github.com/egovernments/egov-services/blob/master/docs/rainmaker/trade-license/tl-service.yml#!/
+
## Service Details
diff --git a/municipal-services/vehicle/CHANGELOG.md b/municipal-services/vehicle/CHANGELOG.md
index d07cdbd06dd..904850fa52f 100644
--- a/municipal-services/vehicle/CHANGELOG.md
+++ b/municipal-services/vehicle/CHANGELOG.md
@@ -2,6 +2,10 @@
# Changelog
All notable changes to this module will be documented in this file.
+## 1.2.0 - 2022-08-04
+
+ - Vehicle logging at FSTP decoupled from FSM module
+
## 1.1.0 - 2022-03-29
- Multi-trip request per application at DSO and ULB application in post pay
- Vehicle type has been replaced with Vehicle Capacity in FSM application
diff --git a/municipal-services/vehicle/README.md b/municipal-services/vehicle/README.md
index d80c3a58893..36eefe24f9b 100644
--- a/municipal-services/vehicle/README.md
+++ b/municipal-services/vehicle/README.md
@@ -18,7 +18,7 @@ Vehicle Registry is a system that enables ULB Employees to create and search Veh
### Swagger API Contract
-Link to the swagger API contract [yaml](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/fsm/Vehicle_Registry_Contract.yaml#!/) and editor link like below
+Link to the swagger API contract [yaml](https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/fsm/Vehicle_Registry_Contract.yaml) and editor link like below
### Postman Collection
diff --git a/municipal-services/vehicle/pom.xml b/municipal-services/vehicle/pom.xml
index 9143e50e704..bb15b8a58b4 100755
--- a/municipal-services/vehicle/pom.xml
+++ b/municipal-services/vehicle/pom.xml
@@ -10,7 +10,7 @@
org.egov
vehicle
- 1.1.0-SNAPSHOT
+ 1.2.0-SNAPSHOT
vehicle
Demo project for Spring Boot
diff --git a/municipal-services/vendor/CHANGELOG.md b/municipal-services/vendor/CHANGELOG.md
index 8e5b47bf571..1d028f3b619 100644
--- a/municipal-services/vendor/CHANGELOG.md
+++ b/municipal-services/vendor/CHANGELOG.md
@@ -2,6 +2,10 @@
# Changelog
All notable changes to this module will be documented in this file.
+## 1.2.0 - 2022-08-04
+
+- Vehicle logging at FSTP decoupled from FSM module
+
## 1.1.0 - 2022-03-29
- Updated vendor search API to include to search based on vehicle capacity
diff --git a/municipal-services/vendor/README.md b/municipal-services/vendor/README.md
index b41bbc17414..43f91238972 100644
--- a/municipal-services/vendor/README.md
+++ b/municipal-services/vendor/README.md
@@ -18,7 +18,7 @@ Vehicle Registry is a system that enables ULB Employees to create and search Ven
### Swagger API Contract
-Link to the swagger API contract [yaml](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/fsm/Vendor_Registration_Contract.yaml#!/) and editor link like below
+Link to the swagger API contract [yaml](https://raw.githubusercontent.com/egovernments/municipal-services/master/docs/fsm/Vendor_Registration_Contract.yaml) and editor link like below
### Postman Collection
diff --git a/municipal-services/vendor/pom.xml b/municipal-services/vendor/pom.xml
index 16b673e2946..3375cd82a43 100644
--- a/municipal-services/vendor/pom.xml
+++ b/municipal-services/vendor/pom.xml
@@ -11,7 +11,7 @@
org.egov.vendor
vendor
- 1.1.0-SNAPSHOT
+ 1.2.0-SNAPSHOT
vendor
vendor services
diff --git a/municipal-services/ws-calculator/README.MD b/municipal-services/ws-calculator/README.MD
index a3f2de91e3f..47c931b2fbd 100644
--- a/municipal-services/ws-calculator/README.MD
+++ b/municipal-services/ws-calculator/README.MD
@@ -14,7 +14,7 @@ This module created to manage the Bill calculation for the registered water serv
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/water-sewerage-services.yaml#!/) to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://github.com/egovernments/municipal-services/blob/master/docs/water-sewerage-services.yaml) to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details
diff --git a/municipal-services/ws-services/README.md b/municipal-services/ws-services/README.md
index 775a7dfe1c7..8712772faca 100644
--- a/municipal-services/ws-services/README.md
+++ b/municipal-services/ws-services/README.md
@@ -15,7 +15,7 @@ This module created to manage WaterService connections against a Property in the
### Swagger API Contract
-- Please refer to the [Swagger API contarct](https://editor.swagger.io/?url=https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/municipal-services/docs/water-sewerage-services.yaml#!/) for ws-services to understand the structure of APIs and to have visualization of all internal APIs.
+- Please refer to the [Swagger API contarct](https://github.com/egovernments/municipal-services/blob/master/docs/water-sewerage-services.yaml) for ws-services to understand the structure of APIs and to have visualization of all internal APIs.
## Service Details