| Requires the role: | Client |
| GET | /auto/segments/{Id} | ||
|---|---|---|---|
| GET | /auto/segments |
import 'package:servicestack/servicestack.dart';
import 'dart:collection';
// @DataContract
abstract class QueryBase
{
// @DataMember(Order=1)
int? Skip;
// @DataMember(Order=2)
int? Take;
// @DataMember(Order=3)
String? OrderBy;
// @DataMember(Order=4)
String? OrderByDesc;
// @DataMember(Order=5)
String? Include;
// @DataMember(Order=6)
String? Fields;
// @DataMember(Order=7)
Map<String,String?>? Meta;
QueryBase({this.Skip,this.Take,this.OrderBy,this.OrderByDesc,this.Include,this.Fields,this.Meta});
QueryBase.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Skip = json['Skip'];
Take = json['Take'];
OrderBy = json['OrderBy'];
OrderByDesc = json['OrderByDesc'];
Include = json['Include'];
Fields = json['Fields'];
Meta = JsonConverters.toStringMap(json['Meta']);
return this;
}
Map<String, dynamic> toJson() => {
'Skip': Skip,
'Take': Take,
'OrderBy': OrderBy,
'OrderByDesc': OrderByDesc,
'Include': Include,
'Fields': Fields,
'Meta': Meta
};
getTypeName() => "QueryBase";
TypeContext? context = _ctx;
}
abstract class QueryDb<T> extends QueryBase
{
QueryDb();
QueryDb.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() => "QueryDb<$T>";
TypeContext? context = _ctx;
}
class Segments implements IConvertible
{
// @DataMember(Order=1)
// @Required()
int? Id;
// @DataMember(Order=2)
// @Required()
// @References(typeof(Tenants))
int? TenantsId;
// @DataMember(Order=3)
// @Required()
String? Name;
// @DataMember(Order=4)
bool? IsCustom;
Segments({this.Id,this.TenantsId,this.Name,this.IsCustom});
Segments.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
TenantsId = json['TenantsId'];
Name = json['Name'];
IsCustom = json['IsCustom'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'TenantsId': TenantsId,
'Name': Name,
'IsCustom': IsCustom
};
getTypeName() => "Segments";
TypeContext? context = _ctx;
}
class SegmentsAutoQueryLookup extends QueryDb<Segments> implements IGet, IConvertible
{
// @DataMember(Order=1)
int? Id;
// @DataMember(Order=2)
int? TenantsId;
SegmentsAutoQueryLookup({this.Id,this.TenantsId});
SegmentsAutoQueryLookup.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
super.fromMap(json);
Id = json['Id'];
TenantsId = json['TenantsId'];
return this;
}
Map<String, dynamic> toJson() => super.toJson()..addAll({
'Id': Id,
'TenantsId': TenantsId
});
getTypeName() => "SegmentsAutoQueryLookup";
TypeContext? context = _ctx;
}
class CampaignCustomersView implements IConvertible
{
// @DataMember(Order=1)
int? Id;
// @DataMember(Order=2)
String? Name;
// @DataMember(Order=3)
String? Description;
// @DataMember(Order=4)
int? CustomersId;
// @DataMember(Order=5)
String? FirstName;
// @DataMember(Order=6)
String? LastName;
// @DataMember(Order=7)
String? IdNumber;
// @DataMember(Order=8)
String? PassportNumber;
// @DataMember(Order=9)
String? Email;
// @DataMember(Order=10)
String? MobileNumber;
// @DataMember(Order=11)
String? CustomerUniqueIdentifier;
// @DataMember(Order=12)
String? CustomerPublicAccessGuid;
// @DataMember(Order=13)
String? CampaignPublicAccessGuid;
// @DataMember(Order=14)
int? TenantsId;
CampaignCustomersView({this.Id,this.Name,this.Description,this.CustomersId,this.FirstName,this.LastName,this.IdNumber,this.PassportNumber,this.Email,this.MobileNumber,this.CustomerUniqueIdentifier,this.CustomerPublicAccessGuid,this.CampaignPublicAccessGuid,this.TenantsId});
CampaignCustomersView.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
Name = json['Name'];
Description = json['Description'];
CustomersId = json['CustomersId'];
FirstName = json['FirstName'];
LastName = json['LastName'];
IdNumber = json['IdNumber'];
PassportNumber = json['PassportNumber'];
Email = json['Email'];
MobileNumber = json['MobileNumber'];
CustomerUniqueIdentifier = json['CustomerUniqueIdentifier'];
CustomerPublicAccessGuid = json['CustomerPublicAccessGuid'];
CampaignPublicAccessGuid = json['CampaignPublicAccessGuid'];
TenantsId = json['TenantsId'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'Name': Name,
'Description': Description,
'CustomersId': CustomersId,
'FirstName': FirstName,
'LastName': LastName,
'IdNumber': IdNumber,
'PassportNumber': PassportNumber,
'Email': Email,
'MobileNumber': MobileNumber,
'CustomerUniqueIdentifier': CustomerUniqueIdentifier,
'CustomerPublicAccessGuid': CustomerPublicAccessGuid,
'CampaignPublicAccessGuid': CampaignPublicAccessGuid,
'TenantsId': TenantsId
};
getTypeName() => "CampaignCustomersView";
TypeContext? context = _ctx;
}
// @DataContract
class QueryResponse<T> implements IConvertible
{
// @DataMember(Order=1)
int? Offset;
// @DataMember(Order=2)
int? Total;
// @DataMember(Order=3)
List<CampaignCustomersView>? Results;
// @DataMember(Order=4)
Map<String,String?>? Meta;
// @DataMember(Order=5)
ResponseStatus? ResponseStatus;
QueryResponse({this.Offset,this.Total,this.Results,this.Meta,this.ResponseStatus});
QueryResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Offset = json['Offset'];
Total = json['Total'];
Results = JsonConverters.fromJson(json['Results'],'List<CampaignCustomersView>',context!);
Meta = JsonConverters.toStringMap(json['Meta']);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Offset': Offset,
'Total': Total,
'Results': JsonConverters.toJson(Results,'List<CampaignCustomersView>',context!),
'Meta': Meta,
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "QueryResponse<$T>";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
'Segments': TypeInfo(TypeOf.Class, create:() => Segments()),
'SegmentsAutoQueryLookup': TypeInfo(TypeOf.Class, create:() => SegmentsAutoQueryLookup()),
'List<Segments>': TypeInfo(TypeOf.Class, create:() => <Segments>[]),
'CampaignCustomersView': TypeInfo(TypeOf.Class, create:() => CampaignCustomersView()),
'List<CampaignCustomersView>': TypeInfo(TypeOf.Class, create:() => <CampaignCustomersView>[]),
});
Dart SegmentsAutoQueryLookup DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /auto/segments/{Id} HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"TenantsId":0,"Name":"String","IsCustom":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}