POST api/Contract/Sign

Request Information

URI Parameters

None.

Body Parameters

ContractSignature
NameDescriptionTypeAdditional information
Id

string

None.

FileUrl

string

None.

Emails

Collection of string

None.

HookUrl

string

None.

ReturnUrl

string

None.

EmailTitle

string

None.

EmailBody

string

None.

EmailSender

string

None.

Platform

string

None.

Request Formats

application/json, text/json

Sample:
{
  "Id": "sample string 1",
  "FileUrl": "sample string 2",
  "Emails": [
    "sample string 1",
    "sample string 2"
  ],
  "HookUrl": "sample string 3",
  "ReturnUrl": "sample string 4",
  "EmailTitle": "sample string 5",
  "EmailBody": "sample string 6",
  "EmailSender": "sample string 7",
  "Platform": "sample string 8"
}

text/html

Sample:
{"Id":"sample string 1","FileUrl":"sample string 2","Emails":["sample string 1","sample string 2"],"HookUrl":"sample string 3","ReturnUrl":"sample string 4","EmailTitle":"sample string 5","EmailBody":"sample string 6","EmailSender":"sample string 7","Platform":"sample string 8"}

application/xml, text/xml

Sample:
<ContractSignature xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartClause.API.Models">
  <EmailBody>sample string 6</EmailBody>
  <EmailSender>sample string 7</EmailSender>
  <EmailTitle>sample string 5</EmailTitle>
  <Emails xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Emails>
  <FileUrl>sample string 2</FileUrl>
  <HookUrl>sample string 3</HookUrl>
  <Id>sample string 1</Id>
  <Platform>sample string 8</Platform>
  <ReturnUrl>sample string 4</ReturnUrl>
</ContractSignature>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ContractSignatureResponse
NameDescriptionTypeAdditional information
EnveloppeId

string

None.

SignatureUrl

string

None.

FileUrl

string

None.

Response Formats

application/json, text/json

Sample:
{
  "EnveloppeId": "sample string 1",
  "SignatureUrl": "sample string 2",
  "FileUrl": "sample string 3"
}

text/html

Sample:
{"EnveloppeId":"sample string 1","SignatureUrl":"sample string 2","FileUrl":"sample string 3"}

application/xml, text/xml

Sample:
<ContractSignatureResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartClause.API.Models">
  <EnveloppeId>sample string 1</EnveloppeId>
  <FileUrl>sample string 3</FileUrl>
  <SignatureUrl>sample string 2</SignatureUrl>
</ContractSignatureResponse>