Ocrolus API

Ocrolus API Documentation

Welcome to Ocrolus' API Documentation. You'll find comprehensive guides and documentation here to help you get started with the Ocrolus API. Let's jump right in!

{

Attribute

Data Type

Description

pk

Table PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints.

columns

List of Column Metadata

See below for details

rows

List of Row Data

See below for details

}

{
  "pk": 2020,
  "columns": [
    {
      "alias_used": "Total",
      "column_id": "total"
    },
    {
      "alias_used": "Description",
      "column_id": "description"
    },
    {
      "alias_used": "Quantity",
      "column_id": "quantity"
    },
    {
      "alias_used": "Ref Number",
      "column_id": "refNumber"
    },
    {
      "alias_used": "Unit Price",
      "column_id": "unitPrice"
    },
    {
      "alias_used": "Item Number",
      "column_id": "itemNumber"
    }
  ],
  "rows": [
    {
      "page_idx": 0,
      "page_doc_pk": 12345,
      "cells": {
        "total": {
          "value": "1000.00"
        },
        "description": {
          "value": "Item 1 Description"
        },
        "quantity": {
          "value": "1"
        },
        "refNumber": {
          "value": "ITEM #001"
        },
        "unitPrice": {
          "value": "1000.00"
        },
        "itemNumber": {
          "value": "10"
        }
      }
    },
    {
      "page_idx": 0,
      "page_doc_pk": 12345,
      "cells": {
        "total": {
          "value": "2000.00"
        },
        "description": {
          "value": "Item 2 Description"
        },
        "quantity": {
          "value": "4"
        },
        "refNumber": {
          "value": "ITEM #002"
        },
        "unitPrice": {
          "value": "500.00"
        },
        "itemNumber": {
          "value": "10"
        }
      }
    }
    //, ...
  ]
}

Column Metadata

The list will contain one object for every column in the table.

{

Attribute

Data Type

Description

column_id

String

Unique ID for this column within this Form

alias_used

String

Text of column header if it does not exactly match the column_id. The value is null if not applicable.

}

Row Data

This is the data captured in the body of the Table. The list will contain one object for every row of data captured

{

Attribute

Data Type

Description

page_idx

Integer

Zero-based page index on which this row was captured.

page_doc_pk

Page PKPK - PK stands for Primary Key, a unique value assigned to specific objects. A PK is used to identify an object using one of the Query Endpoints.

cells

Cell Data

A map of field names to Cell objects. Each Cell object has a value attribute providing captured data.

}

Updated about a year ago


Table


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.