If the IFS SOAP Gateway should invoke a Service directly the HTTP request must follow the IFS SOAP Access Provider format. The IFS SOAP Access Provider format specifies following three conditions.
- For calling synchronous BizAPI's:
urn:soap_access_provider:<BizAPI_Name>
- For calling asynchronous BizAPI's:
urn:soap_access_provider:<BizAPI_Name>/post
- For calling synchronously services via operation name:
urn:soap_access_provider:<Handler_Name>:<Operation_Name>
- For calling asynchronously services via operation name:
urn:soap_access_provider:<Handler_Name>:<Operation_Name>/post
Example of IFS SOAP Access Provider request format :
Example of SOAP Action format for synchronous BizAPI call:
SOAPAction: urn:soap_access_provider:GET_TEST_ORDER
Example of SOAP Action format for asynchronous BizAPI call:
SOAPAction: urn:soap_access_provider:RECEIVE_TEST_ORDER/post
Example of SOAP Action format for Service call:
SOAPAction: urn:soap_access_provider:ConnectivityProcessingHandler:LoadInboxMessage
A synchronous request is sent to IFS SOAP Gateway which calls the actual BizAPI or Service.
View example of an inbound synchronous soap message.
The the actual BizAPI or Service will be executed. A response message with the result is returned to the sender.
View example of a response message
If user is not authorized:
Post error: 401 Unauthorized
If the URL is incorrect:
Post error: 404 Not Found
Application errors from IFS SOAP Gateway:
HTTP: 500 Internal Server error
and a SOAP error response message that follows the SOAP standard.
This message contains the detailed error description.
View example of an SOAP error
message
An asynchronous message is sent to IFS SOAP Gateway. The message will be posted to the IFS queue system with the BizAPI name in the address data.
View example of an inbound asynchronous
soap message.
The message is successfully posted to the IFS queue system. A response message is returned to the sender.
View example of a asynchronous response
message
If user is not authorized:
Post error: 401 Unauthorized
If the URL is incorrect:
Post error: 404 Not Found
If the queue is not available:
HTTP: 500 Internal Server error
and a SOAP error response message that follows the SOAP standard.
This message contains the detailed error description.
View example of an SOAP error
message
A list of all installed Bizapi's in the system can be queried in runtime
with an ordinary HTTP get.
Use your Internet Browser and test. The returned list will show you the URLs to
all WSDL definitions for the service handlers.
It's also possible to download a specific handler with it's WebService
definition file.
It's possible to fetch a lot of information from the SOAP Gateway by using
it's HTTP Get operation.
The table below will show you most important possibilities you have in runtime.
Description |
URL |
---|---|
A summary of all BizApi's in the system | http://host:port/int/soapgateway |
A WSDL file for a handler |
http://host:port/int/soapgateway?handler=MyHandler |
A schema (XSD) file for the message request |
http://host:port/int/soapgateway?handler=MyHandler&op=MyOp&type=xsd_request or
|
A schema (XSD) file for the message response |
http://host:port/int/soapgateway?handler=MyHandler&op=MyOp&type=xsd_response or
|
An XML example for the message request |
http://host:port/int/soapgateway?handler=MyHandler&op=MyOp&type=xml_request orhttp://host:port/int/soapgateway?bizapi=MY_BIZAPI&type=xml_request |
An XML example for the message response |
http://host:port/int/soapgateway?handler=MyHandler&op=MyOp&type=xml_response orhttp://host:port/int/soapgateway?bizapi=MY_BIZAPI&type=xml_response |
Help page with summary of all available query string parameters |
http://host:port/int/soapgateway?help=yes |
To access Activities instead of Services (BizAPI's) using
SOAP Gateway replace int
with main
in the URL's
above.