POST api/InitiateAndSignFlexiForm

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Data	string	None.
Signatories	Collection of SignersFlexiForm	Required
TemplateId	integer	Required
DonotSendCompletionMailToParticipants	boolean	None.
Reminder	integer	None.
ReferenceNo	string	None.
WorkflowType	integer	None.
listAttachmentDetails	Collection of AttachmentDetails	None.
WaterMark	string	None.
DocumentProtection	string	None.
eStampType	string	None.
State	string	None.
Denomination	integer	None.
ClientID	string	None.
ClientName	string	None.
FetchEstampDeatilsUsingRefNo	boolean	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "FetchEstampDeatilsUsingRefNo": true,
    "Data": "sample string 1",
    "Signatories": [
      {
        "EmailId": "sample string 1",
        "Name": "sample string 2",
        "ContactNo": "sample string 3",
        "ModeOfSignature": "sample string 4",
        "MailSendingOptions": 5,
        "ModeofAuthentication": 6
      },
      {
        "EmailId": "sample string 1",
        "Name": "sample string 2",
        "ContactNo": "sample string 3",
        "ModeOfSignature": "sample string 4",
        "MailSendingOptions": 5,
        "ModeofAuthentication": 6
      }
    ],
    "TemplateId": 2,
    "DonotSendCompletionMailToParticipants": true,
    "Reminder": 4,
    "ReferenceNo": "sample string 5",
    "WorkflowType": 6,
    "listAttachmentDetails": [
      {
        "DocumentName": "sample string 1",
        "Base64fileData": "sample string 2",
        "Description": "sample string 3",
        "DocumentPassword": "sample string 4"
      },
      {
        "DocumentName": "sample string 1",
        "Base64fileData": "sample string 2",
        "Description": "sample string 3",
        "DocumentPassword": "sample string 4"
      }
    ],
    "WaterMark": "sample string 7",
    "DocumentProtection": "sample string 8",
    "eStampType": "sample string 9",
    "State": "sample string 10",
    "Denomination": 11,
    "ClientID": "sample string 12",
    "ClientName": "sample string 13"
  },
  {
    "FetchEstampDeatilsUsingRefNo": true,
    "Data": "sample string 1",
    "Signatories": [
      {
        "EmailId": "sample string 1",
        "Name": "sample string 2",
        "ContactNo": "sample string 3",
        "ModeOfSignature": "sample string 4",
        "MailSendingOptions": 5,
        "ModeofAuthentication": 6
      },
      {
        "EmailId": "sample string 1",
        "Name": "sample string 2",
        "ContactNo": "sample string 3",
        "ModeOfSignature": "sample string 4",
        "MailSendingOptions": 5,
        "ModeofAuthentication": 6
      }
    ],
    "TemplateId": 2,
    "DonotSendCompletionMailToParticipants": true,
    "Reminder": 4,
    "ReferenceNo": "sample string 5",
    "WorkflowType": 6,
    "listAttachmentDetails": [
      {
        "DocumentName": "sample string 1",
        "Base64fileData": "sample string 2",
        "Description": "sample string 3",
        "DocumentPassword": "sample string 4"
      },
      {
        "DocumentName": "sample string 1",
        "Base64fileData": "sample string 2",
        "Description": "sample string 3",
        "DocumentPassword": "sample string 4"
      }
    ],
    "WaterMark": "sample string 7",
    "DocumentProtection": "sample string 8",
    "eStampType": "sample string 9",
    "State": "sample string 10",
    "Denomination": 11,
    "ClientID": "sample string 12",
    "ClientName": "sample string 13"
  }
]

application/xml, text/xml

Sample:

<ArrayOfWorkflowConfigFlexiform xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WorkflowConfigFlexiform>
    <WorkflowType>6</WorkflowType>
    <listAttachmentDetails>
      <AttachmentDetails>
        <DocumentName>sample string 1</DocumentName>
        <Base64fileData>sample string 2</Base64fileData>
        <Description>sample string 3</Description>
        <DocumentPassword>sample string 4</DocumentPassword>
      </AttachmentDetails>
      <AttachmentDetails>
        <DocumentName>sample string 1</DocumentName>
        <Base64fileData>sample string 2</Base64fileData>
        <Description>sample string 3</Description>
        <DocumentPassword>sample string 4</DocumentPassword>
      </AttachmentDetails>
    </listAttachmentDetails>
    <WaterMark>sample string 7</WaterMark>
    <DocumentProtection>sample string 8</DocumentProtection>
    <eStampType>sample string 9</eStampType>
    <State>sample string 10</State>
    <Denomination>11</Denomination>
    <ClientID>sample string 12</ClientID>
    <ClientName>sample string 13</ClientName>
    <FetchEstampDeatilsUsingRefNo>true</FetchEstampDeatilsUsingRefNo>
    <Data>sample string 1</Data>
    <Signatories>
      <SignersFlexiForm>
        <EmailId>sample string 1</EmailId>
        <Name>sample string 2</Name>
        <ContactNo>sample string 3</ContactNo>
        <ModeOfSignature>sample string 4</ModeOfSignature>
        <MailSendingOptions>5</MailSendingOptions>
        <ModeofAuthentication>6</ModeofAuthentication>
      </SignersFlexiForm>
      <SignersFlexiForm>
        <EmailId>sample string 1</EmailId>
        <Name>sample string 2</Name>
        <ContactNo>sample string 3</ContactNo>
        <ModeOfSignature>sample string 4</ModeOfSignature>
        <MailSendingOptions>5</MailSendingOptions>
        <ModeofAuthentication>6</ModeofAuthentication>
      </SignersFlexiForm>
    </Signatories>
    <TemplateId>2</TemplateId>
    <DonotSendCompletionMailToParticipants>true</DonotSendCompletionMailToParticipants>
    <Reminder>4</Reminder>
    <ReferenceNo>sample string 5</ReferenceNo>
  </WorkflowConfigFlexiform>
  <WorkflowConfigFlexiform>
    <WorkflowType>6</WorkflowType>
    <listAttachmentDetails>
      <AttachmentDetails>
        <DocumentName>sample string 1</DocumentName>
        <Base64fileData>sample string 2</Base64fileData>
        <Description>sample string 3</Description>
        <DocumentPassword>sample string 4</DocumentPassword>
      </AttachmentDetails>
      <AttachmentDetails>
        <DocumentName>sample string 1</DocumentName>
        <Base64fileData>sample string 2</Base64fileData>
        <Description>sample string 3</Description>
        <DocumentPassword>sample string 4</DocumentPassword>
      </AttachmentDetails>
    </listAttachmentDetails>
    <WaterMark>sample string 7</WaterMark>
    <DocumentProtection>sample string 8</DocumentProtection>
    <eStampType>sample string 9</eStampType>
    <State>sample string 10</State>
    <Denomination>11</Denomination>
    <ClientID>sample string 12</ClientID>
    <ClientName>sample string 13</ClientName>
    <FetchEstampDeatilsUsingRefNo>true</FetchEstampDeatilsUsingRefNo>
    <Data>sample string 1</Data>
    <Signatories>
      <SignersFlexiForm>
        <EmailId>sample string 1</EmailId>
        <Name>sample string 2</Name>
        <ContactNo>sample string 3</ContactNo>
        <ModeOfSignature>sample string 4</ModeOfSignature>
        <MailSendingOptions>5</MailSendingOptions>
        <ModeofAuthentication>6</ModeofAuthentication>
      </SignersFlexiForm>
      <SignersFlexiForm>
        <EmailId>sample string 1</EmailId>
        <Name>sample string 2</Name>
        <ContactNo>sample string 3</ContactNo>
        <ModeOfSignature>sample string 4</ModeOfSignature>
        <MailSendingOptions>5</MailSendingOptions>
        <ModeofAuthentication>6</ModeofAuthentication>
      </SignersFlexiForm>
    </Signatories>
    <TemplateId>2</TemplateId>
    <DonotSendCompletionMailToParticipants>true</DonotSendCompletionMailToParticipants>
    <Reminder>4</Reminder>
    <ReferenceNo>sample string 5</ReferenceNo>
  </WorkflowConfigFlexiform>
</ArrayOfWorkflowConfigFlexiform>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ReturnObjectOfInitiateAndSignWorkFlowResponse

Name	Type	Additional information
IsSuccess	boolean	None.
Messages	Collection of string	None.
ErrorCode	integer	None.
Response	InitiateAndSignWorkFlowResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Messages": [
    "sample string 1",
    "sample string 2"
  ],
  "ErrorCode": 2,
  "Response": {
    "ReferenceNo": "sample string 1",
    "DocumentNumberList": [
      "sample string 1",
      "sample string 2"
    ],
    "DocumentIdList": [
      1,
      2
    ],
    "Status": true,
    "WorkflowId": 3,
    "SignatoryDetails": [
      {
        "SequenceNumber": 1,
        "IdentificationNumber": "sample string 2",
        "Name": "sample string 3",
        "EmailId": "sample string 4",
        "MobileNo": "sample string 5",
        "URL": "sample string 6"
      },
      {
        "SequenceNumber": 1,
        "IdentificationNumber": "sample string 2",
        "Name": "sample string 3",
        "EmailId": "sample string 4",
        "MobileNo": "sample string 5",
        "URL": "sample string 6"
      }
    ],
    "URL": "sample string 4",
    "ParallelSigningURLs": [
      {
        "SequenceNumber": 1,
        "IdentificationNumber": "sample string 2",
        "Name": "sample string 3",
        "EmailId": "sample string 4",
        "MobileNo": "sample string 5",
        "URL": "sample string 6"
      },
      {
        "SequenceNumber": 1,
        "IdentificationNumber": "sample string 2",
        "Name": "sample string 3",
        "EmailId": "sample string 4",
        "MobileNo": "sample string 5",
        "URL": "sample string 6"
      }
    ],
    "TransactionNumber": "sample string 5",
    "RedirectURL": "sample string 6",
    "ResponseCode": "sample string 7",
    "TemplateId": 8
  }
}

application/xml, text/xml

Sample:

<ReturnObjectOfInitiateAndSignWorkFlowResponse 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>
    <ReferenceNo>sample string 1</ReferenceNo>
    <DocumentNumberList>
      <string>sample string 1</string>
      <string>sample string 2</string>
    </DocumentNumberList>
    <DocumentIdList>
      <long>1</long>
      <long>2</long>
    </DocumentIdList>
    <Status>true</Status>
    <WorkflowId>3</WorkflowId>
    <SignatoryDetails>
      <SignatoryInformation>
        <SequenceNumber>1</SequenceNumber>
        <IdentificationNumber>sample string 2</IdentificationNumber>
        <Name>sample string 3</Name>
        <EmailId>sample string 4</EmailId>
        <MobileNo>sample string 5</MobileNo>
        <URL>sample string 6</URL>
      </SignatoryInformation>
      <SignatoryInformation>
        <SequenceNumber>1</SequenceNumber>
        <IdentificationNumber>sample string 2</IdentificationNumber>
        <Name>sample string 3</Name>
        <EmailId>sample string 4</EmailId>
        <MobileNo>sample string 5</MobileNo>
        <URL>sample string 6</URL>
      </SignatoryInformation>
    </SignatoryDetails>
    <URL>sample string 4</URL>
    <ParallelSigningURLs>
      <ParallelSigningURL>
        <SequenceNumber>1</SequenceNumber>
        <IdentificationNumber>sample string 2</IdentificationNumber>
        <Name>sample string 3</Name>
        <EmailId>sample string 4</EmailId>
        <MobileNo>sample string 5</MobileNo>
        <URL>sample string 6</URL>
      </ParallelSigningURL>
      <ParallelSigningURL>
        <SequenceNumber>1</SequenceNumber>
        <IdentificationNumber>sample string 2</IdentificationNumber>
        <Name>sample string 3</Name>
        <EmailId>sample string 4</EmailId>
        <MobileNo>sample string 5</MobileNo>
        <URL>sample string 6</URL>
      </ParallelSigningURL>
    </ParallelSigningURLs>
    <TransactionNumber>sample string 5</TransactionNumber>
    <RedirectURL>sample string 6</RedirectURL>
    <ResponseCode>sample string 7</ResponseCode>
    <TemplateId>8</TemplateId>
  </Response>
</ReturnObjectOfInitiateAndSignWorkFlowResponse>