Versions Compared

Old Version 30

changes.mady.by.user Steven Reynolds

Saved on

compared with

New Version Current

changes.mady.by.user Dennis Navarro

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue
indent10px

What is Web Service Call

EFM use SOAP Web Service Calls which is a method of communicating to an application/website and the data it has available.

Why Use Web Service Calls

The purpose of these Web Services is to allow you to create/modify/review your existing order processing system to extend its functionality to include a despatching component for your orders. It is assumed that the data required for creating a consignment will already exists in some capacity within one of your systems and as a result this data can be formatted for the purpose of transitioning order data into consignment data.

How to make a Web Service Call

What to Send? (Web Service WSDL)

Our Web Service Definition Language(WSDL) provides a complete overview of all calls that can be made through our SOAP Web Service, as well as the information requirements of each call.

http://support-ws.azurewebsites.net/Data/ChainIT/DataService.svc?wsdl \

Info
iconfalse

Web Service Schema XSD

Within the WSDL you will also find an XSD Schema. This will inform you of the Information requirements of every call.

http://support-ws.azurewebsites.net/Data/ChainIT/DataService.svc?xsd=xsd0

This information can also be found below "Web Service Functions/Calls"

Where you are sending the information? (Endpoint)

What you are planning to do? (How to Define the Call)

i.e What function are you calling?

Info

*SoapUI automatically configures the "Header" based on the call being made. However for other applications it is critical the correct SoapAction Url is entered in to make the correct call

What are the information requirements

Body:

Code Block
languagexml
themeRDark
firstline1
titleSOAP Web Service Call Body Example
linenumberstrue
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:cha="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
   <soapenv:Header/>
   <soapenv:Body>
<!-- Requirements of each soapAction can be found http://support-ws.azurewebsites.net/Data/ChainIT/DataService.svc?xsd=xsd0 -->

				<!-- Example XSD Schema available for Login

					<xs:element name="Login">
						<xs:complexType>
							<xs:sequence>
								<xs:element minOccurs="0" name="userName" nillable="true" type="xs:string"/>
								<xs:element minOccurs="0" name="password" nillable="true" type="xs:string"/>
							</xs:sequence>
						</xs:complexType>
				</xs:element> 

				Example XSD Schema available for Login -->

<!--Below Content Dependent on soapAction Selected  -->

      <cha:Login>
         <!--Optional:-->
         <cha:userName>test@oneflo</cha:userName>
         <!--Optional:-->
         <cha:password>efm123</cha:password>
      </cha:Login>


   </soapenv:Body>
</soapenv:Envelope>
Info

*SoapUI automatically configures the Body Template based on the call being made. If you are using other applications you can use the "Example Body" from the required function definition below. Alternatively consult the Web Service Schema XSD (Link provided above)

...

titleTip

Use the WSDL and SoapUI to test your own Web Service Calls quickly and easily

...

Image Removed

Info

*SoapUI Is not required to perform Web Service Calls, however this can aid significantly in interpreting the WSDL and understanding the information requirements of each call.

Other Possible Applications

*Using non-SOAP specific applications will require additional Configuration.

Web Service Functions/Calls

...

Things to Know

  • WSDL Definitions are used to define Web Call Requirements and what is needed to successfully communicate to OneFlo
  • soapAction needs to be declared in the header of your request and the end point should not change.
  • The Response from the Login call will be required in all subsequent calls.

Learn how to Create your own Web Service Call

Child pages (Children Display)
depth2
styleh3