| Requires any of the roles: | Worker, Agent, Administrator |
| 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()),
});
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<NoticeRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<DateAsOf>0001-01-01T00:00:00</DateAsOf>
<Notice>
<Notice>
<BeginDate>0001-01-01T00:00:00</BeginDate>
<ExpireDate>0001-01-01T00:00:00</ExpireDate>
<IsActive>false</IsActive>
<IsUrgent>false</IsUrgent>
<NoticeDescription>String</NoticeDescription>
<NoticeFullText>String</NoticeFullText>
<NoticeId>0</NoticeId>
<NoticeTitle>String</NoticeTitle>
<OrderIndex>0</OrderIndex>
</Notice>
</Notice>
</NoticeRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<NoticeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Notice>
<Notice>
<BeginDate>0001-01-01T00:00:00</BeginDate>
<ExpireDate>0001-01-01T00:00:00</ExpireDate>
<IsActive>false</IsActive>
<IsUrgent>false</IsUrgent>
<NoticeDescription>String</NoticeDescription>
<NoticeFullText>String</NoticeFullText>
<NoticeId>0</NoticeId>
<NoticeTitle>String</NoticeTitle>
<OrderIndex>0</OrderIndex>
</Notice>
</Notice>
<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>
</NoticeResponse>