Session


Click here for a complete list of operations.

OAuthLogon

Logs on with the OAuth credentials.

Test

The test form is only available for requests from the local machine.

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 /webservices/session.asmx HTTP/1.1
Host: login.twinfield.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.twinfield.com/OAuthLogon"

<?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>
    <OAuthLogon xmlns="http://www.twinfield.com/">
      <clientToken>string</clientToken>
      <clientSecret>string</clientSecret>
      <accessToken>string</accessToken>
      <accessSecret>string</accessSecret>
    </OAuthLogon>
  </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:Header>
    <Header xmlns="http://www.twinfield.com/">
      <SessionID>string</SessionID>
      <AccessToken>string</AccessToken>
    </Header>
  </soap:Header>
  <soap:Body>
    <OAuthLogonResponse xmlns="http://www.twinfield.com/">
      <OAuthLogonResult>Ok or Blocked or Untrusted or Invalid or Deleted or Disabled or OrganisationInactive or ClientInvalid or Failed or TokenInvalid or NoAvailableCompanies or OAuth2AuthenticationRequired</OAuthLogonResult>
      <nextAction>None or SMSLogon or ChangePassword</nextAction>
      <cluster>string</cluster>
    </OAuthLogonResponse>
  </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 /webservices/session.asmx HTTP/1.1
Host: login.twinfield.com
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>
    <OAuthLogon xmlns="http://www.twinfield.com/">
      <clientToken>string</clientToken>
      <clientSecret>string</clientSecret>
      <accessToken>string</accessToken>
      <accessSecret>string</accessSecret>
    </OAuthLogon>
  </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:Header>
    <Header xmlns="http://www.twinfield.com/">
      <SessionID>string</SessionID>
      <AccessToken>string</AccessToken>
    </Header>
  </soap12:Header>
  <soap12:Body>
    <OAuthLogonResponse xmlns="http://www.twinfield.com/">
      <OAuthLogonResult>Ok or Blocked or Untrusted or Invalid or Deleted or Disabled or OrganisationInactive or ClientInvalid or Failed or TokenInvalid or NoAvailableCompanies or OAuth2AuthenticationRequired</OAuthLogonResult>
      <nextAction>None or SMSLogon or ChangePassword</nextAction>
      <cluster>string</cluster>
    </OAuthLogonResponse>
  </soap12:Body>
</soap12:Envelope>