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/07/12 10:00 (6 years ago)] – gking_windwardsoftware.com | webapi_swagger_documentation [2018/09/20 11:35 (6 years ago)] – [Getting The Swagger 2.0 Documentation Into editor2.swagger.io] jdayanan | ||
---|---|---|---|
Line 10: | Line 10: | ||
===== Endpoints ===== | ===== Endpoints ===== | ||
- | 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.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: |
- APBill | - APBill | ||
- Category | - Category | ||
Line 20: | Line 20: | ||
- Vendors | - Vendors | ||
- VirtualInventory | - VirtualInventory | ||
- | - TServerMethodsWebAPI | + | - TServerMethodsWebAPI |
All of these endpoints can be accessed with either of the following URLs: | All of these endpoints can be accessed with either of the following URLs: | ||
Line 26: | Line 26: | ||
* http:// | * http:// | ||
- | ===== Known limitations | + | ==== Deprecated Methods ==== |
+ | |||
+ | As of the 6.2.7 Beta the following methods in the endpoint TServerMethodsWebAPI were deprecated: | ||
+ | - Customers_Insert | ||
+ | - Customer_Read | ||
+ | - Customers_Update | ||
+ | - Get_Customers | ||
+ | - List_Customers | ||
+ | - Parts_Read | ||
+ | - Parts_Update | ||
+ | - Get_Parts | ||
+ | - List_Parts | ||
+ | - Insert_Parts | ||
+ | - Get_Main_Categories | ||
+ | - Get_Categories | ||
+ | - Suppliers_Insert | ||
+ | - Suppliers_Read | ||
+ | - Suppliers_Update | ||
+ | - Get_Suppliers | ||
+ | - List_Suppliers | ||
+ | - Invoices_Insert | ||
+ | - Invoices_Get | ||
+ | - Invoices_Update | ||
+ | - Invoices_Read | ||
+ | - Insert_Full_Invoice | ||
+ | - Insert_AP_Bill | ||
+ | |||
+ | Replacement methods for these newly deprecated methods can be found within the other endpoints. | ||
+ | |||
+ | ===== 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 and is now limited by how much available memory is on the server or workstation running the API. | 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 and is now limited by how much available memory is on the server or workstation running the API. | ||
+ | |||
+ | Due to the JSON parser that the Windward Web API uses, any ' | ||
===== Retrieving The Documentation ===== | ===== Retrieving The Documentation ===== | ||
Line 35: | Line 67: | ||
* http:// | * http:// | ||
- | The contents of the response from the calls is the Swagger 2.0 documentation, | + | The contents of the response from the calls is the Swagger 2.0 documentation, |
After configuring your S5WebAPISvc.ini, | After configuring your S5WebAPISvc.ini, | ||
Line 50: | 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: | ||
- | * [[http://editor2.swagger.io|editor2.swagger.io]] | + | * [[http://editor.swagger.io|editor.swagger.io]] |
- Click on the ' | - Click on the ' | ||
- Click on 'Paste JSON'. | - Click on 'Paste JSON'. |
webapi_swagger_documentation.txt · Last modified: 2022/02/23 13:40 (2 years ago) by kevin