Trendsic Platform Service

<back to all web services

DocumentOCRNotificationRequest

The following routes are available for this service:
POST, PUT/v1/DocumentOCRNotification
"use strict";
export class DocumentOCRNotificationResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Success?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    Success;
}
export class DocumentOCRNotificationRequest {
    /** @param {{jobId?:string,status?:string,sourceDocument?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    jobId;
    /** @type {string} */
    status;
    /** @type {string} */
    sourceDocument;
}

JavaScript DocumentOCRNotificationRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/DocumentOCRNotification HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	jobId: String,
	status: String,
	sourceDocument: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Success: False
}