Trendsic Platform Service

<back to all web services

AdditionalServiceSendRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/additionalservice/{Id}/send
"use strict";
export class AdditionalServiceSendResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Success?:boolean,PortalUrl?:string,DeliveryErrors?:string[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {boolean} */
    Success;
    /** @type {string} */
    PortalUrl;
    /** @type {string[]} */
    DeliveryErrors = [];
}
export class AdditionalServiceSendRequest {
    /** @param {{Id?:number,Title?:string,Amount?:number,PriceTbd?:boolean,RecipientContactId?:number,RecipientEmail?:string,RecipientPhone?:string,DeliverEmail?:boolean,DeliverSms?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    Title;
    /** @type {?number} */
    Amount;
    /** @type {boolean} */
    PriceTbd;
    /** @type {?number} */
    RecipientContactId;
    /** @type {string} */
    RecipientEmail;
    /** @type {string} */
    RecipientPhone;
    /** @type {boolean} */
    DeliverEmail;
    /** @type {boolean} */
    DeliverSms;
}

JavaScript AdditionalServiceSendRequest 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/additionalservice/{Id}/send HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Title: String,
	Amount: 0,
	PriceTbd: False,
	RecipientContactId: 0,
	RecipientEmail: String,
	RecipientPhone: String,
	DeliverEmail: False,
	DeliverSms: False
}
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
		}
	},
	Success: False,
	PortalUrl: String,
	DeliveryErrors: 
	[
		String
	]
}