Trendsic Platform Service

<back to all web services

UserNotificationsRequest

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

class UserNotification implements IConvertible
{
    int? NotificationId;
    int? AgentId;
    String? Description;
    String? From;
    DateTime? CreatedDate;
    String? Type;
    String? URL;
    String? RefId;
    bool? IsDeleted;

    UserNotification({this.NotificationId,this.AgentId,this.Description,this.From,this.CreatedDate,this.Type,this.URL,this.RefId,this.IsDeleted});
    UserNotification.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NotificationId = json['NotificationId'];
        AgentId = json['AgentId'];
        Description = json['Description'];
        From = json['From'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        Type = json['Type'];
        URL = json['URL'];
        RefId = json['RefId'];
        IsDeleted = json['IsDeleted'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NotificationId': NotificationId,
        'AgentId': AgentId,
        'Description': Description,
        'From': From,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'Type': Type,
        'URL': URL,
        'RefId': RefId,
        'IsDeleted': IsDeleted
    };

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

class UserNotificationsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<UserNotification>? Notifications = [];
    bool? Deleted;

    UserNotificationsResponse({this.ResponseStatus,this.Notifications,this.Deleted});
    UserNotificationsResponse.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<UserNotification>',context!);
        Deleted = json['Deleted'];
        return this;
    }

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

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

class UserNotificationsRequest implements IConvertible
{
    int? AgentId;
    int? NotificationId;
    bool? ShowDeleted;

    UserNotificationsRequest({this.AgentId,this.NotificationId,this.ShowDeleted});
    UserNotificationsRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AgentId = json['AgentId'];
        NotificationId = json['NotificationId'];
        ShowDeleted = json['ShowDeleted'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'AgentId': AgentId,
        'NotificationId': NotificationId,
        'ShowDeleted': ShowDeleted
    };

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

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

Dart UserNotificationsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/UserNotifications/{AgentId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Notifications":[{"NotificationId":0,"AgentId":0,"Description":"String","From":"String","CreatedDate":"0001-01-01T00:00:00.0000000","Type":"String","URL":"String","RefId":"String","IsDeleted":false}],"Deleted":false}