Trendsic Platform Service

<back to all web services

NotificationsRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/Notifications
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class NotificationHeader implements IConvertible
{
    int? NotificationHeaderId;
    String? Subject;
    String? Status;
    bool? NeedsCloseApproval;
    bool? IsDeleted;
    int? CreatedBy;
    DateTime? DateCreated;

    NotificationHeader({this.NotificationHeaderId,this.Subject,this.Status,this.NeedsCloseApproval,this.IsDeleted,this.CreatedBy,this.DateCreated});
    NotificationHeader.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NotificationHeaderId = json['NotificationHeaderId'];
        Subject = json['Subject'];
        Status = json['Status'];
        NeedsCloseApproval = json['NeedsCloseApproval'];
        IsDeleted = json['IsDeleted'];
        CreatedBy = json['CreatedBy'];
        DateCreated = JsonConverters.fromJson(json['DateCreated'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NotificationHeaderId': NotificationHeaderId,
        'Subject': Subject,
        'Status': Status,
        'NeedsCloseApproval': NeedsCloseApproval,
        'IsDeleted': IsDeleted,
        'CreatedBy': CreatedBy,
        'DateCreated': JsonConverters.toJson(DateCreated,'DateTime',context!)
    };

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

class Notification extends NotificationHeader implements IConvertible
{
    Notification();
    Notification.fromJson(Map<String, dynamic> json) : super.fromJson(json);
    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson();
    getTypeName() => "Notification";
    TypeContext? context = _ctx;
}

class NotificationsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<Notification>? Notifications = [];

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

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

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

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

class NotificationsRequest implements IConvertible
{
    NotificationsRequest();
    NotificationsRequest.fromJson(Map<String, dynamic> json) : super();
    fromMap(Map<String, dynamic> json) {
        return this;
    }

    Map<String, dynamic> toJson() => {};
    getTypeName() => "NotificationsRequest";
    TypeContext? context = _ctx;
}

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

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

GET /v1/Notifications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NotificationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Notifications>
    <Notification>
      <CreatedBy>0</CreatedBy>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <IsDeleted>false</IsDeleted>
      <NeedsCloseApproval>false</NeedsCloseApproval>
      <NotificationHeaderId>0</NotificationHeaderId>
      <Status>String</Status>
      <Subject>String</Subject>
      <LastMessage>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <Message>String</Message>
        <NotificationHeaderId>0</NotificationHeaderId>
        <NotificationMessageId>0</NotificationMessageId>
        <SenderId>0</SenderId>
        <SenderName>String</SenderName>
        <Subject>String</Subject>
      </LastMessage>
    </Notification>
  </Notifications>
  <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>
</NotificationsResponse>