program-service-api-spec

openapi: 3.0.0
info:
  title: Program Service
  description: Program Management Service
  version: 1.0.0
  contact:
    name: eGov Foundation
    email: contact@egovernments.org
  license:
    name: MIT License
    url: https://opensource.org/license/mit/
externalDocs:
  description: DIGIT Platform
  url: https://core.digit.org
servers:
- url: /program-service/v1
paths:
  # Program requests -----------------------------------------
  /program/_create:
    post:
      tags:
        - Program
      summary: Create program
      description: Enables creation of program
      requestBody:
        description: Details of the new program + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/ProgramRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with created program
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProgramResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /program/_update:
    post:
      tags:
        - Program
      summary: Update created program
      description: Enables update of program relathttps://editor-next.swagger.io/ed information
      requestBody:
        description: Details of the updated program + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/ProgramRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with updated program
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProgramResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /program/_search:
    post:
      tags:
        - Program
      summary: Search programs by query
      description: Enables search programs
      requestBody:
        description: Search and get programs based on defined search criteria
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/ProgramSearchRequest'
        required: true
      responses:
        '200':
          description: ResponseInfo with programs
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProgramSearchResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false


  # Agency requests -----------------------------------------
  /agency/_create:
    post:
      tags:
        - Agency
      summary: Creates an agency
      description: Enables creation of an agency for a program
      requestBody:
        description: Details of new agency + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AgencyRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with agency created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgencyResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false
  
  /agency/_update:
    post:
      tags:
        - Agency
      summary: Updates an agency
      description: Enables update of an agency of a program
      requestBody:
        description: Details of updated agency + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AgencyRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with updated agency
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgencyResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /agency/_search:
    post:
      tags:
        - Agency
      summary: Searches agencies by query
      description: Enables search agencies
      requestBody:
        description: Search and get agency(s) based on defined search criteria
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AgencySearchRequest'
        required: true
      responses:
        '200':
          description: ResponseInfo with agencies
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AgencySearchResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  
  # Project requests -----------------------------------------
  /project/_create:
    post:
      tags:
        - Project
      summary: Create projects
      description: Enables creation of projects
      requestBody:
        description: Details of new project + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/ProjectRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with project created
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProjectResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /project/_update:
    post:
      tags:
        - Project
      summary: Update created programs
      description: Enables update of project related information
      requestBody:
        description: Details of updated project + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/ProjectRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with updated project
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProjectResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /project/_search:
    post:
      tags:
        - Project
      summary: Search programs by query
      description: Enables search of program
      requestBody:
        description: Search and get project(s) based on defined search criteria
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/ProjectSearchRequest'
        required: true
      responses:
        '200':
          description: ResponseInfo with projects
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/ProjectSearchResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false


  # Estimate requests -----------------------------------------
  /estimate/_create:
    post:
      tags:
        - Estimate
      summary: Create estimate
      description: Enables exchange of estimate related messages, and store them.
      requestBody:
        description: Details of new estimate + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/EstimateRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with created estimate
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EstimateResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /estimate/_update:
    post:
      tags:
        - Estimate
      summary: Update created estimate
      description: Enables to update the existing created estimate
      requestBody:
        description: Details of new estimate + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/EstimateRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with updated estimate
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EstimateResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /estimate/_search:
    post:
      tags:
        - Estimate
      summary: Search estimate by query
      description: Enables search of esimate and return each fields
      requestBody:
        description: Search and get esimate(s) based on defined search criteria
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/EstimateSearchRequest'
        required: true
      responses:
        '200':
          description: ResponseInfo with created estimate
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/EstimateSearchResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false


  # Sanciton requests
  /sanction/_create:
    post:
      tags:
        - Sanction
      summary: Create sanctions
      description: Enables exchange of program related messages
      requestBody:
        description: Details of new sanction + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/SanctionRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with created sanction
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SanctionResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /sanction/_update:
    post:
      tags:
        - Sanction
      summary: Update sanction details
      description: Update the sanction details, sanction is immutable only status can be changed.
      requestBody:
        description: Details of updated sanction + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/SanctionRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with created sanction
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SanctionResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /sanction/_search:
    post:
      tags:
        - Sanction
      summary: Search Sanction details
      description: Search sanciton by query and return the response 
      requestBody:
        description: Search and get sanction(s) based on defined search criteria
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/SanctionSearchRequest'
        required: true
      responses:
        '200':
          description: ResponseInfo with created sanction
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/SanctionSearchResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  
  # Allocation Requests-----------------------------------------
  /allocation/_create:
    post:
      tags:
        - Allocation
      summary: Request to create allocation 
      description: User can request to create an allocation.
      requestBody:
        description: Details of new allocation + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AllocationRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with created allocation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AllocationResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /allocation/_update:
    post:
      tags:
        - Allocation
      summary: Request to update allocation 
      description: User can request to update in existing create allocation.
      requestBody:
        description: Details of updated allocation + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AllocationRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with updated allocation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AllocationResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /allocation/_search:
    post:
      tags:
        - Allocation
      summary: Search allocation details
      description: Search allocation by query and return the response
      requestBody:
        description: Search and get allocation(s) based on defined search criteria
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/AllocationSearchRequest'
        required: true
      responses:
        '200':
          description: ResponseInfo with allocation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/AllocationSearchResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false
    
    
  # Disburse Requests-----------------------------------------
  /disburse/_create:
    post:
      tags:
        - Disburse
      summary: Initiate payment request
      description: Create new disbursement request to initiate payment
      requestBody:
        description: Details of new allocation + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/DisburseRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with disbursement request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DisburseResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false
  
  /disburse/_update:
    post:
      tags:
        - Disburse
      summary: Initiate payment request
      description:  Update disbursement request
      requestBody:
        description: Details of updated allocation + RequestInfo metadata
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/DisburseRequest'
        required: true
      responses:
        '201':
          description: ResponseInfo with disbursement request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DisburseResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false

  /disburse/_search:
    post:
      tags:
        - Disburse
      summary: Search created disbursements
      description: Return disbursements based on query
      requestBody:
        description: Search and get disbursement(s) based on defined search criteria
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/DisburseSearchRequest'
        required: true
      responses:
        '200':
          description: ResponseInfo with disbursement request
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/DisburseSearchResponse'
        '400':
          description: Bad Request
          content:
            '*/*':
              schema:
                $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ErrorRes'
      deprecated: false


