Understanding SOAP Access Provider

Links

• About SOAP Gateway
• About SOAP Gateway Security

Contents

• IFS SOAP Access Provider format
• Inbound synchronous message flow
• Inbound asynchronous message flow
• Get BizAPI-list query in runtime
• WSDL file in runtime
• Summary of all Get commands

IFS SOAP Access Provider format

If the SOAP Gateway should invoke the Service or Activity direct the HTTP request must follow the IFS SOAP Access Provider format. The SOAP Access Provider format specifies following three conditions.

• The XML application message must embedded in the body of a SOAP Envelope (SOAP_SIMPLE envelope).
• The XML application message must follow the IFS XML standard.
  (Our generated WSDL and schema-files will shown this IFS XML standard and nothing else)
• A HTTP header parameter SOAPAction must be included in the HTTP request.
  This parameter defines the destination of the message.
  SOAPAction has three alternate formats :

1. For calling synchronous BizAPI's : urn:soap_access_provider:BizAPI_Name
2. For calling asynchronous BizAPI's : urn:soap_access_provider:BizAPI_Name/post
3. For calling activities : urn:soap_access_provider:Activity_Name:Operation_Name

Example of 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 Activity call
SOAPAction: urn:soap_access_provider:Application_Queue_Definition:Get_Application_Queue

 

Inbound synchronous message flow
 

Request

An synchronous request is sent to IFS SOAP gateway which calls
the actual BizApi or Activity.


View example of an inbound synchronous soap message.

OK response

The the actual Bizapi or Activity will be executed.
A response message with the result is returned to the sender.


View example of a response message
 

Error response

If user or password not is authorized:
Post error: 401 Unauthorized

If the URL is incorrect:
Post error: 404 Not Found

Application errors from 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

Inbound asynchronous message flow

Post

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.

OK response

The message is successfully posted the IFS queue system.
A response message is returned to the sender.


View example of a asynchronous response message

Error response
 

If user or password not is authorized:
Post error: 401 Unauthorized

If the URL is incorrect:
Post error: 404 Not Found

If the queue not is 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

Get BizAPI-list query in runtime

A list of all installed Bizapi's in the system can be queried in runtime with an ordinary HTTP get.
Use your Internet Explorer and test. The returned list will show you the urls to all WSDL definitions for the service handlers.
 

WSDL file in runtime

It's also possible to download a specific handler with it's webservice definition file.


 

Summary of all Get commands

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 all possibilities you have in runtime.