Trendsic Platform Service

<back to all web services

NoticeRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET,POST,OPTIONS/v1/Notice/{NoticeId}
GET,OPTIONS/v1/Notice
GET,OPTIONS/v1/Notice/History/{DateAsOf}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class Notice implements IConvertible
{
    int? NoticeId;
    DateTime? BeginDate;
    DateTime? ExpireDate;
    String? NoticeTitle;
    String? NoticeDescription;
    String? NoticeFullText;
    int? OrderIndex;
    bool? IsActive;
    bool? IsUrgent;

    Notice({this.NoticeId,this.BeginDate,this.ExpireDate,this.NoticeTitle,this.NoticeDescription,this.NoticeFullText,this.OrderIndex,this.IsActive,this.IsUrgent});
    Notice.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        NoticeId = json['NoticeId'];
        BeginDate = JsonConverters.fromJson(json['BeginDate'],'DateTime',context!);
        ExpireDate = JsonConverters.fromJson(json['ExpireDate'],'DateTime',context!);
        NoticeTitle = json['NoticeTitle'];
        NoticeDescription = json['NoticeDescription'];
        NoticeFullText = json['NoticeFullText'];
        OrderIndex = json['OrderIndex'];
        IsActive = json['IsActive'];
        IsUrgent = json['IsUrgent'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'NoticeId': NoticeId,
        'BeginDate': JsonConverters.toJson(BeginDate,'DateTime',context!),
        'ExpireDate': JsonConverters.toJson(ExpireDate,'DateTime',context!),
        'NoticeTitle': NoticeTitle,
        'NoticeDescription': NoticeDescription,
        'NoticeFullText': NoticeFullText,
        'OrderIndex': OrderIndex,
        'IsActive': IsActive,
        'IsUrgent': IsUrgent
    };

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

class NoticeResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<Notice>? Notice = [];

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

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

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

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

class NoticeRequest implements IConvertible
{
    DateTime? DateAsOf;
    List<Notice>? Notice = [];

    NoticeRequest({this.DateAsOf,this.Notice});
    NoticeRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'DateAsOf': JsonConverters.toJson(DateAsOf,'DateTime',context!),
        'Notice': JsonConverters.toJson(Notice,'List<Notice>',context!)
    };

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

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

Dart NoticeRequest DTOs

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

HTTP + CSV

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

POST /v1/Notice/{NoticeId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DateAsOf":"0001-01-01T00:00:00.0000000","Notice":[{"NoticeId":0,"BeginDate":"0001-01-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","NoticeTitle":"String","NoticeDescription":"String","NoticeFullText":"String","OrderIndex":0,"IsActive":false,"IsUrgent":false}]}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Notice":[{"NoticeId":0,"BeginDate":"0001-01-01T00:00:00.0000000","ExpireDate":"0001-01-01T00:00:00.0000000","NoticeTitle":"String","NoticeDescription":"String","NoticeFullText":"String","OrderIndex":0,"IsActive":false,"IsUrgent":false}]}