Trendsic Platform Service

<back to all web services

NotaryInviteRequest

Requires Authentication
The following routes are available for this service:
GET,POST/v1/witness/notary/invite
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotaryInvitePreview:
    link: Optional[str] = None
    subject: Optional[str] = None
    greeting: Optional[str] = None
    lead: Optional[str] = None
    sign_in: Optional[str] = None
    sms: Optional[str] = None
    sms_length: int = 0
    sms_segments: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotaryInviteResponse:
    preview: Optional[NotaryInvitePreview] = None
    lines: List[str] = field(default_factory=list)
    emailed_to: Optional[str] = None
    texted_to: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class NotaryInviteRequest:
    email: Optional[str] = None
    phone: Optional[str] = None
    notary_id: Optional[int] = None

Python NotaryInviteRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
		}
	}
}