The current version of BINETIX® PTMâ„¢ API provides a set of open-standard Web services based on SOAP. Therefore this API could be fluently used by other external applications or middle-ware compatible with it. The Web services are specified within this document as Services, referential Data Types, and Error Types & Codes. The API functions can be accessed using the following URI: <accessScheme>://<host>:<port>/<serviceController>/<soapAction> •<accessScheme> - HTTP or HTTPS •<host> - IP address to BINETIX® PTMâ„¢ •<port> - Port to the hosted Web services. Default value is 8089. •<serviceController> - The main service controller which routes the function calls. The name is customizable and depends on the system configuration •<soapAction> - Operation name (action) which refers to particular Web service function The Reader of this documentation is supposed to be a software developer with a good and clear understanding of the following knowledge areas: ✓XML and XML name spaces; ✓WSDL and SOAP notations; ✓The business processes related to the corresponding functions, in order to understand and apply these correctly. ✓Clear understanding of the business terminology and the PTM system specific terminology. |
SOAP is a XML-based open-standard communication protocol for exchanging messages among computers. The acronym refers to Simple Object Access Protocol. The SOAP messages are ordinary XML documents. Each document is structured by the following elements: •Envelope - mandatory element which defines the scope of the message •Header - optional element which contains different attributes of the message •Body - mandatory element which contains the data to be exchanged •Fault - optional element which provided information about errors that occur on messages processing
|
