| GET,POST | /v1/witness/notary/invite |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| body | string | No | ||
| Phone | body | string | No | |
| NotaryId | body | int? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Preview | form | NotaryInvitePreview | No | |
| Lines | form | List<string> | No | |
| EmailedTo | form | string | No | |
| TextedTo | form | string | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Link | form | string | No | |
| Subject | form | string | No | |
| Greeting | form | string | No | |
| Lead | form | string | No | |
| SignIn | form | string | No | |
| Sms | form | string | No | |
| SmsLength | form | int | No | |
| SmsSegments | 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 /v1/witness/notary/invite HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Email: String,
Phone: String,
NotaryId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Preview:
{
Link: String,
Subject: String,
Greeting: String,
Lead: String,
SignIn: String,
Sms: String,
SmsLength: 0,
SmsSegments: 0
},
Lines:
[
String
],
EmailedTo: String,
TextedTo: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}