}

/v1/processing/review/trackedchanges

https://api.reporting.cloud/v1/processing/review/trackedchanges

Returns the tracked changes of a document.

Authorization

This endpoint requires a "ReportingCloud-APIKey" or a "Basic" user authorization to access the user acount, data and templates. Only one of these two methods are required.

ReportingCloud-APIKey
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

An API Key needs to be generated using the portal or /v1/account/apikey endpoint. The authorization method and a space i.e. "ReportingCloud-APIKey " is then put before the actual API Key string.

Sample:

Authorization: ReportingCloud-APIKey oMDM4MrAqL9QEOpyzupnQW5NjvCNtvE5cVDaaLqxI

Basic
Header field Description
Authorization

Required. A valid ReportingCloud account is required. The Authorization field is constructed as follows:

The username and password are combined into a string separated by a colon, e.g.: username:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string.

Sample:

Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l


Request Payload

Value Type Description
Base64 encoded string The source document encoded as a Base64 string. Possible document formats are .rtf, .doc, .docx and .tx.

Success Response

Return Value Description

200 (OK)

On success, the HTTP status code in the response header is 200 (OK). The response body contains an array TrackedChange objects.

TrackedChange

Key Value Type Description
changeKind ChangeKind Gets the kind of the tracked change. Possible values: 4096 (InsertedText), 8192 (DeletedText).
changeTime DateTime Gets the time stamp of the tracked change.
defaultHighlightColor String Gets the default highlight color of tracked changes.
highlightColor String Gets the highlight color of the tracked change.
highlightMode HighlightMode Gets the highlight mode of the tracked change. Possible values: 1 (Never), 2 (Activated), 3 (Always).
length int Gets the length of the change.
start int Gets the start index of the change in the document.
id int Gets the unique id of the tracked change that can be used to remove the tracked change.
text String Gets the text of the tracked change.
userName String Gets the user name of the author for that tracked change.

Error Response

Return Value Description

403 (Forbidden)

A 403 (Forbidden) is returned, if the user is not authorized or the proofing quota is exceeded.

Sample Requests

Request:

Results: