PUT api/Signet/AddDocument

Add document(s) to Signet for Signing

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
request	AddDocumentRequestV3	None.
GroupID	string	None.
username	string	None.
password	string	None.

Request Formats

application/json, text/json

Sample:

{
  "request": {
    "DontAddPage": true,
    "AttachXml": true,
    "SealDocuments": 0,
    "Documents": [
      {
        "ID": "sample string 1",
        "Data": "QEA=",
        "DocumentName": "sample string 2",
        "Status": 0
      },
      {
        "ID": "sample string 1",
        "Data": "QEA=",
        "DocumentName": "sample string 2",
        "Status": 0
      }
    ],
    "Signers": [
      {
        "Location": {
          "Page": 1,
          "XLocation": 2,
          "YLocation": 3,
          "Height": 4,
          "Width": 5
        },
        "Mobile": "sample string 1",
        "SSN": "sample string 2",
        "Name": "sample string 3",
        "Email": "sample string 4",
        "Notify": true,
        "SigningMessage": "sample string 6",
        "SigningText": "sample string 7",
        "Order": 8,
        "Role": 0,
        "Signed": "2024-11-21T09:29:55.201",
        "HasSigned": true,
        "Declined": true,
        "Reason": "sample string 11"
      },
      {
        "Location": {
          "Page": 1,
          "XLocation": 2,
          "YLocation": 3,
          "Height": 4,
          "Width": 5
        },
        "Mobile": "sample string 1",
        "SSN": "sample string 2",
        "Name": "sample string 3",
        "Email": "sample string 4",
        "Notify": true,
        "SigningMessage": "sample string 6",
        "SigningText": "sample string 7",
        "Order": 8,
        "Role": 0,
        "Signed": "2024-11-21T09:29:55.201",
        "HasSigned": true,
        "Declined": true,
        "Reason": "sample string 11"
      }
    ],
    "DocumentNotes": "sample string 3",
    "Metadata": "sample string 4",
    "StartSigning": "2024-11-21T09:29:55.201",
    "EndSigning": "2024-11-21T09:29:55.201",
    "Ordered": true,
    "Notify": true,
    "Archive": true,
    "MininumSigners": 8,
    "Reason": "sample string 9"
  },
  "GroupID": "sample string 1",
  "username": "sample string 2",
  "password": "sample string 3"
}

application/xml, text/xml

Sample:

<AddRequestV3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2.V3">
  <password xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 3</password>
  <username xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 2</username>
  <GroupID>sample string 1</GroupID>
  <request>
    <Archive xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</Archive>
    <DocumentNotes xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 3</DocumentNotes>
    <EndSigning xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">2024-11-21T09:29:55.2016285+00:00</EndSigning>
    <Metadata xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 4</Metadata>
    <MininumSigners xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">8</MininumSigners>
    <Notify xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</Notify>
    <Ordered xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</Ordered>
    <Reason xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 9</Reason>
    <StartSigning xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">2024-11-21T09:29:55.2016285+00:00</StartSigning>
    <AttachXml>true</AttachXml>
    <Documents>
      <Document>
        <Data>QEA=</Data>
        <DocumentName>sample string 2</DocumentName>
        <ID>sample string 1</ID>
        <Status>New</Status>
      </Document>
      <Document>
        <Data>QEA=</Data>
        <DocumentName>sample string 2</DocumentName>
        <ID>sample string 1</ID>
        <Status>New</Status>
      </Document>
    </Documents>
    <DontAddPage>true</DontAddPage>
    <SealDocuments>None</SealDocuments>
    <Signers>
      <DocumentSignerV3>
        <Declined xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</Declined>
        <Email xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 4</Email>
        <HasSigned xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</HasSigned>
        <Name xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 3</Name>
        <Notify xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</Notify>
        <Order xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">8</Order>
        <Reason xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 11</Reason>
        <Role xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">Signer</Role>
        <SSN xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 2</SSN>
        <Signed xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">2024-11-21T09:29:55.2016285+00:00</Signed>
        <SigningMessage xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 6</SigningMessage>
        <SigningText xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 7</SigningText>
        <Location>
          <Height>4</Height>
          <Page>1</Page>
          <Width>5</Width>
          <XLocation>2</XLocation>
          <YLocation>3</YLocation>
        </Location>
        <Mobile>sample string 1</Mobile>
      </DocumentSignerV3>
      <DocumentSignerV3>
        <Declined xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</Declined>
        <Email xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 4</Email>
        <HasSigned xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</HasSigned>
        <Name xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 3</Name>
        <Notify xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">true</Notify>
        <Order xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">8</Order>
        <Reason xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 11</Reason>
        <Role xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">Signer</Role>
        <SSN xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 2</SSN>
        <Signed xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">2024-11-21T09:29:55.2016285+00:00</Signed>
        <SigningMessage xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 6</SigningMessage>
        <SigningText xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 7</SigningText>
        <Location>
          <Height>4</Height>
          <Page>1</Page>
          <Width>5</Width>
          <XLocation>2</XLocation>
          <YLocation>3</YLocation>
        </Location>
        <Mobile>sample string 1</Mobile>
      </DocumentSignerV3>
    </Signers>
  </request>
</AddRequestV3>

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.