POST api/DOSConnect?MtgApplicationID={MtgApplicationID}&SiteId={SiteId}&DBName={DBName}

Request Information

URI Parameters

Name	Type	Additional information
MtgApplicationID	integer	Required
SiteId	string	Required
DBName	string	Required

Body Parameters

ClassificationOutput

Name	Type	Additional information
BatchGUID	globally unique identifier	None.
Files	Collection of ClassificationFileOutput	None.
Metrics	Metrics	None.

Request Formats

application/json, text/json

Sample:

{
  "BatchGUID": "c8f157c0-9b26-4415-89f2-7b0fdb75ded7",
  "Files": [
    {
      "FileGUID": "5f5b01fb-46fe-44d1-a508-46b2a33b786c",
      "ParentFileGUID": "917c86b1-45f7-421b-b2c3-e70ab22d32d1",
      "MergedFileGUID": "d12fd1a6-9dae-4be7-a4b0-5d4c72541c17",
      "Source": "sample string 2",
      "Filename": "sample string 3",
      "DocType": "sample string 4",
      "Name": "sample string 5",
      "Metadata": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    },
    {
      "FileGUID": "5f5b01fb-46fe-44d1-a508-46b2a33b786c",
      "ParentFileGUID": "917c86b1-45f7-421b-b2c3-e70ab22d32d1",
      "MergedFileGUID": "d12fd1a6-9dae-4be7-a4b0-5d4c72541c17",
      "Source": "sample string 2",
      "Filename": "sample string 3",
      "DocType": "sample string 4",
      "Name": "sample string 5",
      "Metadata": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      }
    }
  ],
  "Metrics": {
    "LatencyMs": 1,
    "InputTokens": 2,
    "OutputTokens": 3,
    "Pages": 4,
    "Size": 5
  }
}

application/xml, text/xml

Sample:

<ClassificationOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.AI">
  <BatchGUID>c8f157c0-9b26-4415-89f2-7b0fdb75ded7</BatchGUID>
  <Files>
    <ClassificationFileOutput>
      <DocType>sample string 4</DocType>
      <FileGUID>5f5b01fb-46fe-44d1-a508-46b2a33b786c</FileGUID>
      <Filename>sample string 3</Filename>
      <MergedFileGUID>d12fd1a6-9dae-4be7-a4b0-5d4c72541c17</MergedFileGUID>
      <Metadata xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Metadata>
      <Name>sample string 5</Name>
      <ParentFileGUID>917c86b1-45f7-421b-b2c3-e70ab22d32d1</ParentFileGUID>
      <Source>sample string 2</Source>
    </ClassificationFileOutput>
    <ClassificationFileOutput>
      <DocType>sample string 4</DocType>
      <FileGUID>5f5b01fb-46fe-44d1-a508-46b2a33b786c</FileGUID>
      <Filename>sample string 3</Filename>
      <MergedFileGUID>d12fd1a6-9dae-4be7-a4b0-5d4c72541c17</MergedFileGUID>
      <Metadata xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Metadata>
      <Name>sample string 5</Name>
      <ParentFileGUID>917c86b1-45f7-421b-b2c3-e70ab22d32d1</ParentFileGUID>
      <Source>sample string 2</Source>
    </ClassificationFileOutput>
  </Files>
  <Metrics>
    <InputTokens>2</InputTokens>
    <LatencyMs>1</LatencyMs>
    <OutputTokens>3</OutputTokens>
    <Pages>4</Pages>
    <Size>5</Size>
  </Metrics>
</ClassificationOutput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClassificationOutput'.

Response Information

Resource Description

ClassificationAckOutput

Name	Description	Type	Additional information
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<ClassificationAckOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.AI">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
</ClassificationAckOutput>