Trendsic Platform Service

<back to all web services

IncomingNotifications

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/IncomingNotifications/{Id}
GET,POST,PUT,DELETE,OPTIONS/v1/IncomingNotifications
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class IncomingNotificationObject implements IConvertible
{
    String? Id;
    String? CustomerId;
    String? Message;
    String? NotificationMethod;
    DateTime? DateReceived;

    IncomingNotificationObject({this.Id,this.CustomerId,this.Message,this.NotificationMethod,this.DateReceived});
    IncomingNotificationObject.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        CustomerId = json['CustomerId'];
        Message = json['Message'];
        NotificationMethod = json['NotificationMethod'];
        DateReceived = JsonConverters.fromJson(json['DateReceived'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'CustomerId': CustomerId,
        'Message': Message,
        'NotificationMethod': NotificationMethod,
        'DateReceived': JsonConverters.toJson(DateReceived,'DateTime',context!)
    };

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

class IncomingNotificationsResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<IncomingNotificationObject>? IncomingNotifications = [];

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

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

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

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

class IncomingNotifications extends IncomingNotificationObject implements IConvertible
{
    String? ApiKey;

    IncomingNotifications({this.ApiKey});
    IncomingNotifications.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() => "IncomingNotifications";
    TypeContext? context = _ctx;
}

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

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

{
	ApiKey: 00000000000000000000000000000000,
	Id: 00000000000000000000000000000000,
	CustomerId: 00000000000000000000000000000000,
	Message: String,
	NotificationMethod: 00000000000000000000000000000000,
	DateReceived: 0001-01-01
}
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
		}
	},
	IncomingNotifications: 
	[
		{
			Id: 00000000000000000000000000000000,
			CustomerId: 00000000000000000000000000000000,
			Message: String,
			NotificationMethod: 00000000000000000000000000000000,
			DateReceived: 0001-01-01
		}
	]
}