User Tools

Site Tools


webapi_swagger_documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
webapi_swagger_documentation [2018/10/23 10:37]
kevin
webapi_swagger_documentation [2019/03/20 13:25] (current)
swind
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. ​ This technology will work with both onPrem installations and our System Five on Cloud deployments.  ​+Our s5webAPI ​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.+<note important>​ Be aware that WEB API uses a Pervasive License</​note>​
  
-<note important>​You must have the Windward Web API installed and running properly before you are able to retrieve ​and use the Swagger 2.0 documentation.</​note>​+The following is an explanation for retrieving ​and using the Swagger 2.0 documentation ​from all available endpoints of the Windward S5WebAPI.
  
 ===== Endpoints ===== ===== Endpoints =====
  
-As of the 6.2.2.175 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 28:
 ==== Deprecated Methods ==== ==== Deprecated Methods ====
  
-As of the 6.2.2.175 the following methods in the endpoint TServerMethodsWebAPI are deprecated.  ​They will continue to operate but with this any new software ​development ​should use these methods.+As of the 6.2.2.175 the following methods in the endpoint TServerMethodsWebAPI are deprecated.  ​Deprecated methods ​will continue to operate but no new development ​is planned for these.
   - Customers_Insert   - Customers_Insert
   - Customer_Read   - Customer_Read
Line 52: Line 52:
   - Insert_Full_Invoice   - Insert_Full_Invoice
   - Insert_AP_Bill   - Insert_AP_Bill
- +<​note>​ 
-Replacement ​methods ​for these newly deprecated methods can be found within ​the other endpoints+Any new software development should make use of new methods found within ​a domains endpoint
 +</​note>​
 ===== Known Limitations ===== ===== Known Limitations =====
  
webapi_swagger_documentation.1540316258.txt.gz · Last modified: 2018/10/23 10:37 by kevin