These examples assume "https://yourserver" is the base URL of your server



Searching Options

To search for Records by a key value only (global search)

https://yourserver/v4/searchvalue/{value}


To search for Records by a key value only (global search) within a specific Record Type

https://yourserver/v4/searchvalue/{value}?rtid=#


To search for Records by a field name and field value combination

https://yourserver/v4/searchfieldvalue/{field}/{value}


To search for Records of a specific Record Type by a field name and field value combination

https://yourserver/v4/searchrecordtypevalue/{recordTypeID}/{field}/{value}


To search for Records of a specific Record Type by a field name and field value combination and bring up a specific document

https://yourserver/v4/searchrecordtypevalue/{recordTypeID}/{field}/{value}/{docName}




Record Options

To bring up a known record directly

https://yourserver/v4/record/{recordID}


To bring up a known record directly and open a specific document by ID

https://yourserver/v4/record/{recordID}/{documentID}


To bring up a known record directly and open a specific document by name

https://yourserver/v4/record/{recordID}?DocCategory={cat}&DocSubCategory={subcat}&DocName={name}


To bring up a known record directly and start scanning into a category

https://yourserver/v4/record/{recordID}?op=Scan&DocCategory={cat}


To bring up a known record directly and open the Edit screen

https://yourserver/v4/record/{recordID}?entry=true


To bring up a known record directly and open the Split screen

https://yourserver/v4/record/{recordID}?split=true


To bring up a known record directly and open the Classify screen

https://yourserver/v4/record/{recordID}?classify=true


To bring up a known record directly and open the Re-Arrange Pages option for the opened Document

https://yourserver/v4/record/{recordID}?rearrange=true




Entry Options

To start the Entry process for a given Record Type by {RecordTypeID}:

https://yourserver/v4/entry/{RecordTypeID}



To start the Entry process for a given Record Type by {RecordTypeID} and default the Scan option to ON and the workflow option to OFF:

https://yourserver/v4/entry/{RecordTypeID}?scan=1&workflow=0


(Use 0 to turn OFF an option and 1 to turn it ON)


To clear the URL of any of the paramters passed in, use the clearurl paramter:

https://yourserver/v4/entry/{RecordTypeID}?scan=1&workflow=0&clearurl=1



Any URL parameters that are sent other than those documented will be put into any matching fields for entry. In this example, the field Vendor will have ACME placed into it and InvoiceNum will have 12345 placed into it.

https://yourserver/v4/entry/{RecordTypeID}?Vendor=ACME&InvoiceNum=12345






Messaging Options

To direct someone to the Home page with a special message (used mostly for E-form redirects where you don't want an internal user to go to the E-form after save but you want to show them a message)

https://yourserver/v4?Msg=Your+Message

       (Shows red bar with message - best used for error messages)

OR

https://yourserver/v4?Info=Your+Message

       (Shows blue bar with message - best used for informational messages)





For Version 3


To search for Records by a key value only (global search)

https://yourserver/searchvalue/{value}


To search for Records by a field name and field value combination

https://yourserver/searchfieldvalue/{field}/{value}


To search for Records of a specific Record Type by a field name and field value combination

https://yourserver/searchrecordtypevalue/{recordTypeID}/{field}/{value}


To search for Records of a specific Record Type by a field name and field value combination and bring up a specific document

https://yourserver/searchrecordtypevalue/{recordTypeID}/{field}/{value}/{docName}


To update the last viewed Record with new values:

https://yourserver/updatelast?{field}={value}&{field}={value}&{field}={value}...


To search for a Record based on multiple values

https://yourserver/searchonly?{field}={value}&{field}={value}&{field}={value}...


To search for a Record based on multiple values while specifying a Record Type ID

https://yourserver/searchonly/{recordTypeID}?{field}={value}&{field}={value}&{field}={value}...


To search for a Record and, if not found, add a new one with the specified index values

https://yourserver/searchadd?{field}={value}&{field}={value}&{field}={value}...


To search for a Record and, if not found, add a new one with the specified index values while specifying a Record Type ID

https://yourserver/searchadd/{recordTypeID}?{field}={value}&{field}={value}&{field}={value}...


To add a new Record without performing a search first

https://yourserver/addonly?{field}={value}&{field}={value}&{field}={value}...


To add a new Record while specifying a Record Type ID without performing a search first

https://yourserver/addonly/{recordTypeID}?{field}={value}&{field}={value}&{field}={value}...



To bring up a known record directly

https://yourserver/app/record/{recordID}


To bring up a known record directly and open a specific document

https://yourserver/app/record/{recordID}?DocCategory={cat}&DocSubCategory={subcat}&DocName={name}


To bring up a known record directly and start scanning into a category

https://yourserver/app/record/{recordID}?op=Scan&DocCategory={cat}


To bring up the last Record this user has viewed

https://yourserver/lastrecord


To bring up the last Record this user has viewed in a specific Record Type

https://yourserver/lastrecordbyrecordtype?id={recordTypeID}


To run the last Search this user has performed

https://yourserver/lastsearch


To direct someone to the Home page with a special message (used mostly for E-form redirects where you don't want an internal user to go to the E-form after save but you want to show them a message)

https://yourserver/App?Info=Your+Message

       (Shows blue bar with message)

OR

https://yourserver/App?Warning=Your+Message

       (Shows yellow bar with message)

OR

https://yourserver/App?Danger=Your+Message

       (Shows red bar with message)



Variable Key:


{recordTypeID} - The ID of the Record Type within which to search

{field} - The name of the field in which to search

{value} - The value by which to search{value} - The value by which to search

{docCategory} - The category of documents to search for. Records that have docs in this category will match.

{docSubCategory} - The subcategory of documents to search for. Records that have docs in this subcategory will match.

{docName} - The name of documents to search for. Records that have docs with this name will match.



Optional query string parameters:


hidetoolbar - If you set this value to 1, Y or YES (not case-sensitive) then the toolbar will be hidden from view for remainder of the session. However, you can get it back by adding hidetoolbar=0, N or NO. The last setting used will remain in effect until the browser is closed to end the cookie session.


op - The operation to start when the viewer is loaded on a single record search. The only option at this time is "scan" which will start the scanner if the user is on Windows. You can use this along with DocCategory, DocSubCategory and DocName to instruct the scanner as to which Category, SubCategory and Name to use for the scanned document.


docCategory - The Category of the document to open in the viewer. If used with the op=scan or scan1 parameter then that category is also sent to the scanning application.


docSubCategory - The Sub Category of the document to open in the viewer. If used with the op=scan or scan1 parameter then that sub category is also sent to the scanning application.


docName - The Name of the document to open in the viewer. If used with the op=scan or scan1 parameter then that nae is also sent to the scanning application.


FullText - The full text (OCR text) to search for during search URL calls.



IMPORTANT: Make sure to URL encode all variables to ensure they will pass through the browser without complications. If you need more information on URL encode please refer to this article: w3schools URLEncode Reference or the w3schools JavaScript encodeURI() reference.


       Common Replacements:

       Space = %20

       " = %22

               < = %3C

       > = %3E

               # = %23

       % = %25

               | = %7C


Full Chart

https://www.tutorialspoint.com/http/http_url_encoding.htm