Authentication Web Service includes necessary login and logout methods to execute Web Service requests. You must first Login
and get a Service Ticket
each time you would like to make a Web Service request or access other Web Service methods.
Authentication Methods for Web Services
Method | Description |
---|
Login | To make Web Service requests, you need to create a Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| using the Login method. |
Logout | If no Web Service request will be done, you need to Status |
---|
subtle | true |
---|
colour | Red |
---|
title | LOGOUT |
---|
|
from the system. |
Warning |
---|
To interact with any Web Services, developers must first use the Login method to create a Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| . Developers can send requests to other Web Service and methods using this Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | Service Ticket |
---|
| . |
Login
Back to Top ^
<login> |
---|
In order to make Web Service requests, you first need to Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Login |
---|
| and create a Status |
---|
subtle | true |
---|
colour | Red |
---|
title | ServiceTicket |
---|
|
. This Status |
---|
subtle | true |
---|
colour | Red |
---|
title | ServiceTicket |
---|
| is used on every Web Service request. |
Parameters
Parameter | Value |
|
---|
Username | Web Service user name provided by RMC | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Password | Web Service password provided by RMC | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?> >
<soap<soap12:Envelope Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap:Body>
<Login xmlns>
<soap12:Body>
<Login xmlns="http://ws.euromsg.com/auth">
<Username>string</Username> <Password>string</Password>
</Login>
</soap:Body>
</soap>
<Username>string</Username>
<Password>string</Password>
</Login>
</soap12:Body>
</soap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope
xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/"
xmlns:xsi2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
<soap<soap12:Body>
<LoginResponse
xmlns="http://ws.euromsg.com/auth">
<LoginResult>
<Code>00</Code>
<Message />
<DetailedMessage />
<ServiceTicket>3C860EC9BFF1B14BBF801</<ServiceTicket>string</ServiceTicket>
</LoginResult>
</LoginResponse>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
parameter will return Status |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
Warning |
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <ServiceTicket> |
---|
|
value is granted only after a successful login. This value must be saved and used to make requests for other web service and web service methods. Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <ServiceTicket> |
---|
| expire time is two hours. But IIS can be recycle before this periot. if you received "No session" error; you can re-login and continue the process. |
Error Parameters
Code | Error Message | Description |
---|
99 | Invalip IP | Invalid Source IP. Your Source IP should be whitelisted by RMC Technical Client Support. |
99 | No such user/password! | Login information or the Service URL is incorrect. |
Logout
Back to Top ^
<logout> |
---|
Ends the session started with Status |
---|
subtle | true |
---|
colour | Red |
---|
title | Login |
---|
|
. Status |
---|
subtle | true |
---|
colour | Red |
---|
title | ServiceTicket |
---|
|
is ended if no Web Service requests will be made. |
Parameters
Parameter | Value |
|
---|
Status |
---|
subtle | true |
---|
colour | Red |
---|
title | ServiceTicket |
---|
|
| Session ID you want to end | Status |
---|
colour | Green |
---|
title | mandatory |
---|
|
|
Code Block |
---|
language | xml |
---|
title | REQUEST EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapsoap12="http://schemaswww.xmlsoapw3.org/2003/05/soap/-envelope/">
<soap:Body>
<Logout xmlns>
<soap12:Body>
<Logout xmlns="http://ws.euromsg.com/auth">
<ServiceTicket>ABCDEFG</ServiceTicket>
</Logout>
</soap:Body>
</soap>
<ServiceTicket>string</ServiceTicket>
</Logout>
</soap12:Body>
</soap12:Envelope> |
Code Block |
---|
language | xml |
---|
title | RESPONSE EXAMPLE |
---|
linenumbers | true |
---|
|
<?xml version="1.0" encoding="utf-8"?>
<soap<soap12:Envelope xmlns:soapxsi="http://schemaswww.xmlsoapw3.org/soap/envelope/
xmlns:xsi2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsdsoap12="http://www.w3.org/2003/200105/XMLSchemasoap-envelope">
<soap<soap12:Body>
<LogoutResponse xmlns="http://ws.euromsg.com/auth">
<LogoutResult>
<Code>00</Code><ServiceTicket>string</ServiceTicket>
<Message />
<DetailedMessage />
</LogoutResult>
</LogoutResponse>
</soapsoap12:Body>
</soapsoap12:Envelope> |
Tip |
---|
If the request was successful, the Status |
---|
subtle | true |
---|
colour | Red |
---|
title | <Code> |
---|
|
parameter will return Status |
---|
| |
---|
subtle | true |
---|
colour | Red |
---|
title | 00 |
---|
|
as a response. |
Error Parameters
Code | Error Message | Detailed Message | Description |
---|
9998 | Unauthorized User! | Object reference not set to an instance of an object. | Logout failed. Invalid Status |
---|
subtle | true |
---|
colour | Red |
---|
title | ServiceTicket |
---|
|
. |
Parent Topic: RMC REST APISOAP Web Service