POST api/ShareDocuments

Request Information

URI Parameters

None.

Body Parameters

ShareInput
NameDescriptionTypeAdditional information
Email

string

Required

WorkflowId

integer

None.

MessageContent

string

None.

IsAttached

boolean

None.

ReferenceNo

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Email": "sample string 1",
  "WorkflowId": 2,
  "MessageContent": "sample string 3",
  "IsAttached": true,
  "ReferenceNo": "sample string 5"
}

application/xml, text/xml

Sample:
<ShareInput xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Email>sample string 1</Email>
  <WorkflowId>2</WorkflowId>
  <MessageContent>sample string 3</MessageContent>
  <IsAttached>true</IsAttached>
  <ReferenceNo>sample string 5</ReferenceNo>
</ShareInput>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReturnObjectOfBoolean
NameDescriptionTypeAdditional information
IsSuccess

boolean

None.

Messages

Collection of string

None.

ErrorCode

integer

None.

Response

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "IsSuccess": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCode": 2,
  "Response": true
}

application/xml, text/xml

Sample:
<ReturnObjectOfBoolean xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccess>true</IsSuccess>
  <Messages>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </Messages>
  <ErrorCode>2</ErrorCode>
  <Response>true</Response>
</ReturnObjectOfBoolean>