Trendsic Platform Service

<back to all web services

MessagingTestRequest

Requires Authentication
The following routes are available for this service:
POST/v1/messaging/test
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class MessagingTestRequest
    {
        public String RuleKey = null;
        public UUID BranchId = null;
        public UUID LineId = null;
        public ArrayList<String> StepIds = new ArrayList<String>();
        public String ToPhone = null;
        public Boolean Remember = null;
        
        public String getRuleKey() { return RuleKey; }
        public MessagingTestRequest setRuleKey(String value) { this.RuleKey = value; return this; }
        public UUID getBranchId() { return BranchId; }
        public MessagingTestRequest setBranchId(UUID value) { this.BranchId = value; return this; }
        public UUID getLineId() { return LineId; }
        public MessagingTestRequest setLineId(UUID value) { this.LineId = value; return this; }
        public ArrayList<String> getStepIds() { return StepIds; }
        public MessagingTestRequest setStepIds(ArrayList<String> value) { this.StepIds = value; return this; }
        public String getToPhone() { return ToPhone; }
        public MessagingTestRequest setToPhone(String value) { this.ToPhone = value; return this; }
        public Boolean isRemember() { return Remember; }
        public MessagingTestRequest setRemember(Boolean value) { this.Remember = value; return this; }
    }

    public static class MessagingTestResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<MessagingTestSend> Sent = new ArrayList<MessagingTestSend>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public MessagingTestResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<MessagingTestSend> getSent() { return Sent; }
        public MessagingTestResponse setSent(ArrayList<MessagingTestSend> value) { this.Sent = value; return this; }
    }

    public static class MessagingTestSend
    {
        public String StepId = null;
        public String Status = null;
        public String Output = null;
        public String Body = null;
        public Integer Segments = null;
        public Long SmsMessageId = null;
        
        public String getStepId() { return StepId; }
        public MessagingTestSend setStepId(String value) { this.StepId = value; return this; }
        public String getStatus() { return Status; }
        public MessagingTestSend setStatus(String value) { this.Status = value; return this; }
        public String getOutput() { return Output; }
        public MessagingTestSend setOutput(String value) { this.Output = value; return this; }
        public String getBody() { return Body; }
        public MessagingTestSend setBody(String value) { this.Body = value; return this; }
        public Integer getSegments() { return Segments; }
        public MessagingTestSend setSegments(Integer value) { this.Segments = value; return this; }
        public Long getSmsMessageId() { return SmsMessageId; }
        public MessagingTestSend setSmsMessageId(Long value) { this.SmsMessageId = value; return this; }
    }

}

Java MessagingTestRequest 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/messaging/test HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<MessagingTestRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <LineId>00000000-0000-0000-0000-000000000000</LineId>
  <Remember>false</Remember>
  <RuleKey>String</RuleKey>
  <StepIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </StepIds>
  <ToPhone>String</ToPhone>
</MessagingTestRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessagingTestResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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>
  <Sent>
    <MessagingTestSend>
      <Body>String</Body>
      <Output>String</Output>
      <Segments>0</Segments>
      <SmsMessageId>0</SmsMessageId>
      <Status>String</Status>
      <StepId>String</StepId>
    </MessagingTestSend>
  </Sent>
</MessagingTestResponse>