POST api/Download/SendInboundDocument

Request Information

URI Parameters

None.

Body Parameters

SendDocumentEventRequested
NameDescriptionTypeAdditional information
IsSending

boolean

None.

DocumentId

globally unique identifier

None.

OutboundDocumentId

integer

None.

CoverType

string

None.

CreatedBy

string

None.

DocumentName

string

None.

DocumentPath

string

None.

FileName

string

None.

FormattedFromFax

string

None.

From

string

None.

Message

string

None.

Recipient

string

None.

RecipientFax

string

None.

SenderEmail

string

None.

Subject

string

None.

CurrentDate

string

None.

Request Formats

application/json, text/json

Sample:
{
  "IsSending": true,
  "DocumentId": "a4bc42a5-b2f1-4e2e-bcf7-212cc94520fa",
  "OutboundDocumentId": 3,
  "CoverType": "sample string 4",
  "CreatedBy": "sample string 5",
  "DocumentName": "sample string 6",
  "DocumentPath": "sample string 7",
  "FileName": "sample string 8",
  "FormattedFromFax": "sample string 9",
  "From": "sample string 10",
  "Message": "sample string 11",
  "Recipient": "sample string 12",
  "RecipientFax": "sample string 13",
  "SenderEmail": "sample string 14",
  "Subject": "sample string 15",
  "CurrentDate": "20260401225309"
}

application/xml, text/xml

Sample:
<SendDocumentEventRequested xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SpecialtyIQ.Events">
  <CoverType>sample string 4</CoverType>
  <CreatedBy>sample string 5</CreatedBy>
  <DocumentId>a4bc42a5-b2f1-4e2e-bcf7-212cc94520fa</DocumentId>
  <DocumentName>sample string 6</DocumentName>
  <DocumentPath>sample string 7</DocumentPath>
  <FileName>sample string 8</FileName>
  <FormattedFromFax>sample string 9</FormattedFromFax>
  <From>sample string 10</From>
  <IsSending>true</IsSending>
  <Message>sample string 11</Message>
  <OutboundDocumentId>3</OutboundDocumentId>
  <Recipient>sample string 12</Recipient>
  <RecipientFax>sample string 13</RecipientFax>
  <SenderEmail>sample string 14</SenderEmail>
  <Subject>sample string 15</Subject>
</SendDocumentEventRequested>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.