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 'package:servicestack/servicestack.dart';
import 'dart:collection';

class ChannelMessagesAddResponse implements IConvertible
{
    // @DataMember(Order=2)
    int? ChannelId;

    // @DataMember(Order=3)
    int? QueriesId;

    // @DataMember(Order=4)
    String? PrimarykeyFieldName;

    // @DataMember(Order=5)
    String? PrimarykeyIdValue;

    // @DataMember(Order=6)
    int? TenantsId;

    // @DataMember(Order=8)
    ResponseStatus? ResponseStatus;

    ChannelMessagesAddResponse({this.ChannelId,this.QueriesId,this.PrimarykeyFieldName,this.PrimarykeyIdValue,this.TenantsId,this.ResponseStatus});
    ChannelMessagesAddResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ChannelId = json['ChannelId'];
        QueriesId = json['QueriesId'];
        PrimarykeyFieldName = json['PrimarykeyFieldName'];
        PrimarykeyIdValue = json['PrimarykeyIdValue'];
        TenantsId = json['TenantsId'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ChannelId': ChannelId,
        'QueriesId': QueriesId,
        'PrimarykeyFieldName': PrimarykeyFieldName,
        'PrimarykeyIdValue': PrimarykeyIdValue,
        'TenantsId': TenantsId,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "ChannelMessagesAddResponse";
    TypeContext? context = _ctx;
}

// @DataContract
class ChannelMessagesAdd implements IConvertible
{
    // @DataMember(Order=2)
    // @Validate(Validator="NotNull")
    int? ChannelId;

    // @DataMember(Order=3)
    // @Validate(Validator="NotNull")
    int? QueriesId;

    // @DataMember(Order=4)
    // @Validate(Validator="NotNull")
    String? PrimarykeyFieldName;

    // @DataMember(Order=5)
    // @Validate(Validator="NotNull")
    String? PrimarykeyIdValue;

    // @DataMember(Order=6)
    // @Validate(Validator="NotNull")
    int? TenantsId;

    ChannelMessagesAdd({this.ChannelId,this.QueriesId,this.PrimarykeyFieldName,this.PrimarykeyIdValue,this.TenantsId});
    ChannelMessagesAdd.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ChannelId = json['ChannelId'];
        QueriesId = json['QueriesId'];
        PrimarykeyFieldName = json['PrimarykeyFieldName'];
        PrimarykeyIdValue = json['PrimarykeyIdValue'];
        TenantsId = json['TenantsId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ChannelId': ChannelId,
        'QueriesId': QueriesId,
        'PrimarykeyFieldName': PrimarykeyFieldName,
        'PrimarykeyIdValue': PrimarykeyIdValue,
        'TenantsId': TenantsId
    };

    getTypeName() => "ChannelMessagesAdd";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
    'ChannelMessagesAddResponse': TypeInfo(TypeOf.Class, create:() => ChannelMessagesAddResponse()),
    'ChannelMessagesAdd': TypeInfo(TypeOf.Class, create:() => ChannelMessagesAdd()),
});

Dart 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>