Purpose
This call is required to retrieve a valid session. Valid session credentials are required for all subsequent API calls.
| Note | ||
|---|---|---|
| ||
The credentials provided as a result of this call will be required for almost all subsequent calls and is used as a security measure to receive specific information, *Learn how to chain this call in 5) Creating Chained Requests |
Making the Call
| Info |
|---|
In this instance I am making a call to loggin login into my uat UAT environment through postman, as I require my Session credentials to perform any further Web Service Calls. |
Endpoint: https://bau-uat-wsthirdpartywcf.flipgroup.azurewebsites.net/Data/ChainITcom.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
...
| Code Block | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||
<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><Login> <!--Mandatory:--> <cha:userName>blah@exampleemail<userName>blah@exampleemail.com</cha:userName> <!--Mandatory:--> <cha:password>Password1@<<password>Password1@</cha:password> </cha:Login> </soapenv:Body> </soapenv:Envelope> |
...
| Code Block | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||
<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>111111<<DistributorID>123456</DistributorID>
<Expires>2017-08-11T18:29:36.477</Expires>
<Key>74BF4B23-1705-3C17-B03F-BE891921B82E</Key>
<UserID>111111<<UserID>100001</UserID>
</LoginResult>
</LoginResponse>
</s:Body>
</s:Envelope> |
...
Related articles
| Filter by label (Content by label) | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...