Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

https://github.com/egovernments/DIGIT-Dev/blob/0f62318dd3183fbce13b66af7012ddae027376f9/frontend/micro-ui/web/micro-ui-internals/packages/modules/bills/src/components/Search/index.js

...

Hooks/Utils Used:

...

API Endpoint

...

API description

...

Employee Roles

...

egov-searcher/bill-genie/billswithaddranduser/_get

...

→ To search bills

→ Returns a list of bills according to the search criteria

...

Employee ,Bill Genie Employee

...

/egov-pdf/download/BILL/consolidatedbill

...

→ To download bills according to the search criteria

→ Returns a pdf file

...

Employee, Bill Genie Employee

API Curls:

  • Search bill API

...

  1. To Download a bill → A util function named downloadBill is used which is defined in this file

https://github.com/egovernments/DIGIT-Dev/blob/db572b868bad5af8564452606be4690c25041419/frontend/micro-ui/web/micro-ui-internals/packages/libraries/src/utils/pdf.js

This util function is inside Digit Utils hence it can be called anywhere throughout the application like this Digit.Utils.downloadBill(consumerCode, businessService, "consolidatedreceipt")

  1. To Search a bill → A hook named useBillSearch is used to search bills which is defined in this file

https://github.com/egovernments/DIGIT-Dev/blob/b24905db78ba453cfdb606cf8069cde0e5025de6/frontend/micro-ui/web/micro-ui-internals/packages/libraries/src/hooks/bills/useBillSearch.js

  1. To fetch the data for service Category dropdown → A hook named useCommonMDMS is used to fetch this data. This hook is called with the following parameters:

Digit.Hooks.useCommonMDMS(tenantId, "BillingService", "BillsGenieKey");

Technical implementation of this hook can be found here:

https://github.com/egovernments/DIGIT-Dev/blob/111d6269f3c7210cf829dea11dfe5062378b54f8/frontend/micro-ui/web/micro-ui-internals/packages/libraries/src/hooks/useMDMS.js

API Curls:

  • Search bill API

Code Block
curl 'https://qa.digit.org/egov-searcher/bill-genie/billswithaddranduser/_get?_=1657020362243' \
  -H 'authority: qa.digit.org' \
  -H 'sec-ch-ua-platform: "Windows"accept: application/json, text/plain, */*' \
  -H 'secaccept-fetch-destlanguage: emptyen-US,en;q=0.9' \
  -H 'seccontent-fetch-modetype: corsapplication/json;charset=UTF-8' \
  -H 'sec-fetch-site: same-originorigin: https://qa.digit.org' \
  -H 'user-agentreferer: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36https://qa.digit.org/digit-ui/employee/bills/inbox' \
  -H 'sec-datach-rawua: '{"searchCriteria":{"tenantId":"pb.amritsar","mobileNumber":"7878787878","limit":10,"sortBy":"commencementDate","sortOrder":"DESC","url":"/bill-genie/billswithaddranduser/_get","businesService":"PT"},"RequestInfo":{"apiId":"Rainmaker","authToken":"73541f52-2fd8-4c66-8f71-8b1b7cd4fa82","msgId":"1657020362242|en_IN","plainAccessRequest":{}}}".Not/A)Brand";v="99", "Google Chrome";v="103", "Chromium";v="103"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "Windows"' \
  -H 'sec-fetch-dest: empty' \
  --compressed
  • Download Bill API

