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

GET /v1/Notifications HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	},
	Notifications: 
	[
		{
			NotificationHeaderId: 0,
			Subject: String,
			Status: String,
			NeedsCloseApproval: False,
			IsDeleted: False,
			CreatedBy: 0,
			DateCreated: 0001-01-01
		}
	]
}