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 [2019/12/03 06:12 (4 years ago)] – [Release 6.2.2.x History] raguilo | webapi_swagger_documentation [2020/07/07 12:16 (4 years ago)] – [Common Errors/Issues] kevin | ||
---|---|---|---|
Line 2: | Line 2: | ||
===== Summary ===== | ===== Summary ===== | ||
- | The s5webAPI solution runs as a 32 bit service and provides a doorway to push and pull information from a System Five database. | + | The s5webAPI solution runs as a 32-bit service and provides a doorway to push and pull information from a System Five database. |
- | The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward S5WebAPI. | + | The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward S5WebAPI. |
- | As a developer, keep in mind since this is a 32 bit service, it will not be able to access more than [[https:// | + | As a developer, keep in mind since this is a 32-bit service, it will not be able to access more than [[https:// |
<note important> | <note important> | ||
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 70: | Line 66: | ||
* http:// | * http:// | ||
- | The contents of the response from the calls is the Swagger 2.0 documentation, | + | The contents of the response from the calls are the Swagger 2.0 documentation, |
- | After configuring | + | You can also turn on " |
+ | ==== Interacting With The Swagger 2.0 Documentation Via A Browser ==== | ||
+ | - As of release 6.2.2.179 Swagger 2.0 documentation can be viewed and interacted with through a browser. | ||
+ | - Using a set of options in the S5WebAPISvc.ini file, the configuration of the **Swagger Publishing** can be set and changed. | ||
+ | - {{: | ||
+ | - Once the S5WebAPISvc.ini options have been set, and the WebAPI service is running, open a web browser and enter localhost: | ||
+ | - Where PORT is the port under the Swagger Publishing options in S5WebAPISvc.ini | ||
+ | - After entering the WebAPI credentials and clicking the ' | ||
+ | - On this page, edit the contents of the search/ | ||
+ | - PORT is the port that the WebAPI is listening on (specified in S5WebAPISvc.ini, | ||
+ | - ENDPOINT is any one of the endpoints of the WebAPI. | ||
+ | - After clicking on the ' | ||
+ | - Once authorized the Swagger 2.0 documentation and WebAPI service can be interacted with. | ||
+ | - By clicking on an API method, the page will show more information for the method. | ||
+ | - Clicking the 'Try It Out' button allows users to enter parameters, and run the method. | ||
+ | - Clicking the ' | ||
+ | < | ||
+ | </ | ||
==== Getting The Swagger 2.0 Documentation Using Postman ==== | ==== Getting The Swagger 2.0 Documentation Using Postman ==== | ||
- | - Open Postman. | + | - Open [[https:// |
- Set the request type to GET. | - Set the request type to GET. | ||
- Enter one of the URLs, substituting the API_IP_ADDRESS, | - Enter one of the URLs, substituting the API_IP_ADDRESS, | ||
Line 92: | Line 105: | ||
- In the Swagger 2.0 documentation dialog Right click and choose Paste from your clipboard | - In the Swagger 2.0 documentation dialog Right click and choose Paste from your clipboard | ||
- Click on ' | - Click on ' | ||
- | - The list of available methods | + | - The list of available methods |
{{: | {{: | ||
- | |||
- | ==== Interacting With The Swagger 2.0 Documentation Via A Browser ==== | ||
- | - As of release 6.2.2.179 Swagger 2.0 documentation can be viewed and interacted with through a browser. | ||
- | - Using a set of options in the S5WebAPISvc.ini file, the configuration of the Swagger publishing can be set and changed. | ||
- | - {{: | ||
- | - Once the S5WebAPISvc.ini options have been set, and the WebAPI service is running, open a web browser and enter localhost: | ||
- | - Where PORT is the port under the Swagger Publishing options in S5WebAPISvc.ini | ||
- | - After entering the WebAPI credentials and clicking the ' | ||
- | - On this page, edit the contents of the search/ | ||
- | - PORT is the port that the WebAPI is listening on (specified in S5WebAPISvc.ini, | ||
- | - ENDPOINT is any one of the endpoints of the WebAPI. | ||
- | - After clicking on the ' | ||
- | - Once authorized the Swagger 2.0 documentation and WebAPI service can be interacted with. | ||
- | - By clicking on an API method, the page will show more information for the method. | ||
- | - Clicking the 'Try It Out' button allows users to enter parameters, and run the method. | ||
- | - Clicking the ' | ||
===== Samples | ===== Samples | ||
- | * [[webapi: | + | |
+ | * [[webapi: | ||
+ | | ||
+ | * [[webapi: | ||
===== 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 126: | Line 125: | ||
" | " | ||
</ | </ | ||
+ | |||
+ | |||
+ | ===== Release 6.2.4.x History ===== | ||
+ | * Version 6.2.4.10 – April 2, 2020 | ||
+ | * [ TFS 33670 / 58200 ] Web API Fix: eCommerceExport=Y filter was not working for / | ||
+ | |||
===== Release 6.2.2.x History ===== | ===== Release 6.2.2.x History ===== | ||
- | * Version 6.2.2.517 – October 29, 2019 | + | * Version 6.2.2.636 – March 12, 2020 |
- | * [TFS 20705] Fix for S5WebAPISvc that got broken due to new data collector list load. | + | * [ TFS 32447 / 58176 ] The Inventory/ End Point methods now accepts a Department Parameter |
+ | * Version 6.2.2.632 – March 12, 2020 | ||
+ | * TFS 32056 / 58157 ] Corrected the Insert of new Inventory by the S5WebAPISvc to deal with situations where the Item, Part and Supplier Part are all different in a data set. This is not a typical configuration and the system was not handling the lookup of the Virtual Warehouse records correctly in this specific configuration. | ||
+ | * Version 6.2.2.631 – March 3, 2020 | ||
+ | * TFS 31638 Updated S5WebAPI Invoice endpoint to accept invoice line comments. | ||
+ | * Version 6.2.2.596 – January 30, 2020 | ||
+ | * [ TFS 17171 / 57749 ] Fix on / | ||
+ | * Version 6.2.2.546 – December 2, 2019 | ||
+ | * [TFS 22644 / 57862] Corrected the way Tax Areas are assigned when using the deprecated / | ||
* Version 6.2.2.540 – November 26, 2019 | * Version 6.2.2.540 – November 26, 2019 | ||
* [TFS 19490 / BZ 57767] Added Web Comment support to the / | * [TFS 19490 / BZ 57767] Added Web Comment support to the / | ||
+ | * Version 6.2.2.536 – November 20, 2019 | ||
+ | * [BZ 57751 / TFS 19694] Corrected the cause of the crashing by preventing the API from returning all of the invoices when the ZERO parameter is passed. The API now returns nothing in that case. Added 2 new methods to address the need to obtain more than one invoice from the API in a single call. | ||
+ | * Version 6.2.2.535 – November 20, 2019 | ||
+ | * [57691/TFS 19695] Two new endpoints have been added to the S5WebAPI to provide faster and more efficient access to the information provided by the Record State Tracking feature. | ||
+ | * GET [[webapi: | ||
+ | * GET [[webapi: | ||
* Version 6.2.2.517 – October 29, 2019 | * Version 6.2.2.517 – October 29, 2019 | ||
* [TFS 20705] Fix for S5WebAPISvc that was broken due to new data collector list load. | * [TFS 20705] Fix for S5WebAPISvc that was broken due to new data collector list load. | ||
Line 138: | Line 157: | ||
* [57690] Updated the logging to Log Analytics to better report the start and finish of each API call. | * [57690] Updated the logging to Log Analytics to better report the start and finish of each API call. | ||
* Version 6.2.2.441 – July 15, 2019 | * Version 6.2.2.441 – July 15, 2019 | ||
- | * [57554] Corrected a problem in the \addInvoice method of the S5WebAPISvc' | + | * [57554] Corrected a problem in the \addInvoice method of the S5WebAPISvc' |
* Version 6.2.2.400 – June 10, 2019 | * Version 6.2.2.400 – June 10, 2019 | ||
- | * [57332] Added KitType, Weight, Instock by Dept, SaleStart, SaleEnd, AltSuply, and Barcodes information to the GET / | + | * [57332] Added KitType, Weight, Instock by Dept, SaleStart, SaleEnd, AltSuply, and Barcodes information to the GET / |
+ | * [56751] The ability to populate Alt Supply records and Barcode records is now supported in the GET /Inventory endpoint. | ||
+ | * AltSupply: | ||
+ | * Barcodes: This is a structure that must be populated in order to create the desired record and association with the Inventory record. The Swagger documentation contains a complete and detailed model of the required fields and their purposes. | ||
* Version 6.2.2.395 – June 4, 2019 | * Version 6.2.2.395 – June 4, 2019 | ||
- | * [57350] The S5WebAPI / | + | * [57350] The S5WebAPI / |
- | * [57267] An e-Commerce filter has been added to the / | + | * [57267] An e-Commerce filter has been added to the / |
* [56767] Virtual Warehouse is now considered by the S5WebAPI and the behavior is consistent with System Five. | * [56767] Virtual Warehouse is now considered by the S5WebAPI and the behavior is consistent with System Five. | ||
* Version 6.2.2.369 – May 7, 2019 | * Version 6.2.2.369 – May 7, 2019 | ||
Line 150: | Line 172: | ||
* [56852] Added support for billing and shipping account lookup by account details with Invoice-AddInvoice endpoint for S5WebAPI. | * [56852] Added support for billing and shipping account lookup by account details with Invoice-AddInvoice endpoint for S5WebAPI. | ||
* Version 6.2.2.269 – February 14, 2019 | * Version 6.2.2.269 – February 14, 2019 | ||
- | * [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill end points | + | * [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill endpoints |
* Version 6.2.2.214 – November 30, 2018 | * Version 6.2.2.214 – November 30, 2018 | ||
* [56482] Found and solved a problem when the API is passed an invalid Department value. | * [56482] Found and solved a problem when the API is passed an invalid Department value. | ||
Line 156: | Line 178: | ||
* [56750] Removed the duplicate error from the Free Form information in the WebAPI for Polaris Integration. | * [56750] Removed the duplicate error from the Free Form information in the WebAPI for Polaris Integration. | ||
* Version 6.2.2.188 - September 4, 2018 | * Version 6.2.2.188 - September 4, 2018 | ||
- | * [56391] WebAPI: Fixed fields not geting | + | * [56391] WebAPI: Fixed fields not getting |
* [56404] WebAPI: Fixed errors when calling Insert_Invoice_Lines and Delete_Full_Invoice. | * [56404] WebAPI: Fixed errors when calling Insert_Invoice_Lines and Delete_Full_Invoice. | ||
* Version 6.2.2.183 | * Version 6.2.2.183 | ||
Line 167: | Line 189: | ||
* [56349] WebAPI: Fixed Get_Superseding_Parts to properly return an array of superseding parts. | * [56349] WebAPI: Fixed Get_Superseding_Parts to properly return an array of superseding parts. | ||
* Version 6.2.2.180 | * Version 6.2.2.180 | ||
- | * [56191] WebAPI: Added the Swagger-Publishing | + | * [56191] WebAPI: Added the Swagger-Publishing |
* Version 6.2.2.179 | * Version 6.2.2.179 | ||
* [56335] WebAPI: Port System Five WebAPI service (S5WebAPISvc) to Release. | * [56335] WebAPI: Port System Five WebAPI service (S5WebAPISvc) to Release. | ||
Line 174: | Line 196: | ||
* [56242] WebAPI: Added support to the Invoice endpoint for Keywords on Invoice Lines. | * [56242] WebAPI: Added support to the Invoice endpoint for Keywords on Invoice Lines. | ||
* [56268] WebAPI: Added Big Rock Quantity lookup to Part Find. | * [56268] WebAPI: Added Big Rock Quantity lookup to Part Find. | ||
- | * [55003] WebAPI: Solved the problems with the Change_Invoice_Type and Perform_Stock_Adjustment | + | * [55003] WebAPI: Solved the problems with the Change_Invoice_Type and Perform_Stock_Adjustment |
* Version 6.2.2.175 - August 08, 2018 | * Version 6.2.2.175 - August 08, 2018 | ||
* [56297] WebAPI: Get_Part_Prices call would now acknowledge the set Effective Date. | * [56297] WebAPI: Get_Part_Prices call would now acknowledge the set Effective Date. | ||
- | * Prior to 6.2.2.175 the Web API has 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 the Web API has 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. |
* Version 6.2.2.172 - July 24, 2018 | * Version 6.2.2.172 - July 24, 2018 | ||
* [55894] Web API: Fixed the Get_Customer_By_Email POST method. | * [55894] Web API: Fixed the Get_Customer_By_Email POST method. | ||
Line 184: | Line 206: | ||
* [54703] Web API: Fixed the Get_Parts POST method to return the list of linked Free Form Comments. | * [54703] Web API: Fixed the Get_Parts POST method to return the list of linked Free Form Comments. | ||
* Version 6.2.2.163 | * Version 6.2.2.163 | ||
- | * [55777] WebAPI: The Part Image fetch is now constrained to accept a single part unique at a time. This is required to prevent the API running out of memory trying to build a JSON object that contains 500KB of encoded data for the entire inventory file. It simply is not possible to create a JSON document that large. | + | * [55777] WebAPI: The Part Image fetch is now constrained to accept a single part unique at a time. This is required to prevent the API from running out of memory trying to build a JSON object that contains 500KB of encoded data for the entire inventory file. It simply is not possible to create a JSON document that large. |
* Version 6.2.2.161 | * Version 6.2.2.161 | ||
- | * [55898] WebAPI: The Customer, Supplier and Invoice List end points | + | * [55898] WebAPI: The Customer, Supplier, and Invoice List endpoints |
* Version 6.2.2.160 | * Version 6.2.2.160 | ||
* [55895] WebAPI: Fixed the Get_Parts POST method to return the list of linked Lookup Words. | * [55895] WebAPI: Fixed the Get_Parts POST method to return the list of linked Lookup Words. | ||
Line 197: | Line 219: | ||
* Version 6.2.2.148 | * Version 6.2.2.148 | ||
* [54977] The Inventory Value reporting is now exposed through the S5WebAPISvc. | * [54977] The Inventory Value reporting is now exposed through the S5WebAPISvc. | ||
+ | |||
+ | |||
===== 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 | ||
+ | * [ TFS 34807 ] Fix for / | ||
+ | * Version 6.2.7.530 – March 25, 2020 | ||
+ | * [ TFS 33670 / 58200 ] Web API Fix: eCommerceExport=Y filter was not working for / | ||
+ | * Version 6.2.7.524 – March 17, 2020 | ||
+ | * TFS 31638 Updated S5WebAPI Invoice endpoint to accept invoice line comments. | ||
+ | * Version 6.2.7.517 – March 11, 2020 | ||
+ | * [ TFS 32056 / 58157 ] Corrected the Insert of new Inventory by the S5WebAPISvc to deal with situations where the Item, Part and Supplier Part are all different in a data set. This is not a typical configuration and the system was not handling the lookup of the Virtual Warehouse records correctly in this specific configuration. | ||
+ | * [ TFS 32447 / 58176 ] The Inventory/ End Point methods now accepts a Department Parameter to reduce the volume of data returned by the API by limiting Stock, Price, and Sale Date information to the requested Department. It also matched the contents of the Returned Pricing to the object listed in the Swagger documentation. | ||
+ | * Version 6.2.7.425 – December 2, 2019 | ||
+ | * [TFS 22644 / 57862] Corrected the way Tax Areas are assigned when using the deprecated / | ||
* Version 6.2.7.396 – October 29, 2019 | * Version 6.2.7.396 – October 29, 2019 | ||
* [TFS 20705] Fix for S5WebAPISvc that got broken due to new data collector list load. | * [TFS 20705] Fix for S5WebAPISvc that got broken due to new data collector list load. | ||
* Version 6.2.7.418 – November 26, 2019 | * Version 6.2.7.418 – November 26, 2019 | ||
* [TFS 19490 / BZ 57767] Added Web Comment support to the / | * [TFS 19490 / BZ 57767] Added Web Comment support to the / | ||
+ | * Version 6.2.7.415 – November 21, 2019 | ||
+ | * [57691/TFS 19695] Two new endpoints have been added to the S5WebAPI to provide faster and more efficient access to the information provided by the Record State Tracking feature. | ||
+ | * GET [[webapi: | ||
+ | * GET [[webapi: | ||
* Version 6.2.7.414 – November 21, 2019 | * Version 6.2.7.414 – November 21, 2019 | ||
* [BZ 57751 / TFS 19694] Corrected the cause of the crashing by preventing the API from returning all of the invoices when the ZERO parameter is passed. The API now returns nothing in that case. Added 2 new methods to address the need to obtain more than one invoice from the API in a single call. | * [BZ 57751 / TFS 19694] Corrected the cause of the crashing by preventing the API from returning all of the invoices when the ZERO parameter is passed. The API now returns nothing in that case. Added 2 new methods to address the need to obtain more than one invoice from the API in a single call. | ||
* Version 6.2.7.396 – October 29, 2019 | * Version 6.2.7.396 – October 29, 2019 | ||
- | * [TFS 20705] Fix for S5WebAPISvc that was broken due to new data collector list load. | + | * [TFS 20705] Fix for S5WebAPISvc that was broken due to a new data collector list load. |
* Version 6.2.7.360 – September 11, 2019 | * Version 6.2.7.360 – September 11, 2019 | ||
* [57680] Corrected a problem that prevented the pagination from working correctly in the Inventory End Point with S5WebAPI service. | * [57680] Corrected a problem that prevented the pagination from working correctly in the Inventory End Point with S5WebAPI service. | ||
Line 212: | Line 252: | ||
* [57690] Updated the logging to Log Analytics to better report the start and finish of each API call. | * [57690] Updated the logging to Log Analytics to better report the start and finish of each API call. | ||
* Version 6.2.7.309 – July 15, 2019 | * Version 6.2.7.309 – July 15, 2019 | ||
- | * [57554] Corrected a problem in the \addInvoice method of the S5WebAPISvc' | + | * [57554] Corrected a problem in the \addInvoice method of the S5WebAPISvc' |
* **Version 6.2.7.297 – July 4, 2019** | * **Version 6.2.7.297 – July 4, 2019** | ||
- | * [57526] S5WebAPISrv - **Inventory End Points** have been updated to support all of the **configured default inventory records** and allow for the configuration of prices based on the Price Codes, using Prices, Markups, Margins or Discounts within the bounds of the maximum number of Price Schedules configured in the system. There is no provision to allows the external systems to change the number of Price Schedules. | + | * [[: |
* Version 6.2.7.265 – June 6, 2019 | * Version 6.2.7.265 – June 6, 2019 | ||
- | * [57332] Added KitType, Weight, Instock by Dept, SaleStart, SaleEnd, AltSuply, and Barcodes information to the GET / | + | * [57332] Added KitType, Weight, Instock by Dept, SaleStart, SaleEnd, AltSuply, and Barcodes information to the GET / |
+ | * [56751] The ability to populate Alt Supply records and Barcode records is now supported in the GET /Inventory endpoint. | ||
+ | * AltSupply: | ||
+ | * Barcodes: This is a structure that must be populated in order to create the desired record and association with the Inventory record. The Swagger documentation contains a complete and detailed model of the required fields and their purposes. | ||
* Version 6.2.7.261 – June 4, 2019 | * Version 6.2.7.261 – June 4, 2019 | ||
- | * [57350] The S5WebAPI / | + | * [57350] The S5WebAPI / |
- | * [57267] An e-Commerce filter has been added to the / | + | * [57267] An e-Commerce filter has been added to the / |
* [56767] Virtual Warehouse is now considered by the S5WebAPI and the behavior is consistent with System Five. | * [56767] Virtual Warehouse is now considered by the S5WebAPI and the behavior is consistent with System Five. | ||
* Version 6.2.7.251 – May 28, 2019 | * Version 6.2.7.251 – May 28, 2019 | ||
Line 228: | Line 271: | ||
* [57327] Added " | * [57327] Added " | ||
* 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 end points | + | * [56999] Added pagination to the Inventory, Virtual Inventory, Customer and A/P Bill endpoints |
+ | |||
+ | ===== 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 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 it 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 an API call, XML may require re-installation. | ||
+ | |||
+ | |||
+ | **Getting a User Security Error on WordsToo.btr** | ||
+ | If you are presented with a "User # Security Error on WordsToo.btr. User Record has been tampered with" message. | ||
+ | The reason for this error message is due to the user account being locked out or expired and the S5webapi is trying to login using those credentials. | ||
+ | | ||
+ | To resolve this issue: | ||
+ | - Go to Setup Wizard > Users and Security > Go to user # (It is the WEB API log in) | ||
+ | - Uncheck the lockout tick box or reset the password | ||
+ | - Ensure the password is the same in the WebAPI.INI configuration | ||
+ | - Restart the S5WebAPI | ||
+ | - Optionally test the S5WebAPI using swagger if configured |
webapi_swagger_documentation.txt · Last modified: 2022/02/23 13:40 (2 years ago) by kevin