POST api/Document/StartProcess?clientToken={clientToken}

Request Information

URI Parameters

Name	Description	Type	Additional information
clientToken		string	Required

Body Parameters

Documentation

Name	Type	Additional information
Client	string	None.
DocumentAttachmentMapping	Collection of DocumentAttachmentMapping	None.
CountryID	integer	None.
RegionID	integer	None.
OrganisationID	integer	None.
Islocal	string	None.
HtmlString	string	None.
HtmlFileName	string	None.
DocumentProcessRequestID	integer	None.
DocumentProcessID	integer	None.
TaxYearID	integer	None.
FileSelectTypeID	integer	None.
Comments	string	None.
UserID	integer	None.
StepNumber	integer	None.
HeaderFilePath	string	None.
ErrorFilePath	string	None.
TaskName	string	None.
Email	string	None.
ProcessStartTS	date	None.
ProcessEndTS	date	None.
LocalTemplateId	integer	None.
Status	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "client": "sample string 1",
  "documentAttachmentMapping": [
    {
      "attachmentID": 1,
      "attachmentType": "sample string 2",
      "label": "sample string 3",
      "sortOrder": 4
    },
    {
      "attachmentID": 1,
      "attachmentType": "sample string 2",
      "label": "sample string 3",
      "sortOrder": 4
    }
  ],
  "countryID": 1,
  "regionID": 1,
  "organisationID": 2,
  "islocal": "sample string 3",
  "htmlString": "sample string 4",
  "htmlFileName": "sample string 5",
  "documentProcessRequestID": 6,
  "documentProcessID": 7,
  "taxYearID": 8,
  "fileSelectTypeID": 1,
  "comments": "sample string 9",
  "userID": 10,
  "stepNumber": 11,
  "headerFilePath": "sample string 12",
  "errorFilePath": "sample string 13",
  "taskName": "sample string 14",
  "email": "sample string 15",
  "processStartTS": "2026-01-13T05:05:56.0657704+00:00",
  "processEndTS": "2026-01-13T05:05:56.0657704+00:00",
  "localTemplateId": 16,
  "status": 1
}

application/xml, text/xml

Sample:

<Documentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transportal.BAL.Documentation">
  <Client>sample string 1</Client>
  <Comments>sample string 9</Comments>
  <CountryID>1</CountryID>
  <DocumentAttachmentMapping xmlns:d2p1="http://schemas.datacontract.org/2004/07/Transportal.BAL.Models.Documentation">
    <d2p1:DocumentAttachmentMapping>
      <d2p1:AttachmentID>1</d2p1:AttachmentID>
      <d2p1:AttachmentType>sample string 2</d2p1:AttachmentType>
      <d2p1:Label>sample string 3</d2p1:Label>
      <d2p1:SortOrder>4</d2p1:SortOrder>
    </d2p1:DocumentAttachmentMapping>
    <d2p1:DocumentAttachmentMapping>
      <d2p1:AttachmentID>1</d2p1:AttachmentID>
      <d2p1:AttachmentType>sample string 2</d2p1:AttachmentType>
      <d2p1:Label>sample string 3</d2p1:Label>
      <d2p1:SortOrder>4</d2p1:SortOrder>
    </d2p1:DocumentAttachmentMapping>
  </DocumentAttachmentMapping>
  <DocumentProcessID>7</DocumentProcessID>
  <DocumentProcessRequestID>6</DocumentProcessRequestID>
  <Email>sample string 15</Email>
  <ErrorFilePath>sample string 13</ErrorFilePath>
  <FileSelectTypeID>1</FileSelectTypeID>
  <HeaderFilePath>sample string 12</HeaderFilePath>
  <HtmlFileName>sample string 5</HtmlFileName>
  <HtmlString>sample string 4</HtmlString>
  <Islocal>sample string 3</Islocal>
  <LocalTemplateId>16</LocalTemplateId>
  <OrganisationID>2</OrganisationID>
  <ProcessEndTS>2026-01-13T05:05:56.0657704+00:00</ProcessEndTS>
  <ProcessStartTS>2026-01-13T05:05:56.0657704+00:00</ProcessStartTS>
  <RegionID>1</RegionID>
  <Status>1</Status>
  <StepNumber>11</StepNumber>
  <TaskName>sample string 14</TaskName>
  <TaxYearID>8</TaxYearID>
  <UserID>10</UserID>
</Documentation>

multipart/form-data

Sample:

<Documentation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Transportal.BAL.Documentation"><Client>sample string 1</Client><Comments>sample string 9</Comments><CountryID>1</CountryID><DocumentAttachmentMapping xmlns:d2p1="http://schemas.datacontract.org/2004/07/Transportal.BAL.Models.Documentation"><d2p1:DocumentAttachmentMapping><d2p1:AttachmentID>1</d2p1:AttachmentID><d2p1:AttachmentType>sample string 2</d2p1:AttachmentType><d2p1:Label>sample string 3</d2p1:Label><d2p1:SortOrder>4</d2p1:SortOrder></d2p1:DocumentAttachmentMapping><d2p1:DocumentAttachmentMapping><d2p1:AttachmentID>1</d2p1:AttachmentID><d2p1:AttachmentType>sample string 2</d2p1:AttachmentType><d2p1:Label>sample string 3</d2p1:Label><d2p1:SortOrder>4</d2p1:SortOrder></d2p1:DocumentAttachmentMapping></DocumentAttachmentMapping><DocumentProcessID>7</DocumentProcessID><DocumentProcessRequestID>6</DocumentProcessRequestID><Email>sample string 15</Email><ErrorFilePath>sample string 13</ErrorFilePath><FileSelectTypeID>1</FileSelectTypeID><HeaderFilePath>sample string 12</HeaderFilePath><HtmlFileName>sample string 5</HtmlFileName><HtmlString>sample string 4</HtmlString><Islocal>sample string 3</Islocal><LocalTemplateId>16</LocalTemplateId><OrganisationID>2</OrganisationID><ProcessEndTS>2026-01-13T05:05:56.0657704+00:00</ProcessEndTS><ProcessStartTS>2026-01-13T05:05:56.0657704+00:00</ProcessStartTS><RegionID>1</RegionID><Status>1</Status><StepNumber>11</StepNumber><TaskName>sample string 14</TaskName><TaxYearID>8</TaxYearID><UserID>10</UserID></Documentation>

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 'Documentation'.

Response Information

Resource Description

None.