General Information
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 SERVICE TICKET using the Login method. |
Logout | If no Web Service request will be done, you need to LOGOUT from the system. |
To interact with any Web Services, developers must first use the Login method to create a SERVICE TICKET. Developers can send requests to other Web Service and methods using this SERVICE TICKET.
Login
<login> |
---|
In order to make Web Service requests, you first need to LOGIN and create a SERVICETICKET. This SERVICETICKET is used on every Web Service request. |
Parameters
Parameter | Value | |
---|---|---|
Username | Web Service user name provided by RMC | MANDATORY |
Password | Web Service password provided by RMC | MANDATORY |
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <Login xmlns="http://ws.euromsg.com/auth"> <Username>string</Username> <Password>string</Password> </Login> </soap12:Body> </soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <LoginResponse xmlns="http://ws.euromsg.com/auth"> <LoginResult> <ServiceTicket>string</ServiceTicket> </LoginResult> </LoginResponse> </soap12:Body> </soap12:Envelope>
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
<logout> |
---|
Ends the session started with LOGIN . SERVICETICKET is ended if no Web Service requests will be made. |
Parameters
Parameter | Value | |
---|---|---|
SERVICETICKET | Session ID you want to end | MANDATORY |
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <Logout xmlns="http://ws.euromsg.com/auth"> <ServiceTicket>string</ServiceTicket> </Logout> </soap12:Body> </soap12:Envelope>
<?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <LogoutResponse xmlns="http://ws.euromsg.com/auth"> <LogoutResult> <ServiceTicket>string</ServiceTicket> </LogoutResult> </LogoutResponse> </soap12:Body> </soap12:Envelope>
Error Parameters
Code | Error Message | Detailed Message | Description |
---|---|---|---|
9998 | Unauthorized User! | Object reference not set to an instance of an object. | Logout failed. Invalid SERVICETICKET. |
Parent Topic: SOAP Web Service