1. PSIGEN Support Portal
  2. PSIcapture Administrator Guides (Configuration)
  3. Mailroom (Fusion) Administration

[LEGACY] PSIcapture Mailroom (Fusion) Administrator Guide: API Calls (PSIfusion 2.0)

Avatar
Joel Fernandez

Basics

The PSIcapture Mailroom (Fusion) API's default web path is http://{servername}/api/ where the server name is the DNS name or IP address of the PSIcapture Fusion server. PSIcapture Fusion API is designed for managing administrative tasks such as user and queue monitoring. Administrators can connect and develop using any preferred programming language. The default response is JSON but the server will also return XML if requested.

Authentication

PSIcapture Mailroom (Fusion) Web Services are authenticated using an API key. Keys are issued internally from the PSIcapture Mailroom (Fusion) server.

Document Type Information

API Call (All DocTypes):

GET /api/documentTypes

Description

Retrieves all document types from the database.

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
[ 
  {
    "created" : "2014-11-10T17:39:37.497+00:00",
    "description" : "test customer document types",
    "id" : 1,
    "name" : "CustomerDocTypes",
    "updated" : "2014-11-19T05:43:34.437+00:00"
  },
  { "created" : "2014-11-10T17:41:55.677+00:00",
    "description" : "Fusion Migration. Imported from Capture document type PSIC-5039.",
    "id" : 2,
    "name" : "PSIC-5039",
    "updated" : "2014-11-11T01:42:19.35+00:00"
  }
]

 

XML
<ArrayOfDocumentTypeDescriptor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
  <DocumentTypeDescriptor>
    <ID>1</ID>
    <Name>CustomerDocTypes</Name>
    <Description>test customer document types</Description>
    <Created xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2014-11-10T17:39:37.497Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Created>
    <Updated xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2014-11-19T05:43:34.437Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Updated>
  </DocumentTypeDescriptor>
  <DocumentTypeDescriptor>
    <ID>2</ID>
    <Name>PSIC-5039</Name>
    <Description>Fusion Migration. Imported from Capture document type PSIC-5039.</Description>
    <Created xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2014-11-10T17:41:55.677Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Created>
    <Updated xmlns:d3p1="http://schemas.datacontract.org/2004/07/System">
      <d3p1:DateTime>2014-11-11T01:42:19.35Z</d3p1:DateTime>
      <d3p1:OffsetMinutes>0</d3p1:OffsetMinutes>
    </Updated>
  </DocumentTypeDescriptor>
</ArrayOfDocumentTypeDescriptor>

 

API Call (DocTypes by ID):

GET /api/documentTypes/{documentTypeId}

Description

Returns document type by ID.

Parameters

documentTypeId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
{
  "id": 1,
  "name": "CustomerDocTypes",
  "description": "test customer document types",
  "created": "2014-11-10T17:39:37.497+00:00",
  "updated": "2014-11-19T05:43:34.437+00:00",
  "outputFolderName": "Customer",
  "fields": [
    {
      "id": 1,
      "name": "Field 1",
      "dataType": 0,
      "description": "",
      "isRequired": false,
      "isSkip": false,
      "isReadOnly": false,
      "isHidden": false,
      "isSticky": false,
      "isSynchronized": false,
      "isProtected": false,
      "minLength": 0,
      "maxLength": 0,
      "defaultValueType": 0,
      "defaultValueContent": "",
      "enableRegexValidation": false,
      "regexValidationPattern": ""
    },
    {
      "id": 3,
      "name": "Field 2",
      "dataType": 0,
      "description": "",
      "isRequired": false,
      "isSkip": false,
      "isReadOnly": false,
      "isHidden": false,
      "isSticky": false,
      "isSynchronized": false,
      "isProtected": false,
      "minLength": 0,
      "maxLength": 0,
      "defaultValueType": 0,
      "defaultValueContent": "",
      "enableRegexValidation": false,
      "regexValidationPattern": ""
    },
    {
      "id": 4,
      "name": "Field 3",
      "dataType": 1,
      "description": "",
      "isRequired": false,
      "isSkip": false,
      "isReadOnly": false,
      "isHidden": false,
      "isSticky": false,
      "isSynchronized": false,
      "isProtected": false,
      "minLength": 0,
      "maxLength": 0,
      "defaultValueType": 0,
      "defaultValueContent": "",
      "enableRegexValidation": false,
      "regexValidationPattern": ""
    }
  ]
}

 

