digitaluapi

<back to all web services

ChannelSmsMessagesEdit

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

public class dtos
{

    @DataContract
    public static class ChannelSmsMessagesEdit
    {
        @DataMember(Order=1)
        @Validate(Validator="NotNull")
        public Long Id = null;

        @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 getId() { return Id; }
        public ChannelSmsMessagesEdit setId(Long value) { this.Id = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public ChannelSmsMessagesEdit setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public String getReference() { return Reference; }
        public ChannelSmsMessagesEdit setReference(String value) { this.Reference = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public ChannelSmsMessagesEdit setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public Long getChannelMessagesId() { return ChannelMessagesId; }
        public ChannelSmsMessagesEdit setChannelMessagesId(Long value) { this.ChannelMessagesId = value; return this; }
        public String getRecipients() { return Recipients; }
        public ChannelSmsMessagesEdit setRecipients(String value) { this.Recipients = value; return this; }
        public Integer getTemplatesId() { return TemplatesId; }
        public ChannelSmsMessagesEdit setTemplatesId(Integer value) { this.TemplatesId = value; return this; }
        public String getTemplateText() { return TemplateText; }
        public ChannelSmsMessagesEdit setTemplateText(String value) { this.TemplateText = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public ChannelSmsMessagesEdit setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateSent() { return DateSent; }
        public ChannelSmsMessagesEdit setDateSent(Date value) { this.DateSent = value; return this; }
        public Integer getRetryCount() { return RetryCount; }
        public ChannelSmsMessagesEdit setRetryCount(Integer value) { this.RetryCount = value; return this; }
        public UUID getMessageGuid() { return MessageGuid; }
        public ChannelSmsMessagesEdit setMessageGuid(UUID value) { this.MessageGuid = value; return this; }
    }

    public static class ChannelSmsMessagesEditResponse
    {
        @DataMember(Order=1)
        public Long Id = null;

        @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 getId() { return Id; }
        public ChannelSmsMessagesEditResponse setId(Long value) { this.Id = value; return this; }
        public Long getStatusCodesId() { return StatusCodesId; }
        public ChannelSmsMessagesEditResponse setStatusCodesId(Long value) { this.StatusCodesId = value; return this; }
        public String getReference() { return Reference; }
        public ChannelSmsMessagesEditResponse setReference(String value) { this.Reference = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public ChannelSmsMessagesEditResponse setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public Long getChannelMessagesId() { return ChannelMessagesId; }
        public ChannelSmsMessagesEditResponse setChannelMessagesId(Long value) { this.ChannelMessagesId = value; return this; }
        public String getRecipients() { return Recipients; }
        public ChannelSmsMessagesEditResponse setRecipients(String value) { this.Recipients = value; return this; }
        public Integer getTemplatesId() { return TemplatesId; }
        public ChannelSmsMessagesEditResponse setTemplatesId(Integer value) { this.TemplatesId = value; return this; }
        public String getTemplateText() { return TemplateText; }
        public ChannelSmsMessagesEditResponse setTemplateText(String value) { this.TemplateText = value; return this; }
        public Date getDateCreated() { return DateCreated; }
        public ChannelSmsMessagesEditResponse setDateCreated(Date value) { this.DateCreated = value; return this; }
        public Date getDateSent() { return DateSent; }
        public ChannelSmsMessagesEditResponse setDateSent(Date value) { this.DateSent = value; return this; }
        public Integer getRetryCount() { return RetryCount; }
        public ChannelSmsMessagesEditResponse setRetryCount(Integer value) { this.RetryCount = value; return this; }
        public UUID getMessageGuid() { return MessageGuid; }
        public ChannelSmsMessagesEditResponse setMessageGuid(UUID value) { this.MessageGuid = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ChannelSmsMessagesEditResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java ChannelSmsMessagesEdit 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.

PUT /channel_sms_messages/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ChannelSmsMessagesEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <StatusCodesId>0</StatusCodesId>
  <Reference>String</Reference>
  <TenantsId>0</TenantsId>
  <ChannelMessagesId>0</ChannelMessagesId>
  <Recipients>String</Recipients>
  <TemplatesId>0</TemplatesId>
  <TemplateText>String</TemplateText>
  <DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateCreated>
  <DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateSent>
  <RetryCount>0</RetryCount>
  <MessageGuid>00000000-0000-0000-0000-000000000000</MessageGuid>
</ChannelSmsMessagesEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ChannelSmsMessagesEditResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ChannelMessagesId>0</ChannelMessagesId>
  <DateCreated xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateCreated>
  <DateSent xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </DateSent>
  <Id>0</Id>
  <MessageGuid>00000000-0000-0000-0000-000000000000</MessageGuid>
  <Recipients>String</Recipients>
  <Reference>String</Reference>
  <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>
  <RetryCount>0</RetryCount>
  <StatusCodesId>0</StatusCodesId>
  <TemplateText>String</TemplateText>
  <TemplatesId>0</TemplatesId>
  <TenantsId>0</TenantsId>
</ChannelSmsMessagesEditResponse>