About SOAP

From Open Rail Data Wiki
Revision as of 13:21, 30 December 2018 by PeterHicks (talk | contribs) (Add a page on SOAP)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

SOAP is an XML-based protocol used for the Public and Staff Live Departure Boards web services. At first glance, it is not an easy protocol to use, and there are many mistakes you can make.

About SOAP

Services which are available over SOAP will have a WSDL (Web Services Description Language) file. This describes the interface in a machine-readable format, allowing creation of a client with very little additional coding. SOAP clients such as Apache CXF (Java) and Zeep (Python) can consume this WSDL and create a native-language object with all the method calls automatically.

When the WSDL changes and additional method calls are made available, clients can update themselves to use the new method calls by simply updating the WSDL used by their code.

SOAP clients will also create the appropriate XML required for method calls, make the HTTP call then parse the XML returned.