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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<NotaryInviteRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Email>String</Email>
  <NotaryId>0</NotaryId>
  <Phone>String</Phone>
</NotaryInviteRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NotaryInviteResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <EmailedTo>String</EmailedTo>
  <Lines xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Lines>
  <Preview>
    <Greeting>String</Greeting>
    <Lead>String</Lead>
    <Link>String</Link>
    <SignIn>String</SignIn>
    <Sms>String</Sms>
    <SmsLength>0</SmsLength>
    <SmsSegments>0</SmsSegments>
    <Subject>String</Subject>
  </Preview>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <TextedTo>String</TextedTo>
</NotaryInviteResponse>