Services


Click here for a complete list of operations.

GetBackupServiceV2

This method takes a user Alias(GrantId), a password and AuthCode and looks up the AccessToken for this user and then checks the Entitlement status and returns a BackupService object.

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 /EmeraldWS/services.asmx HTTP/1.1
Host: emerald.backup.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://intuit.backup.com/GetBackupServiceV2"

<?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>
    <GetBackupServiceV2 xmlns="http://intuit.backup.com/">
      <AuthCode>string</AuthCode>
      <GrantId>string</GrantId>
      <UserToken>string</UserToken>
    </GetBackupServiceV2>
  </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>
    <GetBackupServiceV2Response xmlns="http://intuit.backup.com/">
      <GetBackupServiceV2Result>
        <Passkey>string</Passkey>
        <ExpirationDate>dateTime</ExpirationDate>
        <SKU>string</SKU>
        <Quota>int</Quota>
        <Meta>string</Meta>
        <Alias>string</Alias>
        <ServiceID>string</ServiceID>
        <Status>string</Status>
        <RedirectorPort>string</RedirectorPort>
        <RedirectorIP>string</RedirectorIP>
        <BackupLocation>string</BackupLocation>
        <BackupLocationUniqueID>string</BackupLocationUniqueID>
        <writeonce>boolean</writeonce>
        <UserID>string</UserID>
        <backupHistory>
          <historyType>string</historyType>
          <historyEntries>
            <HistoryEntry xsi:nil="true" />
            <HistoryEntry xsi:nil="true" />
          </historyEntries>
        </backupHistory>
        <restoreHistory>
          <historyType>string</historyType>
          <historyEntries>
            <HistoryEntry xsi:nil="true" />
            <HistoryEntry xsi:nil="true" />
          </historyEntries>
        </restoreHistory>
      </GetBackupServiceV2Result>
      <ErrorCode>string</ErrorCode>
    </GetBackupServiceV2Response>
  </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 /EmeraldWS/services.asmx HTTP/1.1
Host: emerald.backup.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>
    <GetBackupServiceV2 xmlns="http://intuit.backup.com/">
      <AuthCode>string</AuthCode>
      <GrantId>string</GrantId>
      <UserToken>string</UserToken>
    </GetBackupServiceV2>
  </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>
    <GetBackupServiceV2Response xmlns="http://intuit.backup.com/">
      <GetBackupServiceV2Result>
        <Passkey>string</Passkey>
        <ExpirationDate>dateTime</ExpirationDate>
        <SKU>string</SKU>
        <Quota>int</Quota>
        <Meta>string</Meta>
        <Alias>string</Alias>
        <ServiceID>string</ServiceID>
        <Status>string</Status>
        <RedirectorPort>string</RedirectorPort>
        <RedirectorIP>string</RedirectorIP>
        <BackupLocation>string</BackupLocation>
        <BackupLocationUniqueID>string</BackupLocationUniqueID>
        <writeonce>boolean</writeonce>
        <UserID>string</UserID>
        <backupHistory>
          <historyType>string</historyType>
          <historyEntries>
            <HistoryEntry xsi:nil="true" />
            <HistoryEntry xsi:nil="true" />
          </historyEntries>
        </backupHistory>
        <restoreHistory>
          <historyType>string</historyType>
          <historyEntries>
            <HistoryEntry xsi:nil="true" />
            <HistoryEntry xsi:nil="true" />
          </historyEntries>
        </restoreHistory>
      </GetBackupServiceV2Result>
      <ErrorCode>string</ErrorCode>
    </GetBackupServiceV2Response>
  </soap12:Body>
</soap12:Envelope>