Code Block
curl 'https://qa.digit.org/egov-pdf/download/BILL/consolidatedbill?bussinessService=PT&tenantId=pb.amritsar&consumerCode=PB-PT-2020-02-07-003594H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'authorityuser-agent: qa.digit.org' \
  -H 'accept: application/pdf' \
  -H 'accept-language: en-US,en;q=0.9Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36' \
  -H-data-raw 'content-type: application/json' \
  -H 'origin: https://qa.digit.org' \
  -H 'referer: https://qa.digit.org/digit-ui/employee/bills/inbox' \
  -H 'sec-ch-ua: ".Not/A)Brand";v="99", "Google Chrome";v="103", "Chromium";v="103"' \
  -H 'sec-ch-ua-mobile: ?0{"searchCriteria":{"tenantId":"pb.amritsar","mobileNumber":"7878787878","limit":10,"sortBy":"commencementDate","sortOrder":"DESC","url":"/bill-genie/billswithaddranduser/_get","businesService":"PT"},"RequestInfo":{"apiId":"Rainmaker","authToken":"73541f52-2fd8-4c66-8f71-8b1b7cd4fa82","msgId":"1657020362242|en_IN","plainAccessRequest":{}}}' \
  -H 'sec-ch-ua-platform: "Windows"-compressed

  • Download Bill API

