Workshare Compare Service (APAC)

API change history

Perform a comparison by fetching two documents (specified by their URLs)

The content type returned depends on the value of the outputFormat parameter.

Try it

Request

Request URL

Request parameters

  • (optional)
    string

    The Url to fetch the original document from. http:// and https:// are supported

  • (optional)
    string

    The Url to fetch the original document from. http:// and https:// are supported

  • (optional)
    string

    The format to return the comparison in. Valid options are Rtf, Wdf, Doc, DocX, Pdf, TrackChanges, RedlineMl, RedlineJSON Multiple output formats may be separated with commas. Only one document output format (Rtf, Wdf, Doc, Docx, Pdf, TrackChanges) and one data output format (RedlineMl, RedlineJSON) may be specified. When more than one format is specified (ie RedlineMl,Pdf) the result it returned as a zip file containing both formats, or as a multipart/mixed payload if the 'accept: multipart/mixed' header is specified in the request. The default output format is Rtf if this option is not specified.

  • (optional)
    string

    Any rendering options to customize the details of the comparison process and the formatting of the comparison document. Rendering options are best generated by creating a rendering set using the Workshare Compare desktop application. The contents of the saved '.set' file can be passed as the value for this parameter. Semicolons can be used in place of \r or \n as line separators in this parameter.

  • (optional)
    string

    The filename, Url or other location identifier for the original document. This will appear in the comparison summary table if it is shown. The text passed to this parameter should be an identifier for the document that will be familiar to the user - ie 'c:\documents\contract.docx'

  • (optional)
    string

    A description of the original document which will appear in the comparison summary table if it is shown

  • (optional)
    string

    The filename, Url or other location identifier for the modified document. This will appear in the comparison summary table if it is shown. The text passed to this parameter should be an identifier for the document that will be familiar to the user - ie 'c:\documents\contract.docx'

  • (optional)
    string

    A description of the modified document which will appear in the comparison summary table if it is shown

Request headers

  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

Responses

200 OK

OK

Representations

{
  "type": "object"
}
{
  "type": "object"
}
{
  "type": "object"
}
{
  "type": "object"
}
{
  "type": "object"
}
<ApiCompareGet200ApplicationVnd.openxmlformats-officedocument.wordprocessingml.documentResponse />
{
  "type": "object"
}

400 Bad Request

One or more of the URLs provided for the source documents is malformed, invalid or cannot be retrieved.

403 Forbidden

One or both of the documents is password protected and cannot be read.

422 Unprocessable Entity

The documents cannot be compared because they are corrupt or of an unsupported format, or an error has occurred while processing their content.

500 Internal Server Error

The server is incorrectly configured, unlicensed or an unexpected error has occurred.

503 Service Unavailable

The server is currently too busy to handle the request (and is configured to reject requests when too busy).

Code samples

@ECHO OFF

curl -v -X GET "https://api.workshare.net/apac/compare-service/api/Compare?originalSourceUrl=http://install.workshare.com/compare/SampleOriginal.doc&modifiedSourceUrl=http://install.workshare.com/compare/SampleModified.doc&outputFormat=Rtf&renderingOptions={string}&originalSource={string}&originalDescription={string}&modifiedSource={string}&modifiedDescription={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["originalSourceUrl"] = "http://install.workshare.com/compare/SampleOriginal.doc";
            queryString["modifiedSourceUrl"] = "http://install.workshare.com/compare/SampleModified.doc";
            queryString["outputFormat"] = "Rtf";
            queryString["renderingOptions"] = "{string}";
            queryString["originalSource"] = "{string}";
            queryString["originalDescription"] = "{string}";
            queryString["modifiedSource"] = "{string}";
            queryString["modifiedDescription"] = "{string}";
            var uri = "https://api.workshare.net/apac/compare-service/api/Compare?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://api.workshare.net/apac/compare-service/api/Compare");

            builder.setParameter("originalSourceUrl", "http://install.workshare.com/compare/SampleOriginal.doc");
            builder.setParameter("modifiedSourceUrl", "http://install.workshare.com/compare/SampleModified.doc");
            builder.setParameter("outputFormat", "Rtf");
            builder.setParameter("renderingOptions", "{string}");
            builder.setParameter("originalSource", "{string}");
            builder.setParameter("originalDescription", "{string}");
            builder.setParameter("modifiedSource", "{string}");
            builder.setParameter("modifiedDescription", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "originalSourceUrl": "http://install.workshare.com/compare/SampleOriginal.doc",
            "modifiedSourceUrl": "http://install.workshare.com/compare/SampleModified.doc",
            "outputFormat": "Rtf",
            "renderingOptions": "{string}",
            "originalSource": "{string}",
            "originalDescription": "{string}",
            "modifiedSource": "{string}",
            "modifiedDescription": "{string}",
        };
      
        $.ajax({
            url: "https://api.workshare.net/apac/compare-service/api/Compare?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://api.workshare.net/apac/compare-service/api/Compare";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"originalSourceUrl=http://install.workshare.com/compare/SampleOriginal.doc",
                         @"modifiedSourceUrl=http://install.workshare.com/compare/SampleModified.doc",
                         @"outputFormat=Rtf",
                         @"renderingOptions={string}",
                         @"originalSource={string}",
                         @"originalDescription={string}",
                         @"modifiedSource={string}",
                         @"modifiedDescription={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://api.workshare.net/apac/compare-service/api/Compare');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'originalSourceUrl' => 'http://install.workshare.com/compare/SampleOriginal.doc',
    'modifiedSourceUrl' => 'http://install.workshare.com/compare/SampleModified.doc',
    'outputFormat' => 'Rtf',
    'renderingOptions' => '{string}',
    'originalSource' => '{string}',
    'originalDescription' => '{string}',
    'modifiedSource' => '{string}',
    'modifiedDescription' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'originalSourceUrl': 'http://install.workshare.com/compare/SampleOriginal.doc',
    'modifiedSourceUrl': 'http://install.workshare.com/compare/SampleModified.doc',
    'outputFormat': 'Rtf',
    'renderingOptions': '{string}',
    'originalSource': '{string}',
    'originalDescription': '{string}',
    'modifiedSource': '{string}',
    'modifiedDescription': '{string}',
})

try:
    conn = httplib.HTTPSConnection('api.workshare.net')
    conn.request("GET", "/apac/compare-service/api/Compare?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'originalSourceUrl': 'http://install.workshare.com/compare/SampleOriginal.doc',
    'modifiedSourceUrl': 'http://install.workshare.com/compare/SampleModified.doc',
    'outputFormat': 'Rtf',
    'renderingOptions': '{string}',
    'originalSource': '{string}',
    'originalDescription': '{string}',
    'modifiedSource': '{string}',
    'modifiedDescription': '{string}',
})

try:
    conn = http.client.HTTPSConnection('api.workshare.net')
    conn.request("GET", "/apac/compare-service/api/Compare?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://api.workshare.net/apac/compare-service/api/Compare')

query = URI.encode_www_form({
    # Request parameters
    'originalSourceUrl' => 'http://install.workshare.com/compare/SampleOriginal.doc',
    'modifiedSourceUrl' => 'http://install.workshare.com/compare/SampleModified.doc',
    'outputFormat' => 'Rtf',
    'renderingOptions' => '{string}',
    'originalSource' => '{string}',
    'originalDescription' => '{string}',
    'modifiedSource' => '{string}',
    'modifiedDescription' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body