components:
  schemas:
    ProgramRequest:
      description: Contract class to receive program request
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Program:
          $ref: '#/components/schemas/Program'
      required:
          - RequestInfo
          - Program

    ProgramSearchRequest:
      description: Search and get program(s) based on search criteria
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Criteria:
          $ref: '#/components/schemas/ProgramSearch'
        Pagination:
          $ref: '#/components/schemas/Pagination'
      required:
          - RequestInfo
          - Criteria
    
    AgencyRequest:
      description: Contract class to receive agency request
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Agency:
          $ref: '#/components/schemas/Agency'
      required:
          - RequestInfo
          - Agency
    
    AgencySearchRequest:
      description: Search and get agency(s) based on search criteria
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Criteria:
          $ref: '#/components/schemas/AgencySearch'
        Pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - RequestInfo
        - Criteria

    ProjectRequest:
      description: Contract class to receive project request
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Project:
          $ref: '#/components/schemas/Project'
      required:
        - RequestInfo
        - Project
    
    ProjectSearchRequest:
      description: Search and get project(s) based on search criteria
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Criteria:
          $ref: '#/components/schemas/ProjectSearch'
        Pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - RequestInfo
        - Criteria

    EstimateRequest:
      description: Contract class to receive estimate request
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Estimate:
          $ref: '#/components/schemas/Estimate'
      required:
        - RequestInfo
        - Estimate
      
    EstimateSearchRequest:
      description: Search and get estimate(s) based on search criteria
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Criteria:
          $ref: '#/components/schemas/EstimateSearch'
        Pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - RequestInfo
        - Criteria

    SanctionRequest:
      description: Contract class to receive sanction request
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Sanction:
          $ref: '#/components/schemas/Sanction'
      required:
        - RequestInfo
        - Sanction
    
    SanctionSearchRequest:
      description:  Search and get sanction(s) based on search criteria
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Criteria:
          $ref: '#/components/schemas/SanctionSearch'
        Pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - RequestInfo
        - Criteria
    
    AllocationRequest:
      description: Contract class to receive allocation request
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Allocation:
          $ref: '#/components/schemas/Allocation'
      required:
        - RequestInfo
        - Allocation
    
    AllocationSearchRequest:
      description: Search and get allocation(s) based on search criteria
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Criteria:
          $ref: '#/components/schemas/AllocationSearch'
        Pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - RequestInfo
        - Criteria

    DisburseRequest:
      description: Contract class to receive disbursement request
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Disburse:
          $ref: '#/components/schemas/Disburse'
      required:
        - RequestInfo
        - Disburse

    DisburseSearchRequest:
      description: Search and get disbursement(s) based on search criteria
      type: object
      properties:
        RequestInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/egov-services/master/docs/common/contracts/v1-0-0.yml#/definitions/RequestInfo'
        Criteria:
          $ref: '#/components/schemas/DisburseSearch'
        Pagination:
          $ref: '#/components/schemas/Pagination'
      required:
        - RequestInfo
        - Criteria

    AdditionalInfo:
      type: object
      description: Additional JSON property oject to hold custom user defined contextual data
    
    Error:
      description: |
        Commumication layer Asyn errors that are returned as part of message acknowledgement.
        1. Messages that are not parsable or message integrity check fails.
        2. This object may be used across all transport layer protocols (https, sftp, messaging, etc,) to ack the receipt of a message.
        3. Business context and related validation is NOT in scope of this error object.
      type: object
      properties:
        code:
          type: string
          description: Standard error code
          enum:
            - err.request.bad
            - err.request.unauthorized
            - err.request.forbidden
            - err.request.not_found
            - err.request.timeout
            - err.version.not_supported
            - err.request.too_many_requests
            - err.sender_id.invalid
            - err.sender_uri.invalid
            - err.receiver_id.invalid
            - err.signature.missing
            - err.signature.invalid
            - err.encryption.invalid
            - err.service.unavailable
        message:
          type: string
          description: message to describe above error code
          maxLength: 999
    
    Pagination:
      description: Pagination details
      type: object
      properties:
        limit:
          description: >-
            Limit for total no of records in single search max limit should be
            defined as envirnment variable
          type: number
          default: 10
          maximum: 100
          format: double
        offSet:
          description: offset or page no
          type: number
          default: 0
          format: double
        totalCount:
          description: Total count for a perticular criteria
          readOnly: true
          type: number
          format: double
        sortBy:
          description: result sorting order
          type: string
        order:
          type: object
          $ref: '#/components/schemas/Order'
          description: Sorting order
    Order:
      description: Sorting order
      type: string
      enum:
        - asc
        - desc

    Program:
      type: object
      description: Describes the details of the program
      properties:
        id:
          type: string
          example: "251c51eb-e970-4e01-a99a-70136c47a934"
          minLength: 2
          maxLength: 64
          readOnly: true
        tenantId:
          type: string
          description: Unique identifier of the tenant that could be a department/ulb/state
          minLength: 2
          maxLength: 64
          example: "pg.citya"
        programId:
          type: string
          description: Formatted program ID [tenantid]/{programCode} 
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM"
        programCode:
          type: string
          description: Unique program code PROG
          minLength: 2
          maxLength: 64
          example: "JJM"
        name:
          type: string
          description: 'Name of the program'
          minLength: 2
          maxLength: 64
          example: "Jal Jeevan Mission"
        description:
          type: string
          description: 'Description of the program'
          minLength: 2
          maxLength: 256
          example: "Every rural household has drinking water supply in adequate quantity of prescribed quality on regular and long-term basis at affordable service delivery charges leading to improvement in living standards of rural communities."
        startDate:
          type: number
          example: 1672531200
        endDate:
          type: number
          example: 1704067200
        objective:
          type: array
          items:
            type: string
            example: "To provide FHTC to every rural household."
        criteria:
          type: array
          items:
            type: string
            example: "Weightage of rural population (as per last Census) should be 30 percent."
        status:
          $ref: '#/components/schemas/Status'
        additionalDetails: 
          $ref: "#/components/schemas/AdditionalInfo"
        auditDetails:
          $ref: "#/components/schemas/AuditDetails"
      required:
        - tenantId
        - name
        - startDate
        - programCode

    ProgramSearch:
      type: object
      description: Program search criteria
      properties:
        ids:
          type: array
          items:
            type: string
            example: "251c51eb-e970-4e01-a99a-70136c47a934"
        statusCode:
          type: string
          example: "SUCCESSFUL"
        programCode:
          type: string
          example: "JJM"
        programId:
          type: string
          example: "pg.citya/JJM"
        tenantId:
          type: string
          example: "pg.citya"
      required:
        - tenantId
    
    Agency:
      type: object
      description: Describes the details of an agency
      properties:
        id:
          type: string
          example: "251c51eb-e970-4e01-a99a-70136c47a934"
          minLength: 2
          maxLength: 64
          readOnly: true
        tenantId:
          type: string
          example: "pg.citya"
        agencyId:
          type: string
          description: Formated Agency ID [tenantid]/{programCode}/{agencyType}/{orgNumber}
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Funding/ORG-000081"
        agencyType:
          type: string
          example: "Funding Agency"
        programCode:
          type: string
          description: Unique program code
          minLength: 2
          maxLength: 64
          example: "JJM"
        orgNumber:
          description: Formatted organisation number issued after application is approved
          type: string
          minLength: 1
          maxLength: 64
          example: "ORG-000081"
        auditDetails:
          $ref: "#/components/schemas/AuditDetails"
      required:
        - tenantId
        - agencyType
        - programCode
        - orgNumber

    AgencySearch:
      type: object
      description: Agency search criteria
      properties:
        ids:
          type: array
          items:
            type: string
            example: "251c51eb-e970-4e01-a99a-70136c47a934"
        tenantId:
          type: string
          example: "pg.citya"
        agencyType:
          type: string
          example: "Funding"
        programCode:
          type: string
          example: "pg.citya/JJM"
        agencyId:
          type: string
          example: "pg.citya/JJM/Funding/ORG-000081"
        orgNumber:
          type: string
          example: "ORG-000081"
      required:
        - tenantId

    Project:
      type: object
      description: Describes the details of the project
      properties:
        id:
          type: string
          example: "251c51eb-e970-4e01-a99a-70136c47a934"
          minLength: 2
          maxLength: 64
          readOnly: true
        tenantId:
          type: string
          description: Unique identifier of the tenant that could be a department/ulb/state
          minLength: 2
          maxLength: 64
          example: "pg.citya"
        programCode:
          type: string
          description: Unique program code PROG
          minLength: 2
          maxLength: 64
          example: "JJM"
        agencyId:
          type: string
          description: Formated agency ID [tenantid]/{programCode}/{agencyType}/{orgNumber}
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Funding/ORG-000081"
        projectCode:
          type: string
          description: Unique project code PROJ
          minLength: 2
          maxLength: 64
          example: "Andhra"
        projectId:
          type: string
          description: Formated project ID [tenantid]/{programCode}/{projectCode}
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Andhra"
        name:
          type: string
          description: 'Name of the project'
          minLength: 2
          maxLength: 64
          example: "Andhra Jal Jeevan Mission"
        description:
          type: string
          description: 'Description of the project'
          minLength: 2
          maxLength: 256
          example: "Every rural household has drinking water supply in adequate quantity of prescribed quality on regular and long-term basis at affordable service delivery charges leading to improvement in living standards of rural communities."
        status:
          $ref: '#/components/schemas/Status'
        additionalDetails: 
          $ref: "#/components/schemas/AdditionalInfo"
        auditDetails:
          $ref: "#/components/schemas/AuditDetails"
      required:
        - tenantId
        - name
        - programCode
        - agencyCode
        - projectCode    

    ProjectSearch:
      type: object
      description: Project search criteria
      properties:
        ids:
          type: array
          items:
            type: string
            example: "251c51eb-e970-4e01-a99a-70136c47a934"
        tenantId:
          type: string
          example: "pg.citya"
        programCode:
          type: string
          description: Unique program code PROG
          example: "JJM"
        agencyId:
          type: string
          description: Formated agency ID [tenantid]/{programCode}/{agencyType}/{orgNumber}
          example: "pg.citya/JJM/Funding/ORG-000081"
        projectCode:
          type: string
          description: Unique project code PROJ
          example: "Andhra"
        projectId:
          type: string
          description: Formated project ID [tenantid]/{programCode}/{projectCode}
          example: "pg.citya/JJM/Andhra"
      required:
        - tenantId

    Estimate:
      type: object
      description: Describes the details of the estimate
      properties:
        id:
          type: string
          example: "251c51eb-e970-4e01-a99a-70136c47a934"
          minLength: 2
          maxLength: 64
          readOnly: true
        tenantId:
          type: string
          description: Unique identifier of the tenant that could be a department/ulb/state
          minLength: 2
          maxLength: 64
          example: "pg.citya"
        programCode:
          type: string
          description: Unique program code PROG
          minLength: 2
          maxLength: 64
          example: "JJM"
        projectCode:
          type: string
          description: Unique project code PROJ
          minLength: 2
          maxLength: 64
          example: "Andhra"
        estimateId:
          type: string
          description: Formated estimate ID [tenantid]/{programCode}/{projectCode}/ES-[NUM_SEQ]
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Andhra/ES-000071"
        description:
          type: string
          description: 'Description of the estimate'
          minLength: 2
          maxLength: 256
          example: "Funds are according to the rural population (as per last Census)"
        netAmount:
          type: number
          description: Amount to be paid including deduction amount
          example: 1000
        grossAmount:
          type: number
          description: Actual amount to be paid without deduction
          example: 1000
        status:
          $ref: '#/components/schemas/Status'
        additionalDetails: 
          $ref: "#/components/schemas/AdditionalInfo"
        auditDetails:
          $ref: "#/components/schemas/AuditDetails"
      required:
        - tenantId
        - programCode
        - projectCode
        - netAmount
        - grossAmount
    
    EstimateSearch:
      type: object
      description: Estimate search criteria
      properties:
        ids:
          type: array
          items:
            type: string
            example: "251c51eb-e970-4e01-a99a-70136c47a934"
        programCode:
          type: string
          example: "JJM"
        projectCode:
          type: string
          example: "Andhra"
        estimateId:
          type: string
          description: Formated estimate ID [tenantid]/{programCode}/{projectCode}/ES-[NUM_SEQ]
          example: "pg.citya/JJM/Andhra/ES-000071"
        tenantId:
          type: string
          example: "pg.citya"
      required:
        - tenantId
  
    Status:
      type: object
      properties:
        statusCode:
          type: string
          enum:
            - RECEIVED
            - APPROVED
            - REJECTED
            - INPROCESS
            - INITIATED
            - SUCCESSFUL
            - FAILED
            - PARTIAL
            - CANCELLED
            - COMPLETED
            - ERROR
            - INFO
            - ACTIVE
            - INACTIVE
          example: SUCCESSFUL
        statusMessage:
          type: string

    Sanction:
      type: object
      description: Describes the details of the sanction
      properties:
        id:
          type: string
          example: "251c51eb-e970-4e01-a99a-70136c47a934"
          minLength: 2
          maxLength: 64
          readOnly: true
        tenantId:
          type: string
          description: Unique identifier of the tenant that could be a department/ulb/state
          minLength: 2
          maxLength: 64
          example: "pg.citya"
        programCode:
          type: string
          description: Unique program code PROG
          minLength: 2
          maxLength: 64
          example: "JJM"
        projectCode:
          type: string
          description: Unique project code PROJ
          minLength: 2
          maxLength: 64
          example: "Andhra"
        sancitonId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/SA-[NUM_SEQ]
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Andhra/SA-000191"
        netAmount:
          type: number
          example: 1000
        grossAmount:
          type: number
          example: 1000
        availableAmount:
          type: number
          example: 1000
        status:
          $ref: '#/components/schemas/Status'
        additionalDetails: 
          $ref: "#/components/schemas/AdditionalInfo"
        auditDetails:
          $ref: "#/components/schemas/AuditDetails"
      required:
        - tenantId
        - programCode
        - projectCode
        - availableAmount
    
    SanctionSearch:
      type: object
      description: Sanction search criteria
      properties:
        ids:
          type: array
          items:
            type: string
            example: "251c51eb-e970-4e01-a99a-70136c47a934"
        tenantId:
          type: string
          example: "pg.citya"
        programCode:
          type: string
          example: "JJM"
        projectCode:
          type: string
          example: "Andhra"
        sancitonId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/SA-[NUM_SEQ]
          example: "pg.citya/JJM/Andhra/SA-000191"
      required:
        - tenantId
      
    Allocation:
      type: object
      description: Describes the details of the allocation
      properties:
        id:
          type: string
          example: "251c51eb-e970-4e01-a99a-70136c47a934"
          minLength: 2
          maxLength: 64
          readOnly: true
        tenantId:
          type: string
          description: Unique identifier of the tenant that could be a department/ulb/state
          minLength: 2
          maxLength: 64
          example: "pg.citya"
        programCode:
          type: string
          description: Unique program code PROG
          minLength: 2
          maxLength: 64
          example: "JJM"
        projectCode:
          type: string
          description: Unique project code PROJ
          minLength: 2
          maxLength: 64
          example: "Andhra"
        sanctionId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/SA-[NUM_SEQ]
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Andhra/SA-000191"
        allocationId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/AL-[NUM_SEQ]
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Andhra/AL-000191"
        netAmount:
          type: number
          example: 1000
        grossAmount:
          type: number
          example: 1000
        allocationType:
          type: string
          default: ALLOCATION
          enum:
            - ALLOCATION
            - DEDUCTION
        status:
          $ref: '#/components/schemas/Status'
        additionalDetails: 
          $ref: "#/components/schemas/AdditionalInfo"
        auditDetails:
          $ref: "#/components/schemas/AuditDetails"
      required:
        - tenantId
        - sanctionId
        - programCode
        - projectCode
        - netAmount
        - grossAmount
        - allocationType
    
    AllocationSearch:
      type: object
      description: Allocation search criteria
      properties:
        ids:
          type: array
          items:
            type: string
            example: "251c51eb-e970-4e01-a99a-70136c47a934"
        tenantId:
          type: string
          example: "pg.citya"
        programCode:
          type: string
          example: "JJM"
        projectCode:
          type: string
          example: "Andhra"
        sanctionId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/SA-[NUM_SEQ]
          example: "pg.citya/JJM/Andhra/SA-000191"
        allocationId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/AL-[NUM_SEQ]
          example: "pg.citya/JJM/Andhra/AL-000191"
      required:
        - tenantId

    Disburse:
      type: object
      description: Describes the details of the disbursement
      properties:
        id:
          type: string
          example: "251c51eb-e970-4e01-a99a-70136c47a934"
          minLength: 2
          maxLength: 64
          readOnly: true
        tenantId:
          type: string
          description: Unique identifier of the tenant that could be a department/ulb/state
          minLength: 2
          maxLength: 64
          example: "pg.citya"
        programCode:
          type: string
          description: unique program code PROG
          minLength: 2
          maxLength: 64
          example: "JJM"
        projectCode:
          type: string
          description: Unique project code PROJ
          minLength: 2
          maxLength: 64
          example: "Andhra"
        disburseId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/DI-[NUM_SEQ]
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Andhra/DI-000191"
        targetId:
          type: string
          description: Refernece id of works payment
          example: EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934
        transactionId:
          type: string
          description: Formated transaction code, it will return after transaction is created at another end.
          minLength: 2
          maxLength: 64
          example: PI/2023-24/00001,BENF/2023-24/00001
        sanctionId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/SA-[NUM_SEQ]
          minLength: 2
          maxLength: 64
          example: "pg.citya/JJM/Andhra/SA-000191"
        accountCode:
          type: string
          description: Account no with ifsc code will be account code, it will be in format ACCOUNT_NO@IFSC_CODE
          example: 1234567890@SBIN0003491
        netAmount:
          type: number
          description: Amount to be paid including deduction amount
          example: 1000
        grossAmount:
          type: number
          description: Actual amount to be paid without deduction
          example: 1000
        status:
          $ref: '#/components/schemas/Status'
        additionalDetails: 
          $ref: "#/components/schemas/AdditionalInfo"
        auditDetails:
          $ref: "#/components/schemas/AuditDetails"
      required:
        - targetId
        - tenantId
        - programCode
        - projectCode
        - sancitonId
        - accountCode
        - netAmount
        - grossAmount

    DisburseSearch:
      type: object
      description: Disburse search criteria
      properties:
        ids:
          type: array
          items:
            type: string
            example: "251c51eb-e970-4e01-a99a-70136c47a934"
        tenantId:
          type: string
          example: "pg.citya"
        programCode:
          type: string
          example: "JJM"
        projectCode:
          type: string
          description: Unique project code PROJ
          example: "Andhra"
        disburseId:
          type: string
          description: Formated sanction ID [tenantid]/{programCode}/{projectCode}/DI-[NUM_SEQ]
          example: "pg.citya/JJM/Andhra/DI-000191"
        targetId:
          type: string
          description: Refernece id of works payment
          example: EP/0/2023-24/08/14/000267, 251c51eb-e970-4e01-a99a-70136c47a934
      required:
        - tenantId
     
    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

    ProgramResponse:
      description: Create and update program's response
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Program:
          $ref: '#/components/schemas/Program'

    ProgramSearchResponse:
      description: Response to program search criteria
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Programs:
          type: array
          items:
            $ref: '#/components/schemas/Program'

    AgencyResponse:
      description: Create and update agency's response
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Agency:
          $ref: '#/components/schemas/Agency'


    AgencySearchResponse:
      description: Response to agency search criteria
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Agencies:
          type: array
          items:
            $ref: '#/components/schemas/Agency'

    ProjectResponse:
      description: Create and update project's response
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Project:
          $ref: '#/components/schemas/Project'

    ProjectSearchResponse:
      description: Response to project search criteria
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Projects:
          type: array
          items:
            $ref: '#/components/schemas/Project'
    
    EstimateResponse:
      description: Create and update estimate's response
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Estimate:
          $ref: '#/components/schemas/Estimate'

    EstimateSearchResponse:
      description: Response to estimate search criteria
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Estimates:
          type: array
          items:
            $ref: '#/components/schemas/Estimate'

    SanctionResponse:
      description: Create and update sanctions's response
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Sanction:
          $ref: '#/components/schemas/Sanction'

    SanctionSearchResponse:
      description: Sanction Search response with sanction details
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Sanctions:
          type: array
          items:
            $ref: '#/components/schemas/Sanction'

    AllocationResponse:
      description: Create and update allocation's response
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Allocation:
          $ref: '#/components/schemas/Allocation'

    AllocationSearchResponse:
      description: Allocation search response with allocation details
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Allocations:
          type: array
          items:
            $ref: '#/components/schemas/Allocation'

    DisburseResponse:
      description: Create and update allocation's response
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Disburse:
          $ref: '#/components/schemas/Disburse'

    DisburseSearchResponse:
      description: Disburement search response with disburse details
      type: object
      properties:
        ResponseInfo:
          $ref: 'https://raw.githubusercontent.com/egovernments/DIGIT-OSS/master/core-services/docs/common-contract_v1-1.yml#/components/schemas/ResponseInfo'
        Disburses:
          type: array
          items:
            $ref: '#/components/schemas/Disburse'