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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChannelMessagesAddResponse:
    channel_id: int = 0
    queries_id: int = 0
    primarykey_field_name: Optional[str] = None
    primarykey_id_value: Optional[str] = None
    tenants_id: int = 0
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ChannelMessagesAdd:
    # @Validate(Validator="NotNull")
    channel_id: int = 0

    # @Validate(Validator="NotNull")
    queries_id: int = 0

    # @Validate(Validator="NotNull")
    primarykey_field_name: Optional[str] = None

    # @Validate(Validator="NotNull")
    primarykey_id_value: Optional[str] = None

    # @Validate(Validator="NotNull")
    tenants_id: int = 0

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

{
	ChannelId: 0,
	QueriesId: 0,
	PrimarykeyFieldName: String,
	PrimarykeyIdValue: String,
	TenantsId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ChannelId: 0,
	QueriesId: 0,
	PrimarykeyFieldName: String,
	PrimarykeyIdValue: String,
	TenantsId: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}