Login

Description

The Login API method provides the authentication mechanism for a RegOnline user. An APIToken is returned as part of the results collection which can then be passed via HTTP header to subsequent API calls to provide authentication.

URL

https://www.regonline.com/api/default.asmx/Login

Parameters

username
The username of the user being authenticated.

password
The password of the user being authenticated.

Returns

<LoginResponse xmlns="http://www.regonline.com/api">
    <LoginResult>
      <Success>boolean</Success>
      <Message>string</Message>
      <Data>
        <RedirectUrl>string</RedirectUrl>
        <EventSessionId>string</EventSessionId>
        <CustomerId>int</CustomerId>
        <DisplayCaptcha>boolean</DisplayCaptcha>
        <IsCustomerDeactivated>boolean</IsCustomerDeactivated>
        <APIToken>string</APIToken>
        <Email>string</Email>
      </Data>
    </LoginResult>
</LoginResponse>

SOAP request format

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <Login xmlns="http://www.regonline.com/api">
      <username>**username**</username>
      <password>**password**</password>
    </Login>
  </s:Body>
</s:Envelope>

SOAP response format

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <soap:Body>
    <LoginResponse xmlns="http://www.regonline.com/api">
      <LoginResult>
        <Success>boolean</Success>
        <Data>
          <Success>boolean</Success>
          <RedirectUrl>string</RedirectUrl>
          <EventSessionId>string</EventSessionId>
          <CustomerId>int</CustomerId>
          <DisplayCaptcha>boolean</DisplayCaptcha>
          <IsCustomerDeactivated>boolean</IsCustomerDeactivated
          <APIToken>string</APIToken>
          <Email>string</Email>
        </Data>
      </LoginResult>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>

Authentication

These API methods require a valid API token to be sent in the request header collection.  The Login(username, password) web service can be used to obtain the API token for the account initially, which can then be used in subsequent API calls.  The account must be a default, full-access user.  The API Token should be passed as the value for the “APIToken” request header.

Posted: June 29th, 2011

RegOnline by Lanyon is the easy-to-use, affordable online registration and event management software. Turn your next conference, meeting, trade show into a huge success. Event management solutions include online registration forms, event websites, badges, event marketing, credit card processing and so much more. Sign up today for a free trial.

TRUSTe online privacy certification Lanyon Solutions, Inc.
717 North Harwood
Dallas, Texas 75201
email: info@lanyon.com | Toll Free: 1-888-351-9948

 

© Copyright 2017 | RegOnline by Lanyon | All Rights Reserved