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

<Messages xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>00000000-0000-0000-0000-000000000000</Id>
  <Message>String</Message>
  <ApiKey>00000000-0000-0000-0000-000000000000</ApiKey>
</Messages>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MessagesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Messages>
    <MessageObject>
      <Id>00000000-0000-0000-0000-000000000000</Id>
      <Message>String</Message>
    </MessageObject>
  </Messages>
  <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>
</MessagesResponse>