BrightofficeAPI Web Service

BrightofficeAPI

Click here for a complete list of operations.

GetOAuth2ImapToken

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://tempuri.org/GetOAuth2ImapToken"

<?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>
    <GetOAuth2ImapToken xmlns="http://tempuri.org/">
      <hashCode>string</hashCode>
      <UserId>int</UserId>
    </GetOAuth2ImapToken>
  </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>
    <GetOAuth2ImapTokenResponse xmlns="http://tempuri.org/">
      <GetOAuth2ImapTokenResult>
        <__type>string</__type>
        <Success>boolean</Success>
        <Message>string</Message>
        <ExceptionMessage>string</ExceptionMessage>
        <Settings>
          <Email>string</Email>
          <Name>string</Name>
          <ProviderName>string</ProviderName>
          <Token>string</Token>
          <RefreshToken>string</RefreshToken>
          <ExpirationDate>dateTime</ExpirationDate>
          <MailServerType>string</MailServerType>
          <SmtpServer>string</SmtpServer>
          <ImapServer>string</ImapServer>
          <SmtpPort>int</SmtpPort>
          <ImapPort>int</ImapPort>
          <ErrorMessage>string</ErrorMessage>
        </Settings>
      </GetOAuth2ImapTokenResult>
    </GetOAuth2ImapTokenResponse>
  </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/BrightOfficeAPI.asmx HTTP/1.1
Host: www.spdoffice.co.uk
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>
    <GetOAuth2ImapToken xmlns="http://tempuri.org/">
      <hashCode>string</hashCode>
      <UserId>int</UserId>
    </GetOAuth2ImapToken>
  </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>
    <GetOAuth2ImapTokenResponse xmlns="http://tempuri.org/">
      <GetOAuth2ImapTokenResult>
        <__type>string</__type>
        <Success>boolean</Success>
        <Message>string</Message>
        <ExceptionMessage>string</ExceptionMessage>
        <Settings>
          <Email>string</Email>
          <Name>string</Name>
          <ProviderName>string</ProviderName>
          <Token>string</Token>
          <RefreshToken>string</RefreshToken>
          <ExpirationDate>dateTime</ExpirationDate>
          <MailServerType>string</MailServerType>
          <SmtpServer>string</SmtpServer>
          <ImapServer>string</ImapServer>
          <SmtpPort>int</SmtpPort>
          <ImapPort>int</ImapPort>
          <ErrorMessage>string</ErrorMessage>
        </Settings>
      </GetOAuth2ImapTokenResult>
    </GetOAuth2ImapTokenResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /Webservices/BrightOfficeAPI.asmx/GetOAuth2ImapToken?hashCode=string&UserId=string HTTP/1.1
Host: www.spdoffice.co.uk

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<OAuthTesterEmailResult xmlns="http://tempuri.org/">
  <__type>string</__type>
  <Success>boolean</Success>
  <Message>string</Message>
  <ExceptionMessage>string</ExceptionMessage>
  <Settings>
    <Email>string</Email>
    <Name>string</Name>
    <ProviderName>string</ProviderName>
    <Token>string</Token>
    <RefreshToken>string</RefreshToken>
    <ExpirationDate>dateTime</ExpirationDate>
    <MailServerType>string</MailServerType>
    <SmtpServer>string</SmtpServer>
    <ImapServer>string</ImapServer>
    <SmtpPort>int</SmtpPort>
    <ImapPort>int</ImapPort>
    <ErrorMessage>string</ErrorMessage>
  </Settings>
</OAuthTesterEmailResult>

HTTP POST

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

POST /Webservices/BrightOfficeAPI.asmx/GetOAuth2ImapToken HTTP/1.1
Host: www.spdoffice.co.uk
Content-Type: application/x-www-form-urlencoded
Content-Length: length

hashCode=string&UserId=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<OAuthTesterEmailResult xmlns="http://tempuri.org/">
  <__type>string</__type>
  <Success>boolean</Success>
  <Message>string</Message>
  <ExceptionMessage>string</ExceptionMessage>
  <Settings>
    <Email>string</Email>
    <Name>string</Name>
    <ProviderName>string</ProviderName>
    <Token>string</Token>
    <RefreshToken>string</RefreshToken>
    <ExpirationDate>dateTime</ExpirationDate>
    <MailServerType>string</MailServerType>
    <SmtpServer>string</SmtpServer>
    <ImapServer>string</ImapServer>
    <SmtpPort>int</SmtpPort>
    <ImapPort>int</ImapPort>
    <ErrorMessage>string</ErrorMessage>
  </Settings>
</OAuthTesterEmailResult>

Parameter	Value
hashCode:
UserId: