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
"use strict";
export class NotaryInvitePreview {
    /** @param {{Link?:string,Subject?:string,Greeting?:string,Lead?:string,SignIn?:string,Sms?:string,SmsLength?:number,SmsSegments?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Link;
    /** @type {string} */
    Subject;
    /** @type {string} */
    Greeting;
    /** @type {string} */
    Lead;
    /** @type {string} */
    SignIn;
    /** @type {string} */
    Sms;
    /** @type {number} */
    SmsLength;
    /** @type {number} */
    SmsSegments;
}
export class NotaryInviteResponse {
    /** @param {{Preview?:NotaryInvitePreview,Lines?:string[],EmailedTo?:string,TextedTo?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {NotaryInvitePreview} */
    Preview;
    /** @type {string[]} */
    Lines = [];
    /** @type {string} */
    EmailedTo;
    /** @type {string} */
    TextedTo;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class NotaryInviteRequest {
    /** @param {{Email?:string,Phone?:string,NotaryId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Email;
    /** @type {string} */
    Phone;
    /** @type {?number} */
    NotaryId;
}

JavaScript NotaryInviteRequest DTOs

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

HTTP + OTHER

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/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Email":"String","Phone":"String","NotaryId":0}

HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}