digitaluapi

<back to all web services

ChannelSmsMessagesAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/channel_sms_messages
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @DataContract
    public static class ChannelSmsMessagesAdd
    {
        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Long StatusCodesId = null;

        @DataMember(Order=3)
        public String Reference = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public Integer TenantsId = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public Long ChannelMessagesId = null;

        @DataMember(Order=6)
        @Validate(Validator="NotNull")
        public String Recipients = null;

        @DataMember(Order=7)
        @Validate(Validator="NotNull")
        public Integer TemplatesId = null;

        @DataMember(Order=8)
        @Validate(Validator="NotNull")
        public String TemplateText = null;

        @DataMember(Order=9)
        @Validate(Validator="NotNull")
        public Date DateCreated = null;

        @DataMember(Order=10)
        public Date DateSent = null;

        @DataMember(Order=11)
        @Validate(Validator="NotNull")
        public Integer RetryCount = null;

        @DataMember(Order=12)
        @Validate(Validator="NotNull")
        public UUID MessageGuid = null;
        
        public Long getStatusCodesId() { return StatusCodesId; }
        public ChannelSmsMessagesAdd setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public String getReference() { return Reference; }
        public ChannelSmsMessagesAdd setReference(String value) { this.Reference = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public ChannelSmsMessagesAdd setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public Long getChannelMessagesId() { return ChannelMessagesId; }
        public ChannelSmsMessagesAdd setChannelMessagesId(Long value) { this.ChannelMessagesId = value; return this; }
        public String getRecipients() { return Recipients; }
        public ChannelSmsMessagesAdd setRecipients(String value) { this.Recipients = value; return this; }
        public Integer getTemplatesId() { return TemplatesId; }
        public ChannelSmsMessagesAdd setTemplatesId(Integer value) { this.TemplatesId = value; return this; }
        public String getTemplateText() { return TemplateText; }
        public ChannelSmsMessagesAdd setTemplateText(String value) { this.TemplateText = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public ChannelSmsMessagesAdd setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateSent() { return DateSent; }
        public ChannelSmsMessagesAdd setDateSent(Date value) { this.DateSent = value; return this; }
        public Integer getRetryCount() { return RetryCount; }
        public ChannelSmsMessagesAdd setRetryCount(Integer value) { this.RetryCount = value; return this; }
        public UUID getMessageGuid() { return MessageGuid; }
        public ChannelSmsMessagesAdd setMessageGuid(UUID value) { this.MessageGuid = value; return this; }
    }

    public static class ChannelSmsMessagesAddResponse
    {
        @DataMember(Order=2)
        public Long StatusCodesId = null;

        @DataMember(Order=3)
        public String Reference = null;

        @DataMember(Order=4)
        public Integer TenantsId = null;

        @DataMember(Order=5)
        public Long ChannelMessagesId = null;

        @DataMember(Order=6)
        public String Recipients = null;

        @DataMember(Order=7)
        public Integer TemplatesId = null;

        @DataMember(Order=8)
        public String TemplateText = null;

        @DataMember(Order=9)
        public Date DateCreated = null;

        @DataMember(Order=10)
        public Date DateSent = null;

        @DataMember(Order=11)
        public Integer RetryCount = null;

        @DataMember(Order=12)
        public UUID MessageGuid = null;

        @DataMember(Order=14)
        public ResponseStatus ResponseStatus = null;
        
        public Long getStatusCodesId() { return StatusCodesId; }
        public ChannelSmsMessagesAddResponse setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public String getReference() { return Reference; }
        public ChannelSmsMessagesAddResponse setReference(String value) { this.Reference = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public ChannelSmsMessagesAddResponse setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public Long getChannelMessagesId() { return ChannelMessagesId; }
        public ChannelSmsMessagesAddResponse setChannelMessagesId(Long value) { this.ChannelMessagesId = value; return this; }
        public String getRecipients() { return Recipients; }
        public ChannelSmsMessagesAddResponse setRecipients(String value) { this.Recipients = value; return this; }
        public Integer getTemplatesId() { return TemplatesId; }
        public ChannelSmsMessagesAddResponse setTemplatesId(Integer value) { this.TemplatesId = value; return this; }
        public String getTemplateText() { return TemplateText; }
        public ChannelSmsMessagesAddResponse setTemplateText(String value) { this.TemplateText = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public ChannelSmsMessagesAddResponse setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateSent() { return DateSent; }
        public ChannelSmsMessagesAddResponse setDateSent(Date value) { this.DateSent = value; return this; }
        public Integer getRetryCount() { return RetryCount; }
        public ChannelSmsMessagesAddResponse setRetryCount(Integer value) { this.RetryCount = value; return this; }
        public UUID getMessageGuid() { return MessageGuid; }
        public ChannelSmsMessagesAddResponse setMessageGuid(UUID value) { this.MessageGuid = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ChannelSmsMessagesAddResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java ChannelSmsMessagesAdd 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 /channel_sms_messages HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	StatusCodesId: 0,
	Reference: String,
	TenantsId: 0,
	ChannelMessagesId: 0,
	Recipients: String,
	TemplatesId: 0,
	TemplateText: String,
	DateCreated: 0001-01-01T00:00:00.0000000+00:00,
	DateSent: 0001-01-01T00:00:00.0000000+00:00,
	RetryCount: 0,
	MessageGuid: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	StatusCodesId: 0,
	Reference: String,
	TenantsId: 0,
	ChannelMessagesId: 0,
	Recipients: String,
	TemplatesId: 0,
	TemplateText: String,
	DateCreated: 0001-01-01T00:00:00.0000000+00:00,
	DateSent: 0001-01-01T00:00:00.0000000+00:00,
	RetryCount: 0,
	MessageGuid: 00000000000000000000000000000000,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}