Search Barcode Signature

Note
Note:  The features listed on this page are supported only in GroupDocs.Signature Cloud V1

GroupDocs.Signature Cloud REST API supports to search Barcode signatures in supported document formats. It provides method to search Barcode Signature in Document Pages with different options barcodeType, Name, text, matchType and other search features by using Search Options Object data in request body.

Search Barcode Signature

You can search Barcode Signature on Document provided by fileName and document folder (if required) using following API. It expects Search Options Object data in request body.

It returns an object which contains document name, folder location and search result.

Resource

The following GroupDocs.Signature Cloud REST API resource has been used in the example to search Barcode signature in a document.

cURL example

curl --request POST \
--url http://api.groupdocs.cloud/v1/signature/SignedForVerificationAll.xlsx/barcode/search?folder#signed \
--header 'authorization: [Access Token]' \
--header 'content-type: application/json' \
--data '{ "barcodeTypeName": "Code39Standard", "text": "123456789012", "matchType": "Contains", "documentPageNumber": 1, "pagesSetup": { "firstPage": true, "lastPage": false, "oddPages": false, "evenPages": false, "pageNumbers": [ 1 ] }, "searchAllPages": true, "OptionsType": "CellsSearchBarcodeOptionsData" }'
{
  "signatures": [
    {
      "barcodeTypeName": "Code39Standard",
      "text": "123456789012",
      "signatureType": "CellsBarcodeSignatureData"
    },
    {
      "barcodeTypeName": "Code39Standard",
      "text": "123456789012",
      "signatureType": "CellsBarcodeSignatureData"
    }
  ],
  "fileName": "SignedForVerificationAll.xlsx",
  "folder": "cells",
  "code": 200,
  "status": "OK"
}

SDK examples

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

Search Barcode Signature in Document at Provided URL

You can search Barcode Signature for a Document at provided URL using following API.

It retrieves file from specified URL and tries to detect file type when fileName parameter is not specified. It expects search-options-objects object data in request body.

Based on passed Search Options settings proceeds with Document searching, it returns object which contains result of searching process.

Resource

The following GroupDocs.Signature Cloud REST API resource has been used in the example to search Barcode signature in a document at provided URL.

cURL example

curl --request POST \
--url http://api.groupdocs.cloud/v1/signature/barcode/search?url#https%3a%2f%2fwww.dropbox.com%2fs%2fumokluz338w4ng7%2fone-page.docx%3fdl%3d1 \
--header 'authorization: [Access Token]' \
--header 'content-type: application/json' \
--data '{ "BarcodeTypeName" : "Code128",  "MatchType" : "Contains",  "DocumentPageNumber": 1,  "Text": "John Smith",  "SearchAllPages" : true,  "OptionsType" : "WordsSearchBarcodeOptionsData" }'
{
  "fileName": "one-page.docx",
  "folder": "Output",
  "Code": "OK",
  "Status" : "OK",
  "Signatures" : [
    { BarcodeTypeName: "Code128", Text: "John Smith" },
    { BarcodeTypeName: "Code128", Text: "John Smith esq." }
    ]
}

SDK examples

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.