{{log}}

{{name}}

ENDPOINT: /OCRWeb/v2/

{{summary}}

{{key}}:
Available Tags: {{index===getAllTags.length-1? tag:tag+", "}}
Paths
No results containing all your search terms were found
{{api.path}}
{{method.name}} {{api.path}}
{{tag}}
Summary

{{method.summary}}

Description

{{method.desc}}

Parameters
Name Located In Description Required Schema

{{param.name}}

{{param.location}}

{{param.desc}}

{{param.required ? 'Yes':'No'}}

Responses
Code Description Schema

{{res.code}}

{{res.desc}}

Response Example
{{code}} 

                                                            

                                                        

                                                    

                                                


                                                

                                                    mode_editTry this operation
                                                    Hide
                                                


                                                
                                                    

                                                        
Request

                                                        

                                                            
Scheme

                                                            

                                                                
                                                                    
                                                                    
                                                                
                                                            

                                                            
HTTP Headers

                                                            

                                                                
                                                                    
                                                                    
                                                                    
                                                                
                                                                
                                                                    

                                                                        Name
                                                                        Value
                                                                        Action
                                                                    

                                                                
                                                                
                                                                    

                                                                        {{key}}
                                                                        
                                                                        Remove
                                                                    

                                                                
                                                            

                                                            

                                                                

                                                                    
                                                                    
                                                                

                                                                

                                                                    
                                                                    
                                                                

                                                                

                                                                    add
                                                                

                                                            

                                                            
Parameters

                                                            

                                                                

                                                                    

                                                                        

                                                                            {{param.name}}
                                                                            
                                                                        

                                                                        

                                                                            
                                                                        

                                                                    

                                                                    

                                                                        
                                                                        
                                                                    

                                                                

                                                                

                                                                    
                                                                    
                                                                

                                                                
Request

                                                                

                                                                    {{method.name.toUpperCase()}} {{getURL(method,api.path)}} HTTP/1.1
                                                                    
Host: {{host}}

                                                                    
User-Agent: {{userAgent}}

                                                                    
{{key}}: {{value}}

                                                                    
{{computeBody(method)}}

                                                                


                                                                
Response

                                                                

                                                                    
                                                                


                                                                

                                                                    
 warning This is a Mixed Content call. Many browsers will block this by default. Learn more

                                                                

                                                                

                                                                    
 warning This is a cross-origin call. Make sure the server at {{getDestHost(method.request.choosen.scheme)}} accepts POST requests from {{currentHost}}. Learn more

                                                                

                                                                Send Request
                                                                
                                                                    
                                                                        Download
                                                                        Preview
                                                                    
                                                                
                                                            

                                                        

                                                    

                                                
                                            

                                        

                                    
                                

                            

                        
                    

                

            

        

    

	
	
	
	
	
	

		
Launching the TCM HTML5 Viewer

			

			
The TCM HTML5 viewer is launched by passing a query parameter in the URL. The query parameter is first base64 encoded and then URL encoded.

			
Example:

			
http://tcm-ocr-dbk:6080/ocrgospel/viewer/index.html?query=VENNUmVkYWN0aW9uTW9kZXxUQ01ERUxJTXxhZG1pbnxUQ01ERUxJTXxhZG1pbnxUQ01ERUxJTXxDSkdvc3BlbDU1

			
To programmatically generate the query parameter, it is important to know what the parameter structure looks like.  Prior to encoding, the above query parameter looks like this:

			

			
TCMRedactionMode|TCMDELIM|eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0.yRQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw|TCMDELIM|CJGospel55

			

			
			
Arguments are separated by the string literal |TCMDELIM|

			
			
Contents of each argument

			
    
				
  1. 
					
    Viewer Mode
    
					
    Example: TCMRedactionMode
    
					
    The Viewer Mode parameter must always be set to "TCMRedactionMode"
    
				
    2. 
				
  2. 
					
    Security Token
    
					
    Example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ0b3B0YWwuY29tIiwiZXhwIjoxNDI2NDIwODAwLCJodHRwOi8vdG9wdGFsLmNvbS9qd3RfY2xhaW1zL2lzX2FkbWluIjp0cnVlLCJjb21wYW55IjoiVG9wdGFsIiwiYXdlc29tZSI6dHJ1ZX0.yRQYnWzskCZUxPwaQupWkiUzKELZ49eM7oWxAQK_ZXw
    
					
    This required JSON Web Token must be requested separately.
    
				
    3. 
				
  3. 
					
    Document Number
    
					
    Example: CJGospel55
    
					
    The Document Number is caller-assigned during document creation (POST /Documents).
    
				
    4. 
			

		

		
		

			
Tyler Web Service Security API

			
Endpoint: /Security/v1/

			

				
Paths

				
				
/GenerateJwt

				

					

						
GET /GenerateJwt

					

					

						
Summary

						
Fetch a JWT (JSON Web Token) to open the HTML5 viewer.

					
						

						

						Name 
						Located In 
						Description 
						Required 
						Schema
						
 
						
						

							
body
 
							
body
 
							
Action parameters
 
							
Yes
 
							
{
	"Type": "string", /* must be the string literal "editRedactions" */
	"Scope": {
		"DocumentNumber": "string" /* caller-assigned during document creation (Post /Documents) */
	},
	"AuditId": "string" /* caller-specified for auditing purposes */
}

						

						

						
Responses

						
						
						

						
Code Description Schema
 
						
							
200
 
Success
 
"string" // JWT encoded as string


							

							

								
default
 
								
Error
 
								


{
   "error": {     /* Main error */
      "code": "string",     /* Machine-readable sub-status for the HTTP error code of the response */
      "message": "string",     /* Human-readable, language-dependent error message */
      "target": "string",     /* Target of the particular error, for example the name of the property in error */
      "details": [     /* List of error details */
         {     /* Error detail */
            "code": "string",     /* Machine-readable sub-status for the HTTP error code of the response */
            "message": "string",     /* Human-readable, language-dependent error message */
            "target": "string"     /* Target of the particular error, for example the name of the property in error */
         }
      ],
      "innererror": {     /* The structure of this object is service-specific */
      }
   }
}