Trendsic Platform Service

<back to all web services

Messages

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Messages/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/Messages
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class MessageObject implements IConvertible
{
    String? Id;
    String? Message;

    MessageObject({this.Id,this.Message});
    MessageObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Message = json['Message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Message': Message
    };

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

class MessagesResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<MessageObject>? Messages = [];

    MessagesResponse({this.ResponseStatus,this.Messages});
    MessagesResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Messages = JsonConverters.fromJson(json['Messages'],'List<MessageObject>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Messages': JsonConverters.toJson(Messages,'List<MessageObject>',context!)
    };

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

class Messages extends MessageObject implements IConvertible
{
    String? ApiKey;

    Messages({this.ApiKey});
    Messages.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        ApiKey = json['ApiKey'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'ApiKey': ApiKey
    });

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'MessageObject': TypeInfo(TypeOf.Class, create:() => MessageObject()),
    'MessagesResponse': TypeInfo(TypeOf.Class, create:() => MessagesResponse()),
    'List<MessageObject>': TypeInfo(TypeOf.Class, create:() => <MessageObject>[]),
    'Messages': TypeInfo(TypeOf.Class, create:() => Messages()),
});

Dart Messages 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 /v1/Messages/{Id} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	Message: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Messages: 
	[
		{
			Id: 00000000000000000000000000000000,
			Message: String
		}
	]
}