Trendsic Platform Service

<back to all web services

FormInviteRevokeRequest

Requires Authentication
The following routes are available for this service:
DELETE/v1/forms/{FormUID}/invites/{InviteUID}
"use strict";
export class FormFillReceiptLine {
    /** @param {{Channel?:string,To?:string,Outcome?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Channel;
    /** @type {string} */
    To;
    /** @type {string} */
    Outcome;
}
export class FormInviteView {
    /** @param {{InviteUID?:string,Name?:string,Email?:string,Phone?:string,CreatedBy?:string,CreatedAt?:string,ExpiresAt?:string,SentAt?:string,LastSentAt?:string,SendCount?:number,OpenedAt?:string,RevokedAt?:string,Number?:string,State?:string,Link?:string,Sends?:FormFillReceiptLine[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    InviteUID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Email;
    /** @type {string} */
    Phone;
    /** @type {string} */
    CreatedBy;
    /** @type {?string} */
    CreatedAt;
    /** @type {?string} */
    ExpiresAt;
    /** @type {?string} */
    SentAt;
    /** @type {?string} */
    LastSentAt;
    /** @type {number} */
    SendCount;
    /** @type {?string} */
    OpenedAt;
    /** @type {?string} */
    RevokedAt;
    /** @type {string} */
    Number;
    /** @type {string} */
    State;
    /** @type {string} */
    Link;
    /** @type {FormFillReceiptLine[]} */
    Sends = [];
}
export class FormInvitesResponse {
    /** @param {{Invites?:FormInviteView[],Created?:FormInviteView[],Emails?:number,Texts?:number,Consequence?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {FormInviteView[]} */
    Invites = [];
    /** @type {FormInviteView[]} */
    Created = [];
    /** @type {number} */
    Emails;
    /** @type {number} */
    Texts;
    /** @type {string} */
    Consequence;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class FormInviteRevokeRequest {
    /** @param {{FormUID?:string,InviteUID?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    FormUID;
    /** @type {string} */
    InviteUID;
}

JavaScript FormInviteRevokeRequest 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.

DELETE /v1/forms/{FormUID}/invites/{InviteUID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Invites: 
	[
		{
			InviteUID: 00000000000000000000000000000000,
			Name: String,
			Email: String,
			Phone: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			ExpiresAt: 0001-01-01,
			SentAt: 0001-01-01,
			LastSentAt: 0001-01-01,
			SendCount: 0,
			OpenedAt: 0001-01-01,
			RevokedAt: 0001-01-01,
			Number: String,
			State: String,
			Link: String,
			Sends: 
			[
				{
					Channel: String,
					To: String,
					Outcome: String
				}
			]
		}
	],
	Created: 
	[
		{
			InviteUID: 00000000000000000000000000000000,
			Name: String,
			Email: String,
			Phone: String,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			ExpiresAt: 0001-01-01,
			SentAt: 0001-01-01,
			LastSentAt: 0001-01-01,
			SendCount: 0,
			OpenedAt: 0001-01-01,
			RevokedAt: 0001-01-01,
			Number: String,
			State: String,
			Link: String,
			Sends: 
			[
				{
					Channel: String,
					To: String,
					Outcome: String
				}
			]
		}
	],
	Emails: 0,
	Texts: 0,
	Consequence: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}