Trendsic Platform Service

<back to all web services

ContactInvitationRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/ContactInvitation
"use strict";
export class ContactInvitationResponse {
    /** @param {{ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ContactInvitation {
    /** @param {{Id?:number,AgentId?:number,ContactId?:number,Url?:string,UrlCode?:string,iDecideUserId?:number,DateCreated?:string,CreatedBy?:string,Deleted?:boolean,DateDeleted?:string,DeletedBy?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {number} */
    AgentId;
    /** @type {number} */
    ContactId;
    /** @type {string} */
    Url;
    /** @type {string} */
    UrlCode;
    /** @type {number} */
    iDecideUserId;
    /** @type {string} */
    DateCreated;
    /** @type {string} */
    CreatedBy;
    /** @type {boolean} */
    Deleted;
    /** @type {string} */
    DateDeleted;
    /** @type {string} */
    DeletedBy;
}
export class ContactInvitationRequest {
    /** @param {{ContactInvitation?:ContactInvitation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ContactInvitation} */
    ContactInvitation;
}

JavaScript ContactInvitationRequest 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/ContactInvitation HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ContactInvitation: 
	{
		Id: 0,
		AgentId: 0,
		ContactId: 0,
		Url: String,
		UrlCode: String,
		iDecideUserId: 0,
		DateCreated: 0001-01-01,
		CreatedBy: 00000000000000000000000000000000,
		Deleted: False,
		DateDeleted: 0001-01-01,
		DeletedBy: 00000000000000000000000000000000
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}