Usage

Authenticates and authorizes a web service client using the specified user name and password.

A valid username and password for accessing Luminate Online Web Services must meet the following criteria:

1. The username is associated with a active constituent that has administrator status
2. The password is valid for the constituent
3. The constituent is a member of an admin security group that has the "Use Luminate Online APIs" permission

Returns a LoginFault if any of these criteria are not met.

Returns a SessionId session token upon successful login. Clients must include this token in the header of subsequent requests within the same session. The token is valid for up to 30 minutes of inactivity, after which the client must call this operation again to acquire a new token.

Request Parameters

UserName

string

A value is required

The User Name for an API Administrator Account

Password

string

A value is required

The Password for the API Administrator Account

Response Parameters

SessionId

string

A token for use in subsequent requests within the same login session

Faults

• ServiceUnavailableFault
• ServerFault
• MalformedMessageFault
• InvalidMessageFault
• LoginFault

Example SOAP request

<?xml version='1.0' encoding='UTF-8' ?>
<soap:Envelope xmlns:soap='http://schemas.xmlsoap.org/soap/envelope/'>
  <soap:Body>
    <Login xmlns='urn:soap.convio.com'>
      <UserName>apiuser-test</UserName>
      <Password>convio</Password>
    </Login>
  </soap:Body>
</soap:Envelope>

      

Example SOAP response

<?xml version='1.0' encoding='UTF-8'?>
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoginResponse xmlns="urn:soap.convio.com">
      <Result>
        <SessionId>1c79d882d01b4e24dc5cfcc9e462138391342c23:JSESSIONID=abcwDjW3UwpfAe_yIlS4r:10000100:2008-12-12T17:11:09.262Z</SessionId>
      </Result>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>