webapi_swagger_documentation
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
webapi_swagger_documentation [2018/09/20 11:35 (6 years ago)] – [Retrieving The Documentation] jdayanan | webapi_swagger_documentation [2019/01/30 12:10 (5 years ago)] – kevin | ||
---|---|---|---|
Line 2: | Line 2: | ||
===== Summary ===== | ===== Summary ===== | ||
- | Our Web API solution runs as a service and provides a doorway to push and pull information from a System Five database. | + | Our s5webAPI |
- | The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward | + | The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward |
- | + | ||
- | <note important> | + | |
===== Endpoints ===== | ===== Endpoints ===== | ||
- | As of the 6.2.7 Beta there are multiple endpoints available for the Windward Web API each providing different functions for the Web API. These endpoints are the following: | + | As of the 6.2.2.175 there are multiple endpoints available for the Windward Web API each providing different functions for the S5WebAPI. These endpoints are the following: |
- APBill | - APBill | ||
- Category | - Category | ||
Line 28: | Line 26: | ||
==== Deprecated Methods ==== | ==== Deprecated Methods ==== | ||
- | As of the 6.2.7 Beta the following methods in the endpoint TServerMethodsWebAPI | + | As of the 6.2.2.175 the following methods in the endpoint TServerMethodsWebAPI |
- Customers_Insert | - Customers_Insert | ||
- Customer_Read | - Customer_Read | ||
Line 52: | Line 50: | ||
- Insert_Full_Invoice | - Insert_Full_Invoice | ||
- Insert_AP_Bill | - Insert_AP_Bill | ||
- | + | < | |
- | Replacement | + | Any new software development should make use of new methods found within |
+ | </ | ||
===== Known Limitations ===== | ===== Known Limitations ===== | ||
- | The 6.2.2 released versions of the Web API has a maximum limit of 32 concurrent connections. This limit has been removed in the 6.2.7 beta version | + | Prior to 6.2.2.175 released versions of the Web API has a maximum limit of 32 concurrent connections. This limit has been removed in the 6.2.2.175 and is now limited by how much available memory is on the server or workstation running the API. |
+ | <note tip> | ||
Due to the JSON parser that the Windward Web API uses, any ' | Due to the JSON parser that the Windward Web API uses, any ' | ||
+ | </ | ||
===== Retrieving The Documentation ===== | ===== Retrieving The Documentation ===== | ||
Line 82: | Line 82: | ||
- Copy the complete text in the Response area and save it as a text file. | - Copy the complete text in the Response area and save it as a text file. | ||
- | ==== Getting The Swagger 2.0 Documentation Into editor2.swagger.io ==== | + | ==== Getting The Swagger 2.0 Documentation Into editor.swagger.io ==== |
- Open the json file in a text editor and copy the contents to your clipboard | - Open the json file in a text editor and copy the contents to your clipboard | ||
- Open a web browser (Google Chrome, for example) and navigate to the following URL: | - Open a web browser (Google Chrome, for example) and navigate to the following URL: |
webapi_swagger_documentation.txt · Last modified: 2022/02/23 13:40 (2 years ago) by kevin