| All Verbs | /signing/sendrequest |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GoalResultsId | query | int | No | |
| Title | query | string | No | |
| Subject | query | string | No | |
| Message | query | string | No | |
| SignerEmail1 | query | string | No | |
| SignerName1 | query | string | No | |
| SignerEmail2 | query | string | No | |
| SignerName2 | query | string | No | |
| SignerEmail3 | query | string | No | |
| SignerName3 | query | string | No | |
| CcSignerEmail1 | query | string | No | |
| CcSignerName1 | query | string | No | |
| CcSignerEmail2 | query | string | No | |
| CcSignerName2 | query | string | No | |
| CcSignerEmail3 | query | string | No | |
| CcSignerName3 | query | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| Id | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /signing/sendrequest HTTP/1.1
Host: api.portfoliolink.co.za
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
goalResultsId: 0,
title: String,
subject: String,
message: String,
signerEmail1: String,
signerName1: String,
signerEmail2: String,
signerName2: String,
signerEmail3: String,
signerName3: String,
ccSignerEmail1: String,
ccSignerName1: String,
ccSignerEmail2: String,
ccSignerName2: String,
ccSignerEmail3: String,
ccSignerName3: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
success: False,
id: 0
}