View Source

Purpose

This call is required to retrieve a valid session. Valid session credentials are required for all subsequent API calls.

The credentials provided as a result of this call will be required for all subsequent calls and is used as a security measure to receive specific information,

*Learn how to chain this call in Creating Chained Requests

Making the Call

In this instance I am making a call to login into my UAT environment through postman, as I require my Session credentials to perform any further Web Service Calls

Endpoint: https://uat-thirdpartywcf.flipgroup.com.au/DataService.svc

This is not the production endpoint. The production endpoint will be provided once all requests have been validated to work correctly.

Headers:

Key: Content-Type Value: text/xml
Key: SoapAction Value: http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices/IChainITService/Login

Body:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="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  -->

      <Login>
         <!--Mandatory:-->
         <userName>blah@exampleemail.com</userName>
         <!--Mandatory:-->
         <password>Password1@</password>
      </Login>

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

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <LoginResponse xmlns="http://www.opensys.com.au/ChainIT/4.0/ChainITDataServices">
            <LoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <AccountID>111111</AccountID>
                <DistributorID>123456</DistributorID>
                <Expires>2017-08-11T18:29:36.477</Expires>
                <Key>74BF4B23-1705-3C17-B03F-BE891921B82E</Key>
                <UserID>100001</UserID>
            </LoginResult>
        </LoginResponse>
    </s:Body>
</s:Envelope>

Related articles