Code Block
curl 'https://qa.digit.org/egov-pdf/download/BILL/consolidatedbill?bussinessService=PT&tenantId=pb.amritsar&consumerCode=PB-PT-2020-02-07-003594' \
  -H 'sec-fetch-destauthority: emptyqa.digit.org' \
  -H 'sec-fetch-modeaccept: corsapplication/pdf' \
  -H 'secaccept-fetch-sitelanguage: same-originen-US,en;q=0.9' \
  -H 'usercontent-agenttype: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36application/json' \
  -H 'origin: https://qa.digit.org' \
  -H 'referer: https://qa.digit.org/digit-ui/employee/bills/inbox' \
  -H 'sec-datach-rawua: '{"RequestInfo":{"apiId":"Rainmaker","authToken":"73541f52-2fd8-4c66-8f71-8b1b7cd4fa82","userInfo":{"id":12579,"uuid":"746412f0-93cc-4da2-8aff-33301aad92fc","userName":"JA","name":"Jagan","mobileNumber":"9092251026","emailId":"Dummy@dummy.com","locale":null,"type":"EMPLOYEE","roles":[{"name":"LOA Creator","code":"LOA_CREATOR","tenantId":"pb.amritsar"},{"name":"Grievance Routing Officer","code":"GRO","tenantId":"pb.amritsar"},{"name":"NoC counter employee","code":"NOC_CEMP","tenantId":"pb.amritsar"},{"name":"BPA Builder","code":"BPA_BUILDER","tenantId":"pb.amritsar"},{"name":"Finance Report View","code":"EGF_REPORT_VIEW","tenantId":"pb.amritsar"},{"name":"AssetReportViewer","code":"AssetReportViewer".Not/A)Brand";v="99", "Google Chrome";v="103", "Chromium";v="103"' \
  -H 'sec-ch-ua-mobile: ?0' \
  -H 'sec-ch-ua-platform: "Windows"' \
  -H 'sec-fetch-dest: empty' \
  -H 'sec-fetch-mode: cors' \
  -H 'sec-fetch-site: same-origin' \
  -H 'user-agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/103.0.0.0 Safari/537.36' \
  --data-raw '{"RequestInfo":{"apiId":"Rainmaker","authToken":"73541f52-2fd8-4c66-8f71-8b1b7cd4fa82","userInfo":{"id":12579,"uuid":"746412f0-93cc-4da2-8aff-33301aad92fc","userName":"JA","name":"Jagan","mobileNumber":"9092251026","emailId":"Dummy@dummy.com","locale":null,"type":"EMPLOYEE","roles":[{"name":"LOA Creator","code":"LOA_CREATOR","tenantId":"pb.amritsar"},{"name":"BPAGrievance FieldRouting InspectorOfficer","code":"BPA_FIELD_INSPECTORGRO","tenantId":"pb.amritsar"},{"name":"TLNoC Fieldcounter Inspectoremployee","code":"TLNOC_FIELD_INSPECTORCEMP","tenantId":"pb.amritsar"},{"name":"EGFBPA Bill CreatorBuilder","code":"EGFBPA_BILL_CREATORBUILDER","tenantId":"pb.amritsar"},{"name":"PTFinance CounterReport EmployeeView","code":"PTEGF_REPORT_CEMPVIEW","tenantId":"pb.amritsar"},{"name":"BPA Services ApproverAssetReportViewer","code":"BPA_APPROVERAssetReportViewer","tenantId":"pb.amritsar"},{"name":"FireBPA NocField Department ApproverInspector","code":"FIREBPA_NOCFIELD_APPROVERINSPECTOR","tenantId":"pb.amritsar"},{"name":"CounterTL Field EmployeeInspector","code":"CEMPTL_FIELD_INSPECTOR","tenantId":"pb.amritsar"},{"name":"AdminEGF ofBill a ULBCreator","code":"CITYEGF_BILL_ADMINCREATOR","tenantId":"pb.amritsar"},{"name":"PT FieldCounter InspectorEmployee","code":"PT_FIELD_INSPECTORCEMP","tenantId":"pb.amritsar"},{"name":"WSBPA CounterServices EmployeeApprover","code":"WSBPA_CEMPAPPROVER","tenantId":"pb.amritsar"},{"name":"FSM DriverFire Noc Department Approver","code":"FSMFIRE_NOC_DRIVERAPPROVER","tenantId":"pb.amritsar"},{"name":"AnyCounter UserEmployee","code":"ANONYMUSCEMP","tenantId":"pb.amritsar"},{"name":"WSAdmin of Fielda InspectorULB","code":"WSCITY_FIELD_INSPECTORADMIN","tenantId":"pb.amritsar"},{"name":"WorksPT Field AdministratorInspector","code":"WORKSPT_FIELD_ADMINISTRATORINSPECTOR","tenantId":"pb.amritsar"},{"name":"ULBWS AdministratorCounter Employee","code":"PTADMINWS_CEMP","tenantId":"pb.amritsar"},{"name":"Property Tax Receipt CancellatorFSM Driver","code":"CRFSM_PTDRIVER","tenantId":"pb.amritsar"},{"name":"PTAny Doc VerifierUser","code":"PT_DOC_VERIFIERANONYMUS","tenantId":"pb.amritsar"},{"name":"FSMWS Field AdministratorInspector","code":"FSMWS_FIELD_ADMININSPECTOR","tenantId":"pb.amritsar"},{"name":"EmployeeWorks Administrator","code":"EMPLOYEEWORKS_ADMINISTRATOR","tenantId":"pb.amritsar"},{"name":"BPAREGULB EmployeeAdministrator","code":"BPAREG_EMPLOYEEPTADMIN","tenantId":"pb.amritsar"},{"name":"TLProperty CounterTax EmployeeReceipt Cancellator","code":"TLCR_CEMPPT","tenantId":"pb.amritsar"},{"name":"CommissionerPT Doc Verifier","code":"COMMISSIONERPT_DOC_VERIFIER","tenantId":"pb.amritsar"},{"name":"TLFSM CreatorAdministrator","code":"TLFSM_CREATORADMIN","tenantId":"pb.amritsar"},{"name":"EGF Bill ApproverEmployee","code":"EGF_BILL_APPROVEREMPLOYEE","tenantId":"pb.amritsar"},{"name":"BPAREG doc verifierEmployee","code":"BPAREG_DOC_VERIFIEREMPLOYEE","tenantId":"pb.amritsar"},{"name":"BPATL StructuralCounter EngineerEmployee","code":"BPATL_STRUCTURALENGINEERCEMP","tenantId":"pb.amritsar"},{"name":"Redressal OfficerCommissioner","code":"ROCOMMISSIONER","tenantId":"pb.amritsar"},{"name":"CollectionTL Report ViewerCreator","code":"COLLTL_REP_VIEWCREATOR","tenantId":"pb.amritsar"},{"name":"BPAEGF Bill EngineerApprover","code":"BPAEGF_BILL_ENGINEERAPPROVER","tenantId":"pb.amritsar"},{"name":"UniversalBPAREG Collectiondoc Employeeverifier","code":"UCBPAREG_DOC_EMPVERIFIER","tenantId":"pb.amritsar"},{"name":"FSMBPA FSTPStructural OpperatorEngineer","code":"FSMBPA_EMP_FSTPOSTRUCTURALENGINEER","tenantId":"pb.amritsar"},{"name":"BPARedressal Services verifierOfficer","code":"BPA_VERIFIERRO","tenantId":"pb.amritsar"},{"name":"StateCollection Report AdministratorViewer","code":"STADMINCOLL_REP_VIEW","tenantId":"pb.amritsar"},{"name":"PTBPA Counter ApproverEngineer","code":"PTBPA_APPROVERENGINEER","tenantId":"pb.amritsar"},{"name":"NoCUniversal FieldCollection InpectorEmployee","code":"NOCUC_FIELD_INSPECTOREMP","tenantId":"pb.amritsar"},{"name":"GrievanceFSM FSTP OfficerOpperator","code":"GOFSM_EMP_FSTPO","tenantId":"pb.amritsar"},{"name":"FSMBPA EmployeeServices Application Creatorverifier","code":"FSMBPA_CREATOR_EMPVERIFIER","tenantId":"pb.amritsar"},{"name":"WSState ClerkAdministrator","code":"WS_CLERKSTADMIN","tenantId":"pb.amritsar"},{"name":"NoCPT DocCounter VerifierApprover","code":"NOCPT_DOC_VERIFIERAPPROVER","tenantId":"pb.amritsar"},{"name":"AutoNoC EscalationField EmployeeInpector","code":"AUTONOC_FIELD_ESCALATEINSPECTOR","tenantId":"pb.amritsar"},{"name":"WSGrievance Document VerifierOfficer","code":"WS_DOC_VERIFIERGO","tenantId":"pb.amritsar"},{"name":"FSM Employee ReportApplication ViewerCreator","code":"FSM_REPORTCREATOR_VIEWEREMP","tenantId":"pb.amritsar"},{"name":"AssetCreatorWS Clerk","code":"AssetCreatorWS_CLERK","tenantId":"pb.amritsar"},{"name":"BPANoC Doc ArchitectVerifier","code":"BPANOC_DOC_ARCHITECTVERIFIER","tenantId":"pb.amritsar"},{"name":"TLAuto Escalation ApproverEmployee","code":"TLAUTO_APPROVERESCALATE","tenantId":"pb.amritsar"},{"name":"PGRWS AdministratorDocument Verifier","code":"PGR-ADMINWS_DOC_VERIFIER","tenantId":"pb.amritsar"},{"name":"BPAFSM Employee TownReport PlannerViewer","code":"BPAFSM_REPORT_TOWNPLANNERVIEWER","tenantId":"pb.amritsar"},{"name":"Field EmployeeAssetCreator","code":"FEMPAssetCreator","tenantId":"pb.amritsar"},{"name":"PTISBPA AdminArchitect","code":"PTISBPA_ADMINARCHITECT","tenantId":"pb.amritsar"},{"name":"BPATL SupervisorApprover","code":"BPATL_SUPERVISORAPPROVER","tenantId":"pb.amritsar"},{"name":"FSMPGR Payment CollectorAdministrator","code":"FSM_COLLECTORPGR-ADMIN","tenantId":"pb.amritsar"},{"name":"BPAREGBPA Town ApproverPlanner","code":"BPAREGBPA_APPROVERTOWNPLANNER","tenantId":"pb.amritsar"},{"name":"FSMField Employee Application Editor","code":"FSM_EDITOR_EMPFEMP","tenantId":"pb.amritsar"},{"name":"TLPTIS doc verifierAdmin","code":"TLPTIS_DOC_VERIFIERADMIN","tenantId":"pb.amritsar"},{"name":"FSM Employee Application ViewerBPA Supervisor","code":"FSMBPA_VIEW_EMPSUPERVISOR","tenantId":"pb.amritsar"},{"name":"PTISFSM Payment MasterCollector","code":"PTISFSM_MASTERCOLLECTOR","tenantId":"pb.amritsar"},{"name":"FSMBPAREG Desluding OperatorApprover","code":"FSMBPAREG_DSOAPPROVER","tenantId":"pb.amritsar"},{"name":"TL AdminFSM Employee Application Editor","code":"TLFSM_EDITOR_ADMINEMP","tenantId":"pb.amritsar"},{"name":"SWTL Fielddoc Inspectorverifier","code":"SWTL_FIELDDOC_INSPECTORVERIFIER","tenantId":"pb.amritsar"},{"name":"NoCFSM Employee counterApplication ApproverViewer","code":"NOCFSM_VIEW_APPROVEREMP","tenantId":"pb.amritsar"},{"name":"HRMSPTIS AdminMaster","code":"HRMSPTIS_ADMINMASTER","tenantId":"pb.amritsar"},{"name":"WSFSM Desluding ApproverOperator","code":"WSFSM_APPROVERDSO","tenantId":"pb.amritsar"},{"name":"SuperTL UserAdmin","code":"SUPERUSERTL_ADMIN","tenantId":"pb.amritsar"},{"name":"BPASW NOCField VerifierInspector","code":"BPASW_NOCFIELD_VERIFIERINSPECTOR","tenantId":"pb.amritsar"},{"name":"FSMNoC Employeecounter Dashboard ViewerApprover","code":"FSMNOC_DASHBOARD_VIEWERAPPROVER","tenantId":"pb.amritsar"},{"name":"SystemHRMS userAdmin","code":"SYSTEMHRMS_ADMIN","tenantId":"pb.amritsar"},{"name":"SWWS Approver","code":"SWWS_APPROVER","tenantId":"pb.amritsar"},{"name":"GrivanceSuper AdministratorUser","code":"GASUPERUSER","tenantId":"pb.amritsar"}],{"name":"BPA NOC Verifier","activecode":true"BPA_NOC_VERIFIER","tenantId":"pb.amritsar"},{"permanentCityname":null}"FSM Employee Dashboard Viewer","msgIdcode":"1657020371949|en_INFSM_DASHBOARD_VIEWER","plainAccessRequesttenantId":{}}}' \
  --compressed

Hooks/Utils Used:

  1. To Download a bill → A util function named downloadBill is used which is defined in this file

https://github.com/egovernments/DIGIT-Dev/blob/db572b868bad5af8564452606be4690c25041419/frontend/micro-ui/web/micro-ui-internals/packages/libraries/src/utils/pdf.js

This util function is inside Digit Utils hence it can be called anywhere throughout the application like this Digit.Utils.downloadBill(consumerCode, businessService, "consolidatedreceipt")

2. To Search a bill → A hook named useBillSearch is used to search bills which is defined in this file

https://github.com/egovernments/DIGIT-Dev/blob/b24905db78ba453cfdb606cf8069cde0e5025de6/frontend/micro-ui/web/micro-ui-internals/packages/libraries/src/hooks/bills/useBillSearch.js

3. To fetch the data for service Category dropdown → A hook named useCommonMDMS is used to fetch this data. This hook is called with the following parameters:

Digit.Hooks.useCommonMDMS(tenantId, "BillingService", "BillsGenieKey");

Technical implementation of this hook can be found here:

...

"pb.amritsar"},{"name":"System user","code":"SYSTEM","tenantId":"pb.amritsar"},{"name":"SW Approver","code":"SW_APPROVER","tenantId":"pb.amritsar"},{"name":"Grivance Administrator","code":"GA","tenantId":"pb.amritsar"}],"active":true,"tenantId":"pb.amritsar","permanentCity":null},"msgId":"1657020371949|en_IN","plainAccessRequest":{}}}' \
  --compressed

APIs Used:

API Endpoint

API description

Employee Roles

egov-searcher/bill-genie/billswithaddranduser/_get

→ To search bills

→ Returns a list of bills according to the search criteria

Employee ,Bill Genie Employee

/egov-pdf/download/BILL/consolidatedbill

→ To download bills according to the search criteria

→ Returns a pdf file

Employee, Bill Genie Employee