digitaluapi

<back to all web services

ChannelMessagesAdd

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

public class dtos
{

    @DataContract
    public static class ChannelMessagesAdd
    {
        @DataMember(Order=2)
        @Validate(Validator="NotNull")
        public Integer ChannelId = null;

        @DataMember(Order=3)
        @Validate(Validator="NotNull")
        public Long QueriesId = null;

        @DataMember(Order=4)
        @Validate(Validator="NotNull")
        public String PrimarykeyFieldName = null;

        @DataMember(Order=5)
        @Validate(Validator="NotNull")
        public String PrimarykeyIdValue = null;

        @DataMember(Order=6)
        @Validate(Validator="NotNull")
        public Integer TenantsId = null;
        
        public Integer getChannelId() { return ChannelId; }
        public ChannelMessagesAdd setChannelId(Integer value) { this.ChannelId = value; return this; }
        public Long getQueriesId() { return QueriesId; }
        public ChannelMessagesAdd setQueriesId(Long value) { this.QueriesId = value; return this; }
        public String getPrimarykeyFieldName() { return PrimarykeyFieldName; }
        public ChannelMessagesAdd setPrimarykeyFieldName(String value) { this.PrimarykeyFieldName = value; return this; }
        public String getPrimarykeyIdValue() { return PrimarykeyIdValue; }
        public ChannelMessagesAdd setPrimarykeyIdValue(String value) { this.PrimarykeyIdValue = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public ChannelMessagesAdd setTenantsId(Integer value) { this.TenantsId = value; return this; }
    }

    public static class ChannelMessagesAddResponse
    {
        @DataMember(Order=2)
        public Integer ChannelId = null;

        @DataMember(Order=3)
        public Long QueriesId = null;

        @DataMember(Order=4)
        public String PrimarykeyFieldName = null;

        @DataMember(Order=5)
        public String PrimarykeyIdValue = null;

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

        @DataMember(Order=8)
        public ResponseStatus ResponseStatus = null;
        
        public Integer getChannelId() { return ChannelId; }
        public ChannelMessagesAddResponse setChannelId(Integer value) { this.ChannelId = value; return this; }
        public Long getQueriesId() { return QueriesId; }
        public ChannelMessagesAddResponse setQueriesId(Long value) { this.QueriesId = value; return this; }
        public String getPrimarykeyFieldName() { return PrimarykeyFieldName; }
        public ChannelMessagesAddResponse setPrimarykeyFieldName(String value) { this.PrimarykeyFieldName = value; return this; }
        public String getPrimarykeyIdValue() { return PrimarykeyIdValue; }
        public ChannelMessagesAddResponse setPrimarykeyIdValue(String value) { this.PrimarykeyIdValue = value; return this; }
        public Integer getTenantsId() { return TenantsId; }
        public ChannelMessagesAddResponse setTenantsId(Integer value) { this.TenantsId = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public ChannelMessagesAddResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java ChannelMessagesAdd 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 /channel_messages HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ChannelMessagesAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ChannelId>0</ChannelId>
  <QueriesId>0</QueriesId>
  <PrimarykeyFieldName>String</PrimarykeyFieldName>
  <PrimarykeyIdValue>String</PrimarykeyIdValue>
  <TenantsId>0</TenantsId>
</ChannelMessagesAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ChannelMessagesAddResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <ChannelId>0</ChannelId>
  <PrimarykeyFieldName>String</PrimarykeyFieldName>
  <PrimarykeyIdValue>String</PrimarykeyIdValue>
  <QueriesId>0</QueriesId>
  <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>
  <TenantsId>0</TenantsId>
</ChannelMessagesAddResponse>