System Five Add-Ons & Integrations help simplify the way you do things.
Our catalog of services has topic-based, role-based, or technical plans that can help you maximize your software investment.
Copyright © 1984-present
Windward Software Systems Inc.
All Rights Reserved.
Privacy Policy
This is an old revision of the document!
Our Web API solution runs as a service and provides a doorway to push and pull information from a System Five database. This technology will work with both onPrem installations and our System Five on Cloud deployments.
The following is an explanation for retrieving and using the Swagger 2.0 documentation from all available endpoints of the Windward Web API.
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:
All of these endpoints can be accessed with either of the following URLs:
As of the 6.2.7 Beta the following methods in the endpoint TServerMethodsWebAPI were deprecated:
Replacement methods for these newly deprecated methods can be found within the other endpoints.
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 '%' characters inside of JSON strings will cause internal server errors.
The Swagger documentation for a particular endpoint can be retrieved by using a method of the endpoint. Using your preferred method or app (we suggest Postman), send a GET request to one of the following URLs:
The contents of the response from the calls is the Swagger 2.0 documentation, after copying the response text and saving it into a text file use your preferred Swagger editor (we suggest editor.swagger.io) to view the Swagger documentation.
After configuring your S5WebAPISvc.ini, you can view and interact with the Swagger 2.0 documentation and the Web API through a browser, without using Postman or a Swagger editor.