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

<AdditionalServiceSendRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Amount>0</Amount>
  <DeliverEmail>false</DeliverEmail>
  <DeliverSms>false</DeliverSms>
  <Id>0</Id>
  <PriceTbd>false</PriceTbd>
  <RecipientContactId>0</RecipientContactId>
  <RecipientEmail>String</RecipientEmail>
  <RecipientPhone>String</RecipientPhone>
  <Title>String</Title>
</AdditionalServiceSendRequest>

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

<AdditionalServiceSendResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <DeliveryErrors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </DeliveryErrors>
  <PortalUrl>String</PortalUrl>
  <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>
  <Success>false</Success>
</AdditionalServiceSendResponse>