| POST, GET | /api/SearchContactManagement |
|---|
import 'package:servicestack/servicestack.dart';
// @DataContract
class BaseRequest implements IConvertible
{
/**
* This is your AIM API Key provided by Tri-Tech
*/
// @DataMember
// @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
String? ApiKey;
// @DataMember
// @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
String? OAuthToken;
BaseRequest({this.ApiKey,this.OAuthToken});
BaseRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
ApiKey = json['ApiKey'];
OAuthToken = json['OAuthToken'];
return this;
}
Map<String, dynamic> toJson() => {
'ApiKey': ApiKey,
'OAuthToken': OAuthToken
};
getTypeName() => "BaseRequest";
TypeContext? context = _ctx;
}
// @DataContract
class BaseSecureRequest extends BaseRequest implements IConvertible
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
String? Token;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
String? DeviceId;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
String? AppId;
BaseSecureRequest({this.Token,this.DeviceId,this.AppId});
BaseSecureRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Token = json['Token'];
DeviceId = json['DeviceId'];
AppId = json['AppId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Token': Token,
'DeviceId': DeviceId,
'AppId': AppId
});
getTypeName() => "BaseSecureRequest";
TypeContext? context = _ctx;
}
// @DataContract
class BaseResponseResult implements IConvertible
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
String? StatusCode;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
String? Login;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
String? ErrorCode;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
String? ErrorDisplayText;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
String? ErrorMessage;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
String? DomainName;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
String? IpAddress;
BaseResponseResult({this.StatusCode,this.Login,this.ErrorCode,this.ErrorDisplayText,this.ErrorMessage,this.DomainName,this.IpAddress});
BaseResponseResult.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
StatusCode = json['StatusCode'];
Login = json['Login'];
ErrorCode = json['ErrorCode'];
ErrorDisplayText = json['ErrorDisplayText'];
ErrorMessage = json['ErrorMessage'];
DomainName = json['DomainName'];
IpAddress = json['IpAddress'];
return this;
}
Map<String, dynamic> toJson() => {
'StatusCode': StatusCode,
'Login': Login,
'ErrorCode': ErrorCode,
'ErrorDisplayText': ErrorDisplayText,
'ErrorMessage': ErrorMessage,
'DomainName': DomainName,
'IpAddress': IpAddress
};
getTypeName() => "BaseResponseResult";
TypeContext? context = _ctx;
}
// @DataContract
class BaseResponse implements IConvertible
{
/**
*
*/
// @DataMember
// @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
BaseResponseResult? Status;
BaseResponse({this.Status});
BaseResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Status = JsonConverters.fromJson(json['Status'],'BaseResponseResult',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Status': JsonConverters.toJson(Status,'BaseResponseResult',context!)
};
getTypeName() => "BaseResponse";
TypeContext? context = _ctx;
}
// @DataContract
class AttributeValuePair implements IConvertible
{
// @DataMember
String? Name;
// @DataMember
String? Value;
AttributeValuePair({this.Name,this.Value});
AttributeValuePair.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Name = json['Name'];
Value = json['Value'];
return this;
}
Map<String, dynamic> toJson() => {
'Name': Name,
'Value': Value
};
getTypeName() => "AttributeValuePair";
TypeContext? context = _ctx;
}
// @DataContract
class ContactManagementRecord implements IConvertible
{
// @DataMember
String? Ref;
// @DataMember
DateTime? DateTime;
// @DataMember
String? Contact;
// @DataMember
int? CusAcct;
// @DataMember
int? ActionId;
// @DataMember
String? Status;
// @DataMember
DateTime? ActionDate;
// @DataMember
bool? PopUp;
// @DataMember
int? TopicId;
// @DataMember
String? Topic;
// @DataMember
bool? Closed;
// @DataMember
DateTime? ClosedDate;
// @DataMember
int? ColorValue;
// @DataMember
String? LanId;
// @DataMember
bool? FormattedNotes;
// @DataMember
String? Note1;
// @DataMember
String? Note2;
// @DataMember
String? Note3;
// @DataMember
List<AttributeValuePair>? Attributes;
ContactManagementRecord({this.Ref,this.DateTime,this.Contact,this.CusAcct,this.ActionId,this.Status,this.ActionDate,this.PopUp,this.TopicId,this.Topic,this.Closed,this.ClosedDate,this.ColorValue,this.LanId,this.FormattedNotes,this.Note1,this.Note2,this.Note3,this.Attributes});
ContactManagementRecord.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Ref = json['Ref'];
DateTime = JsonConverters.fromJson(json['DateTime'],'DateTime',context!);
Contact = json['Contact'];
CusAcct = json['CusAcct'];
ActionId = json['ActionId'];
Status = json['Status'];
ActionDate = JsonConverters.fromJson(json['ActionDate'],'DateTime',context!);
PopUp = json['PopUp'];
TopicId = json['TopicId'];
Topic = json['Topic'];
Closed = json['Closed'];
ClosedDate = JsonConverters.fromJson(json['ClosedDate'],'DateTime',context!);
ColorValue = json['ColorValue'];
LanId = json['LanId'];
FormattedNotes = json['FormattedNotes'];
Note1 = json['Note1'];
Note2 = json['Note2'];
Note3 = json['Note3'];
Attributes = JsonConverters.fromJson(json['Attributes'],'List<AttributeValuePair>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Ref': Ref,
'DateTime': JsonConverters.toJson(DateTime,'DateTime',context!),
'Contact': Contact,
'CusAcct': CusAcct,
'ActionId': ActionId,
'Status': Status,
'ActionDate': JsonConverters.toJson(ActionDate,'DateTime',context!),
'PopUp': PopUp,
'TopicId': TopicId,
'Topic': Topic,
'Closed': Closed,
'ClosedDate': JsonConverters.toJson(ClosedDate,'DateTime',context!),
'ColorValue': ColorValue,
'LanId': LanId,
'FormattedNotes': FormattedNotes,
'Note1': Note1,
'Note2': Note2,
'Note3': Note3,
'Attributes': JsonConverters.toJson(Attributes,'List<AttributeValuePair>',context!)
};
getTypeName() => "ContactManagementRecord";
TypeContext? context = _ctx;
}
// @DataContract
class SearchContactManagementResponse extends BaseResponse implements IConvertible
{
// @DataMember
List<ContactManagementRecord>? ContactManagementRecords;
SearchContactManagementResponse({this.ContactManagementRecords});
SearchContactManagementResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
ContactManagementRecords = JsonConverters.fromJson(json['ContactManagementRecords'],'List<ContactManagementRecord>',context!);
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'ContactManagementRecords': JsonConverters.toJson(ContactManagementRecords,'List<ContactManagementRecord>',context!)
});
getTypeName() => "SearchContactManagementResponse";
TypeContext? context = _ctx;
}
/**
* SearchContactManagement web service.
*/
// @DataContract
class SearchContactManagementRequest extends BaseSecureRequest implements IConvertible
{
// @DataMember
bool? FormattedNotes;
/**
* If sent, all other search parameters will be ignored.
*/
// @DataMember
// @ApiMember(DataType="string", Description="If sent, all other search parameters will be ignored.", Name="Ref", ParameterType="query")
String? Ref;
// @DataMember
int? Acct;
// @DataMember
DateTime? DateFrom;
// @DataMember
DateTime? DateTo;
// @DataMember
bool? IncludeClosed;
/**
*
*/
// @DataMember
// @ApiMember(DataType="string", Description="", Name="SearchString", ParameterType="query")
String? SearchString;
// @DataMember
int? ActionId;
SearchContactManagementRequest({this.FormattedNotes,this.Ref,this.Acct,this.DateFrom,this.DateTo,this.IncludeClosed,this.SearchString,this.ActionId});
SearchContactManagementRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
FormattedNotes = json['FormattedNotes'];
Ref = json['Ref'];
Acct = json['Acct'];
DateFrom = JsonConverters.fromJson(json['DateFrom'],'DateTime',context!);
DateTo = JsonConverters.fromJson(json['DateTo'],'DateTime',context!);
IncludeClosed = json['IncludeClosed'];
SearchString = json['SearchString'];
ActionId = json['ActionId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'FormattedNotes': FormattedNotes,
'Ref': Ref,
'Acct': Acct,
'DateFrom': JsonConverters.toJson(DateFrom,'DateTime',context!),
'DateTo': JsonConverters.toJson(DateTo,'DateTime',context!),
'IncludeClosed': IncludeClosed,
'SearchString': SearchString,
'ActionId': ActionId
});
getTypeName() => "SearchContactManagementRequest";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
'BaseSecureRequest': TypeInfo(TypeOf.Class, create:() => BaseSecureRequest()),
'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
'AttributeValuePair': TypeInfo(TypeOf.Class, create:() => AttributeValuePair()),
'ContactManagementRecord': TypeInfo(TypeOf.Class, create:() => ContactManagementRecord()),
'List<AttributeValuePair>': TypeInfo(TypeOf.Class, create:() => <AttributeValuePair>[]),
'SearchContactManagementResponse': TypeInfo(TypeOf.Class, create:() => SearchContactManagementResponse()),
'List<ContactManagementRecord>': TypeInfo(TypeOf.Class, create:() => <ContactManagementRecord>[]),
'SearchContactManagementRequest': TypeInfo(TypeOf.Class, create:() => SearchContactManagementRequest()),
});
Dart SearchContactManagementRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/SearchContactManagement HTTP/1.1
Host: active-ewebservice.biz
Accept: application/json
Content-Type: application/json
Content-Length: length
{"FormattedNotes":false,"Ref":"String","Acct":0,"DateFrom":"0001-01-01T00:00:00.0000000","DateTo":"0001-01-01T00:00:00.0000000","IncludeClosed":false,"SearchString":"String","ActionId":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"ContactManagementRecords":[{"Ref":"String","Contact":"String","CusAcct":0,"ActionId":0,"Status":"String","ActionDate":"0001-01-01T00:00:00.0000000","PopUp":false,"TopicId":0,"Topic":"String","Closed":false,"ClosedDate":"0001-01-01T00:00:00.0000000","ColorValue":0,"LanId":"String","FormattedNotes":false,"Note1":"String","Note2":"String","Note3":"String","Attributes":[{"Name":"String","Value":"String"}]}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}