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 [2020/05/04 06:09 (4 years ago)] – [Beta 6.2.7.x History] raguilo | webapi_swagger_documentation [2020/05/25 11:25 (4 years ago)] – kevin | ||
---|---|---|---|
Line 59: | Line 59: | ||
===== Known Limitations ===== | ===== Known Limitations ===== | ||
- | Prior to 6.2.2.175 released versions of the Web API had a maximum limit of 32 concurrent connections. This limit has been removed and is now limited by how much available memory (max 4GB as this is a 32 bit service) running the API. | + | Prior to 6.2.2.175 released versions of the Web API had a maximum limit of 32 concurrent connections. This limit has been removed and is now limited by how much available memory (max 4GB as this is a 32-bit service) running the API. |
- | + | ||
- | <note tip> | + | |
- | Due to the JSON parser that the Windward Web API uses, any ' | + | |
- | </ | + | |
===== Retrieving The Documentation ===== | ===== Retrieving The Documentation ===== | ||
Line 122: | Line 118: | ||
===== What Version are you using? ===== | ===== What Version are you using? ===== | ||
Depending on the feature you may be looking for in an endpoint you may need to know what version you are running. | Depending on the feature you may be looking for in an endpoint you may need to know what version you are running. | ||
- | It is not uncommon | + | It is common |
* http:// | * http:// | ||
Line 227: | Line 223: | ||
===== Beta 6.2.7.x History ===== | ===== Beta 6.2.7.x History ===== | ||
There can be functionality available in our beta that will not be present in our released product. | There can be functionality available in our beta that will not be present in our released product. | ||
+ | |||
* Version 6.2.7.562 – April 28, 2020 | * Version 6.2.7.562 – April 28, 2020 | ||
- | * [ TFS 34807 ] Fix for / | + | * [ TFS 34807 ] Fix for / |
* Version 6.2.7.530 – March 25, 2020 | * Version 6.2.7.530 – March 25, 2020 | ||
* [ TFS 33670 / 58200 ] Web API Fix: eCommerceExport=Y filter was not working for / | * [ TFS 33670 / 58200 ] Web API Fix: eCommerceExport=Y filter was not working for / | ||
Line 275: | Line 272: | ||
* Version 6.2.7.157 – February 28, 2019 | * Version 6.2.7.157 – February 28, 2019 | ||
* [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill endpoints to eliminate calls that exceed the maximum number of records that the S5WebAPISvc can handle. | * [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill endpoints to eliminate calls that exceed the maximum number of records that the S5WebAPISvc can handle. | ||
+ | |||
+ | ===== Common Errors/ | ||
+ | |||
+ | ** Getting POS Failure! {" | ||
+ | |||
+ | Reasons : | ||
+ | The JSON that is being used is invalid. | ||
+ | |||
+ | Only 1 InvoiceLines Array is allowed. | ||
+ | The Description must only have 255 characters MAXIMUM! The database will throw away anything longer. | ||
+ | The Invoice Comment must not contain invalid characters. (Carriage Returns and Line Feeds) | ||
+ | |||
+ | Additional information: | ||
+ | You do not need to include the InvoiceCustomer / InvoiceShipTo unique numbers AND the InvoiceShipping / InvoiceBilling | ||
+ | One or the other is all that is required. If you know the Unique Numbers, use them. The system will ignore the InvoiceShipping and InvoiceBilling data. | ||
+ | If you don’t, then use the InvoiceShipping and InvoiceBilling. The system will look-up the Account records or create them. | ||
+ | |||
+ | Here is what is should look like: | ||
+ | < | ||
+ | { | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | }, | ||
+ | { | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | ] | ||
+ | } | ||
+ | ], | ||
+ | " | ||
+ | " | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | You can prevent all of these problems by simply checking the JSON payload in a JSON editor like: | ||
+ | https:// | ||
+ | |||
+ | |||
+ | |||
+ | ** Adding Newline Feed on Invoice Comment ** | ||
+ | |||
+ | In /addInvoice method, you can add Invoice Comment. In the parameter, look for this field " | ||
+ | |||
+ | To add a new line feed, add this \\n in the comment. | ||
+ | |||
+ | ** Access Violation when making API call ** | ||
+ | |||
+ | When troubleshooting the s5webAPI if receiving an access violation when making and API call, XML may require re-installation. | ||
webapi_swagger_documentation.txt · Last modified: 2022/02/23 13:40 (2 years ago) by kevin