POST api/LegacyAccountToken/AddDocument
Add document to Signet
Request Information
URI Parameters
None.
Body Parameters
TokenAddDocumentRequestName | Description | Type | Additional information |
---|---|---|---|
Request | AddDocumentRequest |
None. |
|
Token | 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:35:33.488", "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:35:33.488", "HasSigned": true, "Declined": true, "Reason": "sample string 10" } ], "DocumentNotes": "sample string 3", "Metadata": "sample string 4", "StartSigning": "2024-11-21T09:35:33.488", "EndSigning": "2024-11-21T09:35:33.488", "Ordered": true, "Notify": true, "Archive": true, "MininumSigners": 8, "Reason": "sample string 9" }, "Token": "sample string 1" }
application/xml, text/xml
Sample:
<TokenAddDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Advania.Model.Signet2.Token"> <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:35:33.4889311+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:35:33.4889311+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:35:33.4889311+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:35:33.4889311+00:00</d2p1:Signed> <d2p1:SigningMessage>sample string 5</d2p1:SigningMessage> <d2p1:SigningText>sample string 6</d2p1:SigningText> </d2p1:DocumentSigner> </d2p1:Signers> </Request> <Token>sample string 1</Token> </TokenAddDocumentRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
AddDocumentResponseName | 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>