| GET | /campaign/inbox/formmeta |
|---|
import 'package:servicestack/servicestack.dart';
class FormFieldOption implements IConvertible
{
String? Value;
String? Label;
FormFieldOption({this.Value,this.Label});
FormFieldOption.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Value = json['Value'];
Label = json['Label'];
return this;
}
Map<String, dynamic> toJson() => {
'Value': Value,
'Label': Label
};
getTypeName() => "FormFieldOption";
TypeContext? context = _ctx;
}
class FormField implements IConvertible
{
int? Id;
String? ControlType;
String? Label;
String? Placeholder;
String? Help;
String? Name;
int? SortOrder;
List<FormFieldOption>? Options;
List<String>? Validation;
FormField({this.Id,this.ControlType,this.Label,this.Placeholder,this.Help,this.Name,this.SortOrder,this.Options,this.Validation});
FormField.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
ControlType = json['ControlType'];
Label = json['Label'];
Placeholder = json['Placeholder'];
Help = json['Help'];
Name = json['Name'];
SortOrder = json['SortOrder'];
Options = JsonConverters.fromJson(json['Options'],'List<FormFieldOption>',context!);
Validation = JsonConverters.fromJson(json['Validation'],'List<String>',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'ControlType': ControlType,
'Label': Label,
'Placeholder': Placeholder,
'Help': Help,
'Name': Name,
'SortOrder': SortOrder,
'Options': JsonConverters.toJson(Options,'List<FormFieldOption>',context!),
'Validation': JsonConverters.toJson(Validation,'List<String>',context!)
};
getTypeName() => "FormField";
TypeContext? context = _ctx;
}
class CampaignActionFile implements IConvertible
{
String? Name;
String? FileType;
String? FileSize;
String? Extension;
String? UploadUrl;
CampaignActionFile({this.Name,this.FileType,this.FileSize,this.Extension,this.UploadUrl});
CampaignActionFile.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Name = json['Name'];
FileType = json['FileType'];
FileSize = json['FileSize'];
Extension = json['Extension'];
UploadUrl = json['UploadUrl'];
return this;
}
Map<String, dynamic> toJson() => {
'Name': Name,
'FileType': FileType,
'FileSize': FileSize,
'Extension': Extension,
'UploadUrl': UploadUrl
};
getTypeName() => "CampaignActionFile";
TypeContext? context = _ctx;
}
class CampaignActions implements IConvertible
{
// @DataMember(Order=1)
// @Required()
int? Id;
// @DataMember(Order=2)
// @Required()
// @References(typeof(Campaigns))
int? CampaignsId;
// @DataMember(Order=3)
// @References(typeof(Actions))
int? ActionsId;
// @DataMember(Order=4)
String? ButtonName;
// @DataMember(Order=5)
// @References(typeof(ActionTypes))
int? ActionTypesId;
// @DataMember(Order=6)
String? Description;
// @DataMember(Order=7)
int? OfferOrder;
// @DataMember(Order=8)
bool? StandOut;
// @DataMember(Order=9)
// @Required()
String? PublicAccessGuid;
// @DataMember(Order=10)
List<FormField>? FormMeta;
// @DataMember(Order=11)
List<CampaignActionFile>? Files;
// @DataMember(Order=12)
String? SentToEmailAddress;
// @DataMember(Order=13)
String? CcEmailAddress;
CampaignActions({this.Id,this.CampaignsId,this.ActionsId,this.ButtonName,this.ActionTypesId,this.Description,this.OfferOrder,this.StandOut,this.PublicAccessGuid,this.FormMeta,this.Files,this.SentToEmailAddress,this.CcEmailAddress});
CampaignActions.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
CampaignsId = json['CampaignsId'];
ActionsId = json['ActionsId'];
ButtonName = json['ButtonName'];
ActionTypesId = json['ActionTypesId'];
Description = json['Description'];
OfferOrder = json['OfferOrder'];
StandOut = json['StandOut'];
PublicAccessGuid = json['PublicAccessGuid'];
FormMeta = JsonConverters.fromJson(json['FormMeta'],'List<FormField>',context!);
Files = JsonConverters.fromJson(json['Files'],'List<CampaignActionFile>',context!);
SentToEmailAddress = json['SentToEmailAddress'];
CcEmailAddress = json['CcEmailAddress'];
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'CampaignsId': CampaignsId,
'ActionsId': ActionsId,
'ButtonName': ButtonName,
'ActionTypesId': ActionTypesId,
'Description': Description,
'OfferOrder': OfferOrder,
'StandOut': StandOut,
'PublicAccessGuid': PublicAccessGuid,
'FormMeta': JsonConverters.toJson(FormMeta,'List<FormField>',context!),
'Files': JsonConverters.toJson(Files,'List<CampaignActionFile>',context!),
'SentToEmailAddress': SentToEmailAddress,
'CcEmailAddress': CcEmailAddress
};
getTypeName() => "CampaignActions";
TypeContext? context = _ctx;
}
class InboxActionResponse implements IConvertible
{
CampaignActions? campaignAction;
ResponseStatus? ResponseStatus;
InboxActionResponse({this.campaignAction,this.ResponseStatus});
InboxActionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
campaignAction = JsonConverters.fromJson(json['campaignAction'],'CampaignActions',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'campaignAction': JsonConverters.toJson(campaignAction,'CampaignActions',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "InboxActionResponse";
TypeContext? context = _ctx;
}
class GetCampaignActionClientForm implements IConvertible
{
String? CommsGuid;
int? CampaignActionsRequestsId;
GetCampaignActionClientForm({this.CommsGuid,this.CampaignActionsRequestsId});
GetCampaignActionClientForm.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CommsGuid = json['CommsGuid'];
CampaignActionsRequestsId = json['CampaignActionsRequestsId'];
return this;
}
Map<String, dynamic> toJson() => {
'CommsGuid': CommsGuid,
'CampaignActionsRequestsId': CampaignActionsRequestsId
};
getTypeName() => "GetCampaignActionClientForm";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'duengageapi.uat.scadsoftware.com', types: <String, TypeInfo> {
'FormFieldOption': TypeInfo(TypeOf.Class, create:() => FormFieldOption()),
'FormField': TypeInfo(TypeOf.Class, create:() => FormField()),
'List<FormFieldOption>': TypeInfo(TypeOf.Class, create:() => <FormFieldOption>[]),
'CampaignActionFile': TypeInfo(TypeOf.Class, create:() => CampaignActionFile()),
'CampaignActions': TypeInfo(TypeOf.Class, create:() => CampaignActions()),
'List<FormField>': TypeInfo(TypeOf.Class, create:() => <FormField>[]),
'List<CampaignActionFile>': TypeInfo(TypeOf.Class, create:() => <CampaignActionFile>[]),
'InboxActionResponse': TypeInfo(TypeOf.Class, create:() => InboxActionResponse()),
'GetCampaignActionClientForm': TypeInfo(TypeOf.Class, create:() => GetCampaignActionClientForm()),
});
Dart GetCampaignActionClientForm DTOs
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.
GET /campaign/inbox/formmeta HTTP/1.1 Host: duengageapi.uat.scadsoftware.com Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<InboxActionResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<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>
<campaignAction xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
<d2p1:ActionTypesId>0</d2p1:ActionTypesId>
<d2p1:ActionsId>0</d2p1:ActionsId>
<d2p1:ButtonName>String</d2p1:ButtonName>
<d2p1:CampaignsId>0</d2p1:CampaignsId>
<d2p1:CcEmailAddress>String</d2p1:CcEmailAddress>
<d2p1:Description>String</d2p1:Description>
<d2p1:Files>
<CampaignActionFile>
<Extension>String</Extension>
<FileSize>String</FileSize>
<FileType>String</FileType>
<Name>String</Name>
<UploadUrl>String</UploadUrl>
</CampaignActionFile>
</d2p1:Files>
<d2p1:FormMeta>
<FormField>
<ControlType>String</ControlType>
<Help>String</Help>
<Id>0</Id>
<Label>String</Label>
<Name>String</Name>
<Options>
<FormFieldOption>
<Label>String</Label>
<Value>String</Value>
</FormFieldOption>
</Options>
<Placeholder>String</Placeholder>
<SortOrder>0</SortOrder>
<Validation xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</Validation>
</FormField>
</d2p1:FormMeta>
<d2p1:Id>0</d2p1:Id>
<d2p1:OfferOrder>0</d2p1:OfferOrder>
<d2p1:PublicAccessGuid>00000000-0000-0000-0000-000000000000</d2p1:PublicAccessGuid>
<d2p1:SentToEmailAddress>String</d2p1:SentToEmailAddress>
<d2p1:StandOut>false</d2p1:StandOut>
</campaignAction>
</InboxActionResponse>