POST api/Legacy/GetDocumentInfo

Get document info

Request Information

URI Parameters

None.

Body Parameters

DocumentRequest
NameDescriptionTypeAdditional information
docId

string

None.

username

string

None.

password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "docId": "sample string 1",
  "username": "sample string 2",
  "password": "sample string 3"
}

application/xml, text/xml

Sample:
<DocumentRequest 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 3</password>
  <username xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2">sample string 2</username>
  <docId>sample string 1</docId>
</DocumentRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

DocumentInfoResponse
NameDescriptionTypeAdditional information
GetDocumentInfoResult

LegacyDocumentInfo

None.

outStatus

ResultStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "GetDocumentInfoResult": {
    "Added": "sample string 1",
    "Modified": "sample string 2",
    "Deleted": "sample string 3",
    "StartSigning": "sample string 4",
    "EndSigning": "sample string 5",
    "DocumentId": "sample string 6",
    "Status": 0,
    "DocumentName": "sample string 7",
    "DocumentNotes": "sample string 8",
    "Metadata": "sample string 9",
    "Ordered": true,
    "Notify": true,
    "Archive": true,
    "MininumSigners": 13,
    "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": "sample string 8",
        "HasSigned": true,
        "Declined": true,
        "Reason": "sample string 11"
      },
      {
        "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": "sample string 8",
        "HasSigned": true,
        "Declined": true,
        "Reason": "sample string 11"
      }
    ],
    "Reason": "sample string 14",
    "Digest": "sample string 15"
  },
  "outStatus": {
    "StatusCode": "00",
    "Message": "sample string 2",
    "Result": 0
  }
}

application/xml, text/xml

Sample:
<DocumentInfoResponse 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>
  <GetDocumentInfoResult>
    <Added>sample string 1</Added>
    <Archive>true</Archive>
    <Deleted>sample string 3</Deleted>
    <Digest>sample string 15</Digest>
    <DocumentId>sample string 6</DocumentId>
    <DocumentName>sample string 7</DocumentName>
    <DocumentNotes>sample string 8</DocumentNotes>
    <EndSigning>sample string 5</EndSigning>
    <Metadata>sample string 9</Metadata>
    <MininumSigners>13</MininumSigners>
    <Modified>sample string 2</Modified>
    <Notify>true</Notify>
    <Ordered>true</Ordered>
    <Reason>sample string 14</Reason>
    <Signers>
      <LegacyDocumentSigner>
        <Declined>true</Declined>
        <Email>sample string 3</Email>
        <HasSigned>true</HasSigned>
        <Name>sample string 2</Name>
        <Notify>true</Notify>
        <Order>7</Order>
        <Reason>sample string 11</Reason>
        <Role>Signer</Role>
        <SSN>sample string 1</SSN>
        <Signed>sample string 8</Signed>
        <SigningMessage>sample string 5</SigningMessage>
        <SigningText>sample string 6</SigningText>
      </LegacyDocumentSigner>
      <LegacyDocumentSigner>
        <Declined>true</Declined>
        <Email>sample string 3</Email>
        <HasSigned>true</HasSigned>
        <Name>sample string 2</Name>
        <Notify>true</Notify>
        <Order>7</Order>
        <Reason>sample string 11</Reason>
        <Role>Signer</Role>
        <SSN>sample string 1</SSN>
        <Signed>sample string 8</Signed>
        <SigningMessage>sample string 5</SigningMessage>
        <SigningText>sample string 6</SigningText>
      </LegacyDocumentSigner>
    </Signers>
    <StartSigning>sample string 4</StartSigning>
    <Status>New</Status>
  </GetDocumentInfoResult>
</DocumentInfoResponse>