POST api/Legacy/AddDocument

Add document to Signet

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
request	AddDocumentRequest	None.
username	string	None.
password	string	None.

Request Formats

application/json, text/json

Sample:

{
  "request": {
    "DocumentBytes": "QEA=",
    "DocumentString": "sample string 1",
    "DocumentName": "sample string 2",
    "Signers": [
      {
        "SSN": "sample string 1",
        "Name": "sample string 2",
        "Email": "sample string 3",
        "Notify": true,
        "SigningMessage": "sample string 5",
        "SigningText": "sample string 6",
        "Order": 7,
        "Role": 0,
        "Signed": "2024-11-21T09:58:02.949",
        "HasSigned": true,
        "Declined": true,
        "Reason": "sample string 10"
      },
      {
        "SSN": "sample string 1",
        "Name": "sample string 2",
        "Email": "sample string 3",
        "Notify": true,
        "SigningMessage": "sample string 5",
        "SigningText": "sample string 6",
        "Order": 7,
        "Role": 0,
        "Signed": "2024-11-21T09:58:02.949",
        "HasSigned": true,
        "Declined": true,
        "Reason": "sample string 10"
      }
    ],
    "DocumentNotes": "sample string 3",
    "Metadata": "sample string 4",
    "StartSigning": "2024-11-21T09:58:02.949",
    "EndSigning": "2024-11-21T09:58:02.949",
    "Ordered": true,
    "Notify": true,
    "Archive": true,
    "MininumSigners": 8,
    "Reason": "sample string 9"
  },
  "username": "sample string 1",
  "password": "sample string 2"
}

application/xml, text/xml

Sample:

<AddRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2.Legacy">
  <password xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 2</password>
  <username xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 1</username>
  <request xmlns:d2p1="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">
    <d2p1:Archive>true</d2p1:Archive>
    <d2p1:DocumentNotes>sample string 3</d2p1:DocumentNotes>
    <d2p1:EndSigning>2024-11-21T09:58:02.9494328+00:00</d2p1:EndSigning>
    <d2p1:Metadata>sample string 4</d2p1:Metadata>
    <d2p1:MininumSigners>8</d2p1:MininumSigners>
    <d2p1:Notify>true</d2p1:Notify>
    <d2p1:Ordered>true</d2p1:Ordered>
    <d2p1:Reason>sample string 9</d2p1:Reason>
    <d2p1:StartSigning>2024-11-21T09:58:02.9494328+00:00</d2p1:StartSigning>
    <d2p1:DocumentBytes>QEA=</d2p1:DocumentBytes>
    <d2p1:DocumentName>sample string 2</d2p1:DocumentName>
    <d2p1:DocumentString>sample string 1</d2p1:DocumentString>
    <d2p1:Signers>
      <d2p1:DocumentSigner>
        <d2p1:Declined>true</d2p1:Declined>
        <d2p1:Email>sample string 3</d2p1:Email>
        <d2p1:HasSigned>true</d2p1:HasSigned>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:Notify>true</d2p1:Notify>
        <d2p1:Order>7</d2p1:Order>
        <d2p1:Reason>sample string 10</d2p1:Reason>
        <d2p1:Role>Signer</d2p1:Role>
        <d2p1:SSN>sample string 1</d2p1:SSN>
        <d2p1:Signed>2024-11-21T09:58:02.9494328+00:00</d2p1:Signed>
        <d2p1:SigningMessage>sample string 5</d2p1:SigningMessage>
        <d2p1:SigningText>sample string 6</d2p1:SigningText>
      </d2p1:DocumentSigner>
      <d2p1:DocumentSigner>
        <d2p1:Declined>true</d2p1:Declined>
        <d2p1:Email>sample string 3</d2p1:Email>
        <d2p1:HasSigned>true</d2p1:HasSigned>
        <d2p1:Name>sample string 2</d2p1:Name>
        <d2p1:Notify>true</d2p1:Notify>
        <d2p1:Order>7</d2p1:Order>
        <d2p1:Reason>sample string 10</d2p1:Reason>
        <d2p1:Role>Signer</d2p1:Role>
        <d2p1:SSN>sample string 1</d2p1:SSN>
        <d2p1:Signed>2024-11-21T09:58:02.9494328+00:00</d2p1:Signed>
        <d2p1:SigningMessage>sample string 5</d2p1:SigningMessage>
        <d2p1:SigningText>sample string 6</d2p1:SigningText>
      </d2p1:DocumentSigner>
    </d2p1:Signers>
  </request>
</AddRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

AddDocumentResponse

Name	Description	Type	Additional information
AddDocumentResult		string	None.
outStatus		ResultStatus	None.

Response Formats

application/json, text/json

Sample:

{
  "AddDocumentResult": "sample string 1",
  "outStatus": {
    "StatusCode": "00",
    "Message": "sample string 2",
    "Result": 0
  }
}

application/xml, text/xml

Sample:

<AddDocumentResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2.Legacy">
  <outStatus xmlns:d2p1="http://schemas.datacontract.org/2004/07/Advania.Model.Common" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">
    <d2p1:Message>sample string 2</d2p1:Message>
    <d2p1:Result>Success</d2p1:Result>
    <d2p1:StatusCode>00</d2p1:StatusCode>
  </outStatus>
  <AddDocumentResult>sample string 1</AddDocumentResult>
</AddDocumentResponse>