POST api/Document/StartProcess1/

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
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:

{
  "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": 1,
  "islocal": "sample string 2",
  "htmlString": "sample string 3",
  "htmlFileName": "sample string 4",
  "documentProcessRequestID": 5,
  "documentProcessID": 6,
  "taxYearID": 7,
  "fileSelectTypeID": 1,
  "comments": "sample string 8",
  "userID": 9,
  "stepNumber": 10,
  "headerFilePath": "sample string 11",
  "errorFilePath": "sample string 12",
  "taskName": "sample string 13",
  "email": "sample string 14",
  "processStartTS": "2025-12-30T08:51:10.1944354+00:00",
  "processEndTS": "2025-12-30T08:51:10.1944354+00:00",
  "localTemplateId": 15,
  "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">
  <Comments>sample string 8</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>6</DocumentProcessID>
  <DocumentProcessRequestID>5</DocumentProcessRequestID>
  <Email>sample string 14</Email>
  <ErrorFilePath>sample string 12</ErrorFilePath>
  <FileSelectTypeID>1</FileSelectTypeID>
  <HeaderFilePath>sample string 11</HeaderFilePath>
  <HtmlFileName>sample string 4</HtmlFileName>
  <HtmlString>sample string 3</HtmlString>
  <Islocal>sample string 2</Islocal>
  <LocalTemplateId>15</LocalTemplateId>
  <OrganisationID>1</OrganisationID>
  <ProcessEndTS>2025-12-30T08:51:10.1944354+00:00</ProcessEndTS>
  <ProcessStartTS>2025-12-30T08:51:10.1944354+00:00</ProcessStartTS>
  <RegionID>1</RegionID>
  <Status>1</Status>
  <StepNumber>10</StepNumber>
  <TaskName>sample string 13</TaskName>
  <TaxYearID>7</TaxYearID>
  <UserID>9</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"><Comments>sample string 8</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>6</DocumentProcessID><DocumentProcessRequestID>5</DocumentProcessRequestID><Email>sample string 14</Email><ErrorFilePath>sample string 12</ErrorFilePath><FileSelectTypeID>1</FileSelectTypeID><HeaderFilePath>sample string 11</HeaderFilePath><HtmlFileName>sample string 4</HtmlFileName><HtmlString>sample string 3</HtmlString><Islocal>sample string 2</Islocal><LocalTemplateId>15</LocalTemplateId><OrganisationID>1</OrganisationID><ProcessEndTS>2025-12-30T08:51:10.1944354+00:00</ProcessEndTS><ProcessStartTS>2025-12-30T08:51:10.1944354+00:00</ProcessStartTS><RegionID>1</RegionID><Status>1</Status><StepNumber>10</StepNumber><TaskName>sample string 13</TaskName><TaxYearID>7</TaxYearID><UserID>9</UserID></Documentation>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml, multipart/form-data

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>