XML
<?xml version="1.0" encoding="UTF-8"?>
<documenttype xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <id>1</id>
   <name>CustomerDocTypes</name>
   <description>test customer document types</description>
   <created xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
      <d2p1:datetime>2014-11-10T17:39:37.497Z</d2p1:datetime>
      <d2p1:offsetminutes>0</d2p1:offsetminutes>
   </created>
   <updated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
      <d2p1:datetime>2014-11-19T05:43:34.437Z</d2p1:datetime>
      <d2p1:offsetminutes>0</d2p1:offsetminutes>
   </updated>
   <outputfoldername>Customer</outputfoldername>
   <fields>
      <documenttypefield>
         <id>1</id>
         <name>Field 1</name>
         <datatype>Text</datatype>
         <description />
         <isrequired>false</isrequired>
         <isskip>false</isskip>
         <isreadonly>false</isreadonly>
         <ishidden>false</ishidden>
         <issticky>false</issticky>
         <issynchronized>false</issynchronized>
         <isProtected>false</isProtected>
         <minlength>0</minlength>
         <maxlength>0</maxlength>
         <defaultvaluetype>None</defaultvaluetype>
         <defaultvaluecontent />
         <enableregexvalidation>false</enableregexvalidation>
         <regexvalidationpattern />
      </documenttypefield>
      <documenttypefield>
         <id>3</id>
         <name>Field 2</name>
         <datatype>Text</datatype>
         <description />
         <isrequired>false</isrequired>
         <isskip>false</isskip>
         <isreadonly>false</isreadonly>
         <ishidden>false</ishidden>
         <issticky>false</issticky>
         <issynchronized>false</issynchronized>
         <isProtected>false</isProtected>
         <minlength>0</minlength>
         <maxlength>0</maxlength>
         <defaultvaluetype>None</defaultvaluetype>
         <defaultvaluecontent />
         <enableregexvalidation>false</enableregexvalidation>
         <regexvalidationpattern />
      </documenttypefield>
      <documenttypefield>
         <id>4</id>
         <name>Field 3</name>
         <datatype>Number</datatype>
         <description />
         <isrequired>false</isrequired>
         <isskip>false</isskip>
         <isreadonly>false</isreadonly>
         <ishidden>false</ishidden>
         <issticky>false</issticky>
         <issynchronized>false</issynchronized>
         <isProtected>false</isProtected>
         <minlength>0</minlength>
         <maxlength>0</maxlength>
         <defaultvaluetype>None</defaultvaluetype>
         <defaultvaluecontent />
         <enableregexvalidation>false</enableregexvalidation>
         <regexvalidationpattern />
      </documenttypefield>
   </fields>
</documenttype>

 

User Information

API Call (All Users):

GET /api/users

Description

Retrieves all user information from the database. This includes all connected user directories connected to Fusion.

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
[
  {
    "id": 1,
    "type": "User",
    "name": "User Queue 1 (System Administrator)",
    "isLocked": false,
    "lastImport": "2014-11-11T21:49:57.797",
    "hasIncoming": false,
    "hasQueued": true,
    "hasCompleted": true
  },
  {
    "id": 2,
    "type": "User",
    "name": "User Queue 2 (Michael)",
    "isLocked": false,
    "lastImport": "2014-11-11T21:49:57.807",
    "hasIncoming": true,
    "hasQueued": true,
    "hasCompleted": false
  },
  {
    "id": 3,
    "type": "User",
    "name": "User Queue 3 (MonkeyJumps)",
    "isLocked": false,
    "lastImport": "2014-11-11T21:49:57.8",
    "hasIncoming": false,
    "hasQueued": false,
    "hasCompleted": false
  }
]

 

XML
<arrayofqueue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
                    <queue>
                    <id>1</id>
                    <type>User</type>
                    <name>User Queue 1 (System Administrator)</name>
                    <islocked>false</islocked>
                    <lastimport>2014-11-11T21:49:57.797</lastimport>
                    <hasincoming>false</hasincoming>
                    <hasqueued>true</hasqueued>
                    <hascompleted>true</hascompleted>
  </queue>
                    <queue>
                    <id>2</id>
                    <type>User</type>
                    <name>User Queue 2 (Michael)</name>
                    <islocked>false</islocked>
                    <lastimport>2014-11-11T21:49:57.807</lastimport>
                    <hasincoming>true</hasincoming>
                    <hasqueued>true</hasqueued>
                    <hascompleted>false</hascompleted>
  </queue>
                    <queue>
                    <id>3</id>
                    <type>User</type>
                    <name>User Queue 3 (MonkeyJumps)</name>
                    <islocked>false</islocked>
                    <lastimport>2014-11-11T21:49:57.8</lastimport>
                    <hasincoming>false</hasincoming>
                    <hasqueued>false</hasqueued>
                    <hascompleted>false</hascompleted>
  </queue>
</arrayofqueue>

 

User Queue Information

API Call (User Document Queue):

GET /api/users/{queueId}/queued

Description

Retrieves a user's queued documents.

Parameters

QueueId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
[
  {
    "queueID": 1,
    "id": "D20141029T161751-CVBGTDCLF",
    "state": "Queued"
  },
  {
    "queueID": 1,
    "id": "D20141029T162720-CVTRYJUCB",
    "state": "Queued"
  },
  {
    "queueID": 1,
    "id": "D20141030T114548-CASWUGQYG",
    "state": "Queued"
  }
] 

 

XML
<ArrayOfDocumentDescriptor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
  <DocumentDescriptor>
    <QueueID>1</QueueID>
    <ID>D20141029T161751-CVBGTDCLF</ID>
    <State>Queued</State>
  </DocumentDescriptor>
  <DocumentDescriptor>
    <QueueID>1</QueueID>
    <ID>D20141029T162720-CVTRYJUCB</ID>
    <State>Queued</State>
  </DocumentDescriptor>
  <DocumentDescriptor>
    <QueueID>1</QueueID>
    <ID>D20141030T114548-CASWUGQYG</ID>
    <State>Queued</State>
  </DocumentDescriptor>
</ArrayOfDocumentDescriptor>

 

API Call (User Document Queue by Document ID):

GET /api/users/{queueId}/queued/{documentId}

Description

Retrieves a user's queued document by id.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
{
  "queueID": 1,
  "id": "D20141029T161751-CVBGTDCLF",
  "state": "Queued",
  "documentTypeName": null,
  "records": [
    {
      "recordNumber": 1,
      "fields": [
        {
          "name": "Field 1",
          "type": "Text",
          "value": ""
        }
      ]
    }
  ],
  "pages": [
    {
      "pageNumber": 1,
      "fileName": "000001.tif",
      "links": [
        {
          "rel": "download",
          "method": "GET",
          "href": "api/Users/1/Queued/D20141029T161751-CVBGTDCLF/Page/1"
        }
      ]
    }
  ],
  "links": [
    {
      "rel": "metadata",
      "method": "POST",
      "href": "api/Users/1/Queued/D20141029T161751-CVBGTDCLF/Metadata"
    }
  ]
} 

 

XML
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
  <Links>
    <Link>
      <rel>metadata</rel>
      <method>POST</method>
      <href>api/Users/1/Queued/D20141029T161751-CVBGTDCLF/Metadata</href>
    </Link>
  </Links>
  <QueueID>1</QueueID>
  <ID>D20141029T161751-CVBGTDCLF</ID>
  <State>Queued</State>
  <DocumentTypeName i:nil="true" />
  <Records>
    <DataRecord>
      <RecordNumber>1</RecordNumber>
      <Fields>
        <DataField>
          <Name>Field 1</Name>
          <Type>Text</Type>
          <Value></Value>
        </DataField>
      </Fields>
    </DataRecord>
  </Records>
  <Pages>
    <Page>
      <Links>
        <Link>
          <rel>download</rel>
          <method>GET</method>
          <href>api/Users/1/Queued/D20141029T161751-CVBGTDCLF/Page/1</href>
        </Link>
      </Links>
      <FileName>000001.tif</FileName>
      <PageNumber>1</PageNumber>
    </Page>
  </Pages>
</Document>

 

API Call (User Document Queue Metadata Info):

GET /api/users/{queueId}/queued/{documentId}/metadata

Description

Retrieves a user's queued document metadata information.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
{
  "Document": {
    "@DocumentTypeName": "Boolean Test",
    "@FusionVersion": "2.0.0.13",
    "@IdentityKey": "acb2ec8b-a388-402c-8f97-7015c8278eb3",
    "@OrganizationID": "1",
    "@IsIndexed": "true",
    "@IndexedOn": "2020-02-24T07:31:45.1493817-05:00",
    "@DocumentTypeID": "1",
    "@OutputFolderName": "boolean",

    "Capture": {
      "@BatchName": "20141029.161729",
      "@BatchPath": "E:\\temp\\Storage\\20141029.161729",
      "@FolderName": "20141029.1617318816",
      "@FolderPath": "E:\\temp\\Storage\\20141029.161729\\20141029.1617318816",
      "@DocumentName": "00000001",
      "@DocumentPath": "E:\\temp\\Storage\\20141029.161729\\20141029.1617318816\\00000001",
      "@DocumentGroup": "20018dae-2b20-4430-bcf1-93679dea2908",
      "@DocumentGroupEntry": "e3da5d8d-9387-419a-916f-07c3eeff969b"
    },
    "Pages": {
      "Page": {
        "@FileName": "000001.tif",
        "@ImageWidth": "1700",
        "@ImageHeight": "2200",
        "@TileWidth": "548",
        "@TileHeight": "548",
        "@TileLevels": "13"
      }
    },
    "Records": {
      "Record": {
        "Field": {
          "@Name": "Field 1",
          "@Type": "Text",
          "#cdata-section": ""
        }
      }
    }
  }
}

 

XML
<Document FusionVersion="2.0.0.13" IdentityKey="acb2ec8b-a388-402c-8f97-7015c8278eb3" OrganizationID="1">
  <Capture BatchName="20141029.161729" BatchPath="E:\temp\Storage\20141029.161729" FolderName="20141029.1617318816" FolderPath="E:\temp\Storage\20141029.161729\20141029.1617318816" DocumentName="00000001" DocumentPath="E:\temp\Storage\20141029.161729\20141029.1617318816\00000001" DocumentGroup="20018dae-2b20-4430-bcf1-93679dea2908" DocumentGroupEntry="e3da5d8d-9387-419a-916f-07c3eeff969b" />
  <Pages>
    <Page FileName="000001.tif" ImageWidth="1700" ImageHeight="2200" TileWidth="548" TileHeight="548" TileLevels="13" />
  </Pages>
  <Records>
    <Record>
      <Field Name="Field 1" Type="Text"><![CDATA[]]></Field>
    </Record>
  </Records>
</Document>

 

API Call (User Document Page by Page Number):

GET /api/users/{queueId}/queued/{documentId}/page/{pagenumber}

Description

Retrieves a user's queued document page by page number.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

PageNumber MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
byte stream.

 

API Call (User Document Queue: Completed):

GET /api/users/{queueId}/completed

Description

Retrieves all user's completed document's from a given queue.

Parameters

QueueId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
[
  {
    "queueID": 1,
    "id": "D20141029T160423-CUBDEXUXP",
    "state": "Completed"
  },
  {
    "queueID": 1,
    "id": "D20141029T160721-CUGWQNRXQ",
    "state": "Completed"
  }
]

 

XML
<ArrayOfDocumentDescriptor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
  <DocumentDescriptor>
    <QueueID>1</QueueID>
    <ID>D20141029T160423-CUBDEXUXP</ID>
    <State>Completed</State>
  </DocumentDescriptor>
  <DocumentDescriptor>
    <QueueID>1</QueueID>
    <ID>D20141029T160721-CUGWQNRXQ</ID>
    <State>Completed</State>
  </DocumentDescriptor>
</ArrayOfDocumentDescriptor>

 

API Call (User Document Queue: Completed by ID):

GET /api/users/{queueId}/completed/{documentId}

Description

Retrieves a user's completed queued document by id.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
{
   "queueID":1,
   "id":"D20141029T160423-CUBDEXUXP",
   "state":"Completed",
   "documentTypeName":"CustomerDocTypes",
   "records":[
      {
         "recordNumber":1,
         "fields":[
            {
               "name":"Field 1",
               "type":"Text",
               "value":"dfdfdfdfd"
            }
         ]
      }
   ],
   "pages":[
      {
         "pageNumber":1,
         "fileName":"000001.tif",
         "links":[
            {
               "rel":"download",
               "method":"GET",
               "href":"api/Users/1/Completed/D20141029T160423-CUBDEXUXP/Page/1"
            }
         ]
      }
   ],
   "links":[
      {
         "rel":"metadata",
         "method":"POST",
         "href":"api/Users/1/Completed/D20141029T160423-CUBDEXUXP/Metadata"
      }
   ]
}

 

XML
<Document xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
  <Links>
    <Link>
      <rel>metadata</rel>
      <method>POST</method>
      <href>api/Users/1/Completed/D20141029T160423-CUBDEXUXP/Metadata</href>
    </Link>
  </Links>
  <QueueID>1</QueueID>
  <ID>D20141029T160423-CUBDEXUXP</ID>
  <State>Completed</State>
  <DocumentTypeName>CustomerDocTypes</DocumentTypeName>
  <Records>
    <DataRecord>
      <RecordNumber>1</RecordNumber>
      <Fields>
        <DataField>
          <Name>Field 1</Name>
          <Type>Text</Type>
          <Value>dfdfdfdfd</Value>
        </DataField>
      </Fields>
    </DataRecord>
  </Records>
  <Pages>
    <Page>
      <Links>
        <Link>
          <rel>download</rel>
          <method>GET</method>
          <href>api/Users/1/Completed/D20141029T160423-CUBDEXUXP/Page/1</href>
        </Link>
      </Links>
      <FileName>000001.tif</FileName>
      <PageNumber>1</PageNumber>
    </Page>
  </Pages>
</Document>

 

API Call (User Document Queue: Metadata by ID):

GET /api/users/{queueId}/completed/{documentId}/metadata

Description

Retrieves a user's completed queued document metadata by id.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
{
  "Document": {
    "@FusionVersion": "2.0.0.13",
    "@IdentityKey": "acb2ec8b-a388-402c-8f97-7015c8278eb3",
    "@OrganizationID": "1",
    "@IsIndexed": "true",
    "@IndexedOn": "2014-11-10T16:44:52.1516869-08:00",
    "@DocumentTypeID": "1",
    "@DocumentTypeName": "CustomerDocTypes",
    "@OutputFolderName": "Customer",
    "Capture": {
      "@BatchName": "20141029.160345",
      "@BatchPath": "E:\\temp\\Storage\\20141029.160345",
      "@FolderName": "20141029.1603497864",
      "@FolderPath": "E:\\temp\\Storage\\20141029.160345\\20141029.1603497864",
      "@DocumentName": "00000001",
      "@DocumentPath": "E:\\temp\\Storage\\20141029.160345\\20141029.1603497864\\00000001",
      "@DocumentGroup": "517bed61-27ef-4910-a954-a16beb9cc6d5",
      "@DocumentGroupEntry": "24dd4ba0-afbb-46b0-8d41-880f06395715"
    },
    "Pages": {
      "Page": {
        "@FileName": "000001.tif",
        "@ImageWidth": "1700",
        "@ImageHeight": "2200",
        "@TileWidth": "548",
        "@TileHeight": "548",
        "@TileLevels": "13"
      }
    },
    "Records": {
      "Record": {
        "Field": {
          "@Name": "Field 1",
          "@Type": "Text",
          "#cdata-section": "dfdfdfdfd"
        }
      }
    }
  }
}

 

XML
<Document FusionVersion="2.0.0.13" IdentityKey="acb2ec8b-a388-402c-8f97-7015c8278eb3" OrganizationID="1" IsIndexed="true" IndexedOn="2014-11-10T16:44:52.1516869-08:00" DocumentTypeID="1" DocumentTypeName="CustomerDocTypes" OutputFolderName="Customer">
  <Capture BatchName="20141029.160345" BatchPath="E:\temp\Storage\20141029.160345" FolderName="20141029.1603497864" FolderPath="E:\temp\Storage\20141029.160345\20141029.1603497864" DocumentName="00000001" DocumentPath="E:\temp\Storage\20141029.160345\20141029.1603497864\00000001" DocumentGroup="517bed61-27ef-4910-a954-a16beb9cc6d5" DocumentGroupEntry="24dd4ba0-afbb-46b0-8d41-880f06395715" />
  <Pages>
    <Page FileName="000001.tif" ImageWidth="1700" ImageHeight="2200" TileWidth="548" TileHeight="548" TileLevels="13" />
  </Pages>
  <Records>
    <Record>
      <Field Name="Field 1" Type="Text"><![CDATA[dfdfdfdfd]]></Field>
    </Record>
  </Records>
</Document>

 

API Call (User Document Queue: Completed Page by Page Number):

GET /api/users/{queueId}/completed/{documentId}/page/{pagenumber}

Description

Retrieves a user's completed document page by page number.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

PageNumber MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
byte stream.

 

Team Information

API Call (All Team Information):

GET /api/teams

Description

Retrieves all team information.

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
[
  {
    "id": 1,
    "type": "User",
    "name": "Team Queue 1 (System Team)",
    "isLocked": false,
    "lastImport": null,
    "hasIncoming": false,
    "hasQueued": false,
    "hasCompleted": false
  },
  {
    "id": 2,
    "type": "User",
    "name": "Team Queue 2 (QA)",
    "isLocked": false,
    "lastImport": null,
    "hasIncoming": false,
    "hasQueued": false,
    "hasCompleted": false
  }
]

 

XML
<ArrayOfQueue>
 <Queue>
<ID>1</ID>
<Type>User</Type>
<Name>Team Queue 1 (System Team)</Name>
<IsLocked>false</IsLocked>
<LastImport i:nil="true" />
<HasIncoming>false</HasIncoming>
<HasQueued>false</HasQueued>
<HasCompleted>false</HasCompleted>
 </Queue>
 <Queue>
<ID>2</ID>
<Type>User</Type>
<Name>Team Queue 2 (QA)</Name>
<IsLocked>false</IsLocked>
<LastImport i:nil="true" />
<HasIncoming>false</HasIncoming>
<HasQueued>false</HasQueued>
<HasCompleted>false</HasCompleted>
 </Queue>
 </ArrayOfQueue>

 

Shared Endpoints

API Call (Queue by ID):

GET /api/users/{queueId}

GET /api/teams/{queueId}

Description

Retrieves queue by id.

Parameters

QueueId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
{
  "id": 1,
  "type": "User",
  "name": "Team Queue 1 (System Team)",
  "isLocked": false,
  "lastImport": null,
  "hasIncoming": false,
  "hasQueued": false,
  "hasCompleted": false,
  "links": [    
    {
      "rel": "get-queued",
      "method": "GET",
      "href": "api/Teams/1/Queued"
    },
    {
      "rel": "get-completed",
      "method": "GET",
      "href": "api/Teams/1/Completed"
    }
  ]
}

 

XML
<Queue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
  <Links>    
    <Link>
      <rel>get-queued</rel>
      <method>GET</method>
      <href>api/Teams/1/Queued</href>
    </Link>
    <Link>
      <rel>get-completed</rel>
      <method>GET</method>
      <href>api/Teams/1/Completed</href>
    </Link>
  </Links>
  <ID>1</ID>
  <Type>User</Type>
  <Name>Team Queue 1 (System Team)</Name>
  <IsLocked>false</IsLocked>
  <LastImport i:nil="true" />
  <HasIncoming>false</HasIncoming>
  <HasQueued>false</HasQueued>
  <HasCompleted>false</HasCompleted>
</Queue>

 

API Call (Create New Incoming Document):

POST /api/users/{queueId}/incoming

POST /api/teams/{queueId}/incoming

Description

Creates new incoming document.

Parameters

QueueId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
{
  "queueID": 1,
  "id": "89c83208-e05e-43d9-b018-69c81866dcc4",
  "state": "New",
  "links": [
    {
      "rel": "set-group",
      "method": "PUT",
      "href": "api/Teams/1/Incoming/89c83208-e05e-43d9-b018-69c81866dcc4/SetGroup"
    },
    {
      "rel": "add-record",
      "method": "PUT",
      "href": "api/Teams/1/Incoming/89c83208-e05e-43d9-b018-69c81866dcc4/AddRecord"
    },
    {
      "rel": "add-page",
      "method": "PUT",
      "href": "api/Teams/1/Incoming/89c83208-e05e-43d9-b018-69c81866dcc4/AddPage"
    },
    {
      "rel": "submit",
      "method": "PUT",
      "href": "api/Teams/1/Incoming/89c83208-e05e-43d9-b018-69c81866dcc4/Submit"
    },
    {
      "rel": "delete",
      "method": "DELETE",
      "href": "api/Teams/1/Incoming/89c83208-e05e-43d9-b018-69c81866dcc4"
    }
  ]
}

 

XML
<DocumentDescriptor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
  <Links>
    <Link>
      <rel>set-group</rel>
      <method>PUT</method>
      <href>api/Teams/1/Incoming/d6190d30-27f4-4aba-8057-79fed55d00ed/SetGroup</href>
    </Link>
    <Link>
      <rel>add-record</rel>
      <method>PUT</method>
      <href>api/Teams/1/Incoming/d6190d30-27f4-4aba-8057-79fed55d00ed/AddRecord</href>
    </Link>
    <Link>
      <rel>add-page</rel>
      <method>PUT</method>
      <href>api/Teams/1/Incoming/d6190d30-27f4-4aba-8057-79fed55d00ed/AddPage</href>
    </Link>
    <Link>
      <rel>submit</rel>
      <method>PUT</method>
      <href>api/Teams/1/Incoming/d6190d30-27f4-4aba-8057-79fed55d00ed/Submit</href>
    </Link>
    <Link>
      <rel>delete</rel>
      <method>DELETE</method>
      <href>api/Teams/1/Incoming/d6190d30-27f4-4aba-8057-79fed55d00ed</href>
    </Link>
  </Links>
  <QueueID>1</QueueID>
  <ID>d6190d30-27f4-4aba-8057-79fed55d00ed</ID>
  <State>New</State>
</DocumentDescriptor>

 

API Call (Grouping):

PUT /api/users/{queueId}/incoming/{documentId}/setGroup?groupId={groupId}

PUT /api/teams/{queueId}/incoming/{documentId}/setGroup?groupId={groupId}

Description

Enables grouping.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

GroupId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Content-type MANDATORY:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Content-type:application/json
Returns
Response does not contain any data.

 

API Call (Record Data):

PUT /api/users/{queueId}/incoming/{documentId}/addRecord

PUT /api/teams/{queueId}/incoming/{documentId}/addRecord

Description

Adds record data to the given document.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Content-type MANDATORY:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Content-type:application/json

 

Body
[
  {
    "Name": "Field1",
    "Type":"Number",
    "Value": "1"
  },
{
    "Name": "Field2",
    "Type": "Text",
    "Value": "test value"
  }
]
Returns
Response does not contain any data.

 

API Call (Content Type):

PUT /api/users/{queueId}/incoming/{documentId}/addPage?fileName={fileName}

PUT /api/teams/{queueId}/incoming/{documentId}/addPage?fileName={fileName}

Description

Upload the given content type and associate with a document.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

fileName MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Content-type MANDATORY:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Content-Type: image/tiff

 

Body
required The file contents to be uploaded. Since the entire PUT body will be treated as the file, any parameters must be passed as part of the request URL.
Returns
Response does not contain any data.

 

API Call (Attach Images):

PUT /api/users/{queueId}/incoming/{documentId}/submit

PUT /api/teams/{queueId}/incoming/{documentId}/submit

Description

Attach images to document store.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
JSON
{
  "queueID": 1,
  "id": "D20141119T122040-CDIPGTSVY",
  "state": "Queued"
}

 

XML
<DocumentDescriptor xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PSIGEN.Fusion.API.Models">
  <QueueID>1</QueueID>
  <ID>D20141119T122040-CDIPGTSVY</ID>
  <State>Queued</State>
</DocumentDescriptor>

 

API Call (Delete Document):

DELETE /api/users/{queueId}/incoming/{documentId}

DELETE /api/teams/{queueId}/incoming/{documentId}

Description

Deletes document and associated pages.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
Response does not contain any data.

 

API Call (Set Document Type):

PUT /api/users/{queueId}/Incoming/{documentId}/SetDocumentType

PUT /api/teams/{queueId}/Incoming/{documentId}/SetDocumentType

Description

Save document type name.

Parameters

QueueId MANDATORY:

DocumentId MANDATORY:

Headers

Sample authorization Header. Please note ApiKey preceeds id value.

Authorization MANDATORY:

Accept OPTIONAL:

Authorization: ApiKey a912b1c6-ec20-431b-856a-8ed91bce3cb9
Accept: application/xml
Returns
Response does not contain any data.

 

 

Was this article helpful?
0 out of 0 found this helpful

Comments

0 comments

Article is closed for comments.

Related articles