Skip to content

Commit d128bec

Browse files
nooobcodernooobcoder
committed
Add API Route Table
1 parent 5056f66 commit d128bec

File tree

2 files changed

+141
-1
lines changed

2 files changed

+141
-1
lines changed

‎Readme.md

Lines changed: 140 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -286,6 +286,146 @@ Please [import](https://learning.postman.com/docs/getting-started/importing-and-
286286

287287
1. <a href="Track%204_ReactJS_Web%20Development/Project/Postman%20Collection/HighradiusWinterInternship.postman_collection.json" target="_blank">API Endpoint Folder</a>
288288
2. <a href="Track%204_ReactJS_Web%20Development/Project/Postman%20Collection/HighRadius%20Training.postman_environment.json" target="_blank">Environment Variables</a>
289+
290+
**API Route Table**
291+
292+
<table class="table table-striped table-bordered">
293+
<thead>
294+
<tr>
295+
<th>Service</th>
296+
<th>Request Name</th>
297+
<th>Request Type</th>
298+
<th>Request Endpoint</th>
299+
<th>URL Parameters</th>
300+
<th>JSON Body</th>
301+
<th>Description</th>
302+
<th>CURL Equivalent</th>
303+
</tr>
304+
</thead>
305+
<tbody>
306+
<tr>
307+
<td>Servlets</td>
308+
<td>GET ROWS</td>
309+
<td>POST</td>
310+
<td><a href="http://192.168.0.118:280/getrows">http://192.168.0.118:280/getrows</a></td>
311+
<td>?start=0&amp;limit=10</td>
312+
<td></td>
313+
<td>Gets the rows from start to the next limit rows</td>
314+
<td>curl --location --request POST ’<a href="http://192.168.0.118:280//getrows?start=0&amp;limit=10">http://192.168.0.118:280//getrows?start=0&amp;limit=10</a>’ \ --header ‘Content-Type: application/json’</td>
315+
</tr>
316+
<tr>
317+
<td>Servlets</td>
318+
<td>GET ANALYTICS</td>
319+
<td>POST</td>
320+
<td><a href="http://192.168.0.118:280/getanalytics">http://192.168.0.118:280/getanalytics</a></td>
321+
<td></td>
322+
<td>{ “clear_date”: [ “2019-01-01”, “2020-12-31” ], “due_in_date”: [ “2019-01-01”, “2020-12-31” ], “baseline_create_date”: [ “2019-01-01”, “2020-12-31” ], “invoice_currency”: “INR” }</td>
323+
<td>Returns an array with analytics data. Refer JSON body</td>
324+
<td>curl --location --request POST ’<a href="http://192.168.0.118:280//getanalytics">http://192.168.0.118:280//getanalytics</a>’ \ --header ‘Content-Type: application/json’ \ --data-raw ‘{ “clear_date”: [ “2019-01-01”, “2020-12-31” ], “due_in_date”: [ “2019-01-01”, “2020-12-31” ], “baseline_create_date”: [ “2019-01-01”, “2020-12-31” ], “invoice_currency”: “INR” }’</td>
325+
</tr>
326+
<tr>
327+
<td>Servlets</td>
328+
<td>ADD ROWS</td>
329+
<td>POST</td>
330+
<td><a href="http://192.168.0.118:280/addRow">http://192.168.0.118:280/addRow</a></td>
331+
<td></td>
332+
<td>{ “sl_no”:48558, “business_code”: null, “cust_number”: “200020431”, “name_customer”:“test company”, “clear_date”: “2022-3-1”, “business_year”: null, “doc_id”: null, “posting_date”: “2022-3-1”, “document_create_date”: “2022-3-2”, “document_create_date1”: null, “due_in_date”: “2022-3-19”, “invoice_currency”: “”, “document_type”: null, “posting_id”: null, “area_business”: null, “total_open_amount”: null, “baseline_create_date”: “2022-3-15”, “cust_payment_terms”: null, “invoice_id”: null, “isOpen”: null, “aging_bucket”: null }</td>
333+
<td>Adds the rows that is passed as JSON raw body</td>
334+
<td>curl --location --request POST ’<a href="http://192.168.0.118:280//addRow">http://192.168.0.118:280//addRow</a>’ \ --header ‘Content-Type: application/json’ \ --data-raw ‘{ “sl_no”:48558, “business_code”: null, “cust_number”: “200020431”, “name_customer”:“test company”, “clear_date”: “2022-3-1”, “business_year”: null, “doc_id”: null, “posting_date”: “2022-3-1”, “document_create_date”: “2022-3-2”, “document_create_date1”: null, “due_in_date”: “2022-3-19”, “invoice_currency”: “”, “document_type”: null, “posting_id”: null, “area_business”: null, “total_open_amount”: null, “baseline_create_date”: “2022-3-15”, “cust_payment_terms”: null, “invoice_id”: null, “isOpen”: null, “aging_bucket”: null }’</td>
335+
</tr>
336+
<tr>
337+
<td>Servlets</td>
338+
<td>ADVANCED SEARCH</td>
339+
<td>POST</td>
340+
<td><a href="http://192.168.0.118:280/advancedSearch">http://192.168.0.118:280/advancedSearch</a></td>
341+
<td></td>
342+
<td>{ “doc_id”: 1929873765, “invoice_id”: 1929873765, “cust_number”: 200792734, “business_year”: 2019 }</td>
343+
<td>Performs advanced search with the fields passed. Refer PRS and JSON body for example.</td>
344+
<td>curl --location --request POST ’<a href="http://192.168.0.118:280//advancedSearch">http://192.168.0.118:280//advancedSearch</a>’ \ --header ‘Content-Type: application/json’ \ --data-raw ‘{ “doc_id”: 1929873765, “invoice_id”: 1929873765, “cust_number”: 200792734, “business_year”: 2019 }’</td>
345+
</tr>
346+
<tr>
347+
<td>Servlets</td>
348+
<td>GET BUSINESSES</td>
349+
<td>GET</td>
350+
<td><a href="http://192.168.0.118:280/getbusinesses">http://192.168.0.118:280/getbusinesses</a></td>
351+
<td></td>
352+
<td></td>
353+
<td>Returns the businesses with their codes in the database.</td>
354+
<td>curl --location --request GET ’<a href="http://192.168.0.118:280//getbusinesses">http://192.168.0.118:280//getbusinesses</a>’</td>
355+
</tr>
356+
<tr>
357+
<td>Servlets</td>
358+
<td>GET CUSTOMERS</td>
359+
<td>GET</td>
360+
<td><a href="http://192.168.0.118:280/getcustomers">http://192.168.0.118:280/getcustomers</a></td>
361+
<td></td>
362+
<td></td>
363+
<td>Returns the customers with their codes in the database.</td>
364+
<td>curl --location --request GET ’<a href="http://192.168.0.118:280/getcustomers">http://192.168.0.118:280/getcustomers</a>’</td>
365+
</tr>
366+
<tr>
367+
<td>Servlets</td>
368+
<td>EDIT ROW</td>
369+
<td>POST</td>
370+
<td><a href="http://192.168.0.118:280/editRow">http://192.168.0.118:280/editRow</a></td>
371+
<td>?serialNumber=2&amp;tableName=winter_internship</td>
372+
<td>{ “invoice_currency”: “USD”, “cust_payment_terms”: “NAA8” }</td>
373+
<td>Edits a row by sending a RAW JSON body</td>
374+
<td>curl --location --request POST ’<a href="http://192.168.0.118:280//editRow?serialNumber=2&amp;tableName=winter_internship">http://192.168.0.118:280//editRow?serialNumber=2&amp;tableName=winter_internship</a>’ \ --header ‘Content-Type: application/json’ \ --data-raw ‘{ “invoice_currency”: “USD”, “cust_payment_terms”: “NAA8” }’</td>
375+
</tr>
376+
<tr>
377+
<td>Servlets</td>
378+
<td>DELETE ETEROW</td>
379+
<td>DELETE</td>
380+
<td><a href="http://192.168.0.118:280/deleteRow">http://192.168.0.118:280/deleteRow</a></td>
381+
<td>?sl_no=48568,48569,48570</td>
382+
<td></td>
383+
<td>Deletes a row or a range of rows</td>
384+
<td>curl --location --request DELETE ’<a href="http://192.168.0.118:280//deleteRow?sl_no=48568,'">http://192.168.0.118:280//deleteRow?sl_no=48568,’</a> \ --header ‘Content-Type: application/json’ \ --data-raw ‘’</td>
385+
</tr>
386+
<tr>
387+
<td>Flask</td>
388+
<td>GET PREDICTION</td>
389+
<td>POST</td>
390+
<td><a href="http://192.168.0.118:5000/get_prediction">http://192.168.0.118:5000/get_prediction</a></td>
391+
<td></td>
392+
<td>{ “data”: [ 1929646410, 1929873765, 1930147974, 1930083373, 1930659387, 1929439637, 1928819386, 1930610806, 1928550622, 1929151655, 1930022117, 1930788296, 1930817482, 1930052739, 1930209407, 1930153511, 1930438462, 1991837617, 1929773400, 1930676042, 1929626925, 1930431304, 1928620435, 1930592246, 1929194820, 1929170780, 1929907681, 1929847863, 1929541405, null ] }</td>
393+
<td>Does prediction on the array of doc ids passed to it.</td>
394+
<td>curl --location --request POST ’<a href="http://192.168.0.118:5000/get_prediction">http://192.168.0.118:5000/get_prediction</a>’ \ --header ‘Content-Type: application/json’ \ --data-raw ‘{ “data”: [ 1929646410, 1929873765, 1930147974, 1930083373, 1930659387, 1929439637, 1928819386, 1930610806, 1928550622, 1929151655, 1930022117, 1930788296, 1930817482, 1930052739, 1930209407, 1930153511, 1930438462, 1991837617, 1929773400, 1930676042, 1929626925, 1930431304, 1928620435, 1930592246, 1929194820, 1929170780, 1929907681, 1929847863, 1929541405, null ] }’</td>
395+
</tr>
396+
<tr>
397+
<td>Flask</td>
398+
<td>PREDICT 200 ROWS</td>
399+
<td>POST</td>
400+
<td><a href="http://192.168.0.118:5000/all">http://192.168.0.118:5000/all</a></td>
401+
<td></td>
402+
<td></td>
403+
<td>Gets prediction of first 200 rows from Final.csv. This is for debugging purpose only that the flask service works.</td>
404+
<td>curl --location --request POST ’<a href="http://192.168.0.118:5000/all">http://192.168.0.118:5000/all</a>’</td>
405+
</tr>
406+
<tr>
407+
<td></td>
408+
<td></td>
409+
<td></td>
410+
<td></td>
411+
<td></td>
412+
<td></td>
413+
<td></td>
414+
<td></td>
415+
</tr>
416+
<tr>
417+
<td></td>
418+
<td></td>
419+
<td></td>
420+
<td></td>
421+
<td></td>
422+
<td></td>
423+
<td></td>
424+
<td></td>
425+
</tr>
426+
</tbody>
427+
</table>
428+
289429
---
290430

291431
## HighRadius Training Details

‎Track 4_ReactJS_Web Development/Project/Backend/API/demo/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<dependency>
4646
<groupId>com.fasterxml.jackson.core</groupId>
4747
<artifactId>jackson-databind</artifactId>
48-
<version>2.13.2</version>
48+
<version>2.13.2.1</version>
4949
</dependency>
5050
</dependencies>
5151

0 commit comments

Comments
 (0)