You are here: Reference > Sphere Connect API Web Methods > Login

Login

Authenticates with the Sphere Connect API.

Usage

Use the Login method to authenticate with a session ID. When the client calls the Sphere Connect API, the Sphere Web server returns a Session ID upon successful validation. The Web client must use this Session ID for all other calls to Sphere. The Session ID remains active for 30 minutes from the time of the last call.

SOAP Request and Response

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /KinteraConnect/sphere.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://schema.kintera.com/API/Login"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <SessionHeader xmlns="http://schema.kintera.com/API/">
      <SessionID>string</SessionID>
    </SessionHeader>
  </soap:Header>
  <soap:Body>
    <Login xmlns="http://schema.kintera.com/API/">
      <request>
        <Client>string</Client>
        <LoginName>string</LoginName>
        <Password>string</Password>
        <SessionTimeout>int</SessionTimeout>
        <UserID>int</UserID>
        <AccountID>int</AccountID>
        <VirtualAccountID>int</VirtualAccountID>
      </request>
    </Login>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <LoginResponse xmlns="http://schema.kintera.com/API/">
      <LoginResult>
        <SessionID>string</SessionID>
        <UserID>int</UserID>
        <UserFirstName>string</UserFirstName>
        <UserLastName>string</UserLastName>
        <AccountID>int</AccountID>
        <AccountName>string</AccountName>
        <VirtualAccountID>int</VirtualAccountID>
        <VirtualAccountName>string</VirtualAccountName>
      </LoginResult>
    </LoginResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /KinteraConnect/sphere.asmx HTTP/1.1
Host: localhost
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?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:Header>
    <SessionHeader xmlns="http://schema.kintera.com/API/">
      <SessionID>string</SessionID>
    </SessionHeader>
  </soap12:Header>
  <soap12:Body>
    <Login xmlns="http://schema.kintera.com/API/">
      <request>
        <Client>string</Client>
        <LoginName>string</LoginName>
        <Password>string</Password>
        <SessionTimeout>int</SessionTimeout>
        <UserID>int</UserID>
        <AccountID>int</AccountID>
        <VirtualAccountID>int</VirtualAccountID>
      </request>
    </Login>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?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://schema.kintera.com/API/">
      <LoginResult>
        <SessionID>string</SessionID>
        <UserID>int</UserID>
        <UserFirstName>string</UserFirstName>
        <UserLastName>string</UserLastName>
        <AccountID>int</AccountID>
        <AccountName>string</AccountName>
        <VirtualAccountID>int</VirtualAccountID>
        <VirtualAccountName>string</VirtualAccountName>
      </LoginResult>
    </LoginResponse>
  </soap12:Body>
</soap12:Envelope>