It is important for web applications to be able to communicate over the Internet. The best way to communicate between applications is over HTTP, because HTTP is supported by all Internet browsers and servers. SOAP was created to accomplish this. A SOAP message is an XML format containing the some specific elements I,e Envelope, Header and Body.
What is the soap template message type?
To secure our data transmission system need specific formatted data. In Skyvva we have specific soap template message type contains URL, header body. We have different template for request and response. . As we have three element in Request: ,
- URL Query Parameter
- SOAP Header
- HTTP Header
- SOAP Body
As we have two element in Response
- Envelope
- SOAP Header
- MessageType
So , when we get response and we will get both header and body so based on mapping we will perform DML operation for the data we got in response.
| Message Type Name | TYPE |
| MessageType: Google SOAP Service | WSDL Service |
| MessageType: Request | WSDL Request |
| MessageType : URL Query Parameter | WSDL URL Query Parameter |
| MessageType : SOAP Header | WSDL Header |
| MessageType : HTTP Header | HTTP Header |
| MessageType: SOAP Body | WSDL Body |
| MessageType : Response | WSDL Response |
| MessageType : Envelope | WSDL Envelope |
| MessageType : SOAP Header | WSDL Header |
| MessageType : SOAP Body | WSDL Body |
| MessageType : Fault | WSDL Fault |
| MessageType : Envelope | WSDL Envelope |
| MessageType : SOAP Body | WSDL Body |
soap template message type
A SOAP request message is an XML format containing the some specific elements as:
We have SOAP Service that types WSDL Service with three children: Request, Response, and Fault Response. For those children, they have different types like Request is WSDL Request Type, Response is WSDL Response, and Fault Response is WSDL Fault Type.
In Request Message Type is Type WSDL Request, and It has several elements like First is SOAP Header have type WSDL Header that contains Sessionheader, and in Session header, it has SessionID. About Session Header and SessionID, we can put type plaint Structure or none. Seconds is URL Query Parameter has type WSDL Query Parameter. The third is HTTP Header that has the type HTTP Header. The fourth is SOAP Body that has type WSDL Body that contains Business data which type is Plaint Structure or none. See the picture below.
In Response Message Type is the WSDL Response type. It has one element that is the Envelope message type has a Type WSDL Envelope. In Envelop has Header, type WSDL Header and Body has WSDL Body containing Business data Message Type with Plain structure type or none. See the picture below.
In Fault Response Message Type is Type WSDL Fault and it contains two elements such as Envelope has Type WSDL Envelope. In Envelop Message Type has Body that is WSDL Body type and under the Body is Business Message Type that is a plain structure or none type. see the picture below.
This is the request message type:
SOAP URL Parameter :
The Simple Object Access Protocol (SOAP) endpoint is a URL. It identifies the location on the built-in HTTP service where the web services listener listens for incoming request. There are two URL parameter:
- Path parameter:
- Query parameter:
But we support only Query parameter:
For example, https://www.example.com/{herewillbeparametername}/xml?{test}
Here we can see the Question mark in above URL, So before ? mark we have path parameter and after question mark we have query parameter and parameter name exactly same as we inserted in messageType.
SOAP Header :
The optional SOAP Header element contains application-specific information (like authentication, payment, account id etc) about the SOAP message.If the Header element is present, it must be the first child element of the Envelope element. It Contains any optional attributes of the message used in processing the message, either at an intermediary point or at the ultimate end-point. It can be hierarchical.
SOAP Body :
The SOAP body is a mandatory element that contains the application-defined XML data being exchanged in the SOAP message. The body must be contained within the envelope and must follow any headers that might be defined for the message. The body is defined as a child element of the envelope, and the semantics for the body are defined in the associated SOAP schema.The body contains mandatory information intended for the ultimate receiver of the message. It can be hierarchical. We support hierarchical body and generate chained interface. For example − fields of account object:
- Name
- BillingCity
- BillingCountry
How to create Message Type?
There are different ways to create message type from IStructureRepository:
- Import Metadata
- Open Editor
- Manually create New Message Type.
Import MEtadata: #
Skyvva support different file formats(xsd, json schema, wsdl 1.1 & 2.0, swagger 2.0 and openAPI 3.x) to create message type. Upload button automatically create a hierarchical structure like msgtype Istructure from hierarchical file.
Pre-requisite: #
To create Metadata Provider.
To Create Istructure Repository.
Go to Istructure Repository and click on “Upload File” button.
#
Select file format which you want to upload.
#
2. Open Editor #
To create Metadata Provider.
To Create Istructure Repository.
Go to Istructure Repository and click on “Open Editor” button.
3. Manually Create message type: #
- To create Metadata Provider.
- To Create Istructure Repository.
- Go to Istructure Repository and click on “New message Type” button.
Once we Save this Message type is created.
[su_box title=”Note” box_color=”#2a8af0″ title_color=”#000000″]Soap adapter required specific template in which every message type should have fixed TYPE. For example, MessageType: Request and its TYPE: WSDL Request [/su_box]
We will going to create follwing type of Message Type for build xml payload:
Message Type Name TYPE
MessageType: Google SOAP Service WSDL Service
MessageType: Request WSDL Request
MessageType : URL Query Parameter WSDL URL Query Parameter
MessageType : SOAP Header WSDL Header
MessageType : HTTP Header HTTP Header
MessageType: SOAP Body WSDL Body
MessageType : Response WSDL Response
MessageType : Envelope WSDL Envelope
MessageType : SOAP Header WSDL Header
MessageType : SOAP Body WSDL Body
MessageType : Fault WSDL Fault
MessageType : Envelope WSDL Envelope
MessageType : SOAP Body WSDL Body
