Trendsic Platform Service

<back to all web services

FFAgentConfigTemplateRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
POST,OPTIONS/v1/FFAgentConfigTemplate
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class FFAgentConfig implements IConvertible
{
    String? Id;
    int? AgentId;
    DateTime? DateCreated;
    DateTime? DateModified;

    FFAgentConfig({this.Id,this.AgentId,this.DateCreated,this.DateModified});
    FFAgentConfig.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        AgentId = json['AgentId'];
        DateCreated = JsonConverters.fromJson(json['DateCreated'],'DateTime',context!);
        DateModified = JsonConverters.fromJson(json['DateModified'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'AgentId': AgentId,
        'DateCreated': JsonConverters.toJson(DateCreated,'DateTime',context!),
        'DateModified': JsonConverters.toJson(DateModified,'DateTime',context!)
    };

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

class FFSection implements IConvertible
{
    String? Id;
    String? FFAgentConfigId;
    int? SectionTypeId;
    String? Nickname;
    bool? ShowHeader;
    String? Header;
    int? height;
    int? width;
    int? x;
    int? y;
    bool? IsActive;
    bool? HasBorder;
    String? BorderColor;
    int? BorderWidth;
    int? BorderRadius;
    DateTime? DateCreated;
    DateTime? DateModified;

    FFSection({this.Id,this.FFAgentConfigId,this.SectionTypeId,this.Nickname,this.ShowHeader,this.Header,this.height,this.width,this.x,this.y,this.IsActive,this.HasBorder,this.BorderColor,this.BorderWidth,this.BorderRadius,this.DateCreated,this.DateModified});
    FFSection.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        FFAgentConfigId = json['FFAgentConfigId'];
        SectionTypeId = json['SectionTypeId'];
        Nickname = json['Nickname'];
        ShowHeader = json['ShowHeader'];
        Header = json['Header'];
        height = json['height'];
        width = json['width'];
        x = json['x'];
        y = json['y'];
        IsActive = json['IsActive'];
        HasBorder = json['HasBorder'];
        BorderColor = json['BorderColor'];
        BorderWidth = json['BorderWidth'];
        BorderRadius = json['BorderRadius'];
        DateCreated = JsonConverters.fromJson(json['DateCreated'],'DateTime',context!);
        DateModified = JsonConverters.fromJson(json['DateModified'],'DateTime',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'FFAgentConfigId': FFAgentConfigId,
        'SectionTypeId': SectionTypeId,
        'Nickname': Nickname,
        'ShowHeader': ShowHeader,
        'Header': Header,
        'height': height,
        'width': width,
        'x': x,
        'y': y,
        'IsActive': IsActive,
        'HasBorder': HasBorder,
        'BorderColor': BorderColor,
        'BorderWidth': BorderWidth,
        'BorderRadius': BorderRadius,
        'DateCreated': JsonConverters.toJson(DateCreated,'DateTime',context!),
        'DateModified': JsonConverters.toJson(DateModified,'DateTime',context!)
    };

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

class FFField implements IConvertible
{
    String? Id;
    String? FFSectionId;
    int? FieldTypeId;
    int? x;
    int? y;
    int? height;
    int? width;
    String? Text;

    FFField({this.Id,this.FFSectionId,this.FieldTypeId,this.x,this.y,this.height,this.width,this.Text});
    FFField.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        FFSectionId = json['FFSectionId'];
        FieldTypeId = json['FieldTypeId'];
        x = json['x'];
        y = json['y'];
        height = json['height'];
        width = json['width'];
        Text = json['Text'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'FFSectionId': FFSectionId,
        'FieldTypeId': FieldTypeId,
        'x': x,
        'y': y,
        'height': height,
        'width': width,
        'Text': Text
    };

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

class FFFieldExtended extends FFField implements IConvertible
{
    String? Name;
    bool? IsYesNo;

    FFFieldExtended({this.Name,this.IsYesNo});
    FFFieldExtended.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Name = json['Name'];
        IsYesNo = json['IsYesNo'];
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Name': Name,
        'IsYesNo': IsYesNo
    });

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

class FFSectionExtended extends FFSection implements IConvertible
{
    String? SectionTypeDesc;
    List<FFFieldExtended>? FFFields = [];

    FFSectionExtended({this.SectionTypeDesc,this.FFFields});
    FFSectionExtended.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'SectionTypeDesc': SectionTypeDesc,
        'FFFields': JsonConverters.toJson(FFFields,'List<FFFieldExtended>',context!)
    });

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

class FFAgentConfigExtended extends FFAgentConfig implements IConvertible
{
    List<FFSectionExtended>? FFSections = [];

    FFAgentConfigExtended({this.FFSections});
    FFAgentConfigExtended.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'FFSections': JsonConverters.toJson(FFSections,'List<FFSectionExtended>',context!)
    });

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

class FFAgentConfigResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    FFAgentConfigExtended? FFAgentConfig;

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

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

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

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

class FFAgentConfigTemplateRequest implements IConvertible
{
    String? FFAgentConfigId;
    String? TemplateId;

    FFAgentConfigTemplateRequest({this.FFAgentConfigId,this.TemplateId});
    FFAgentConfigTemplateRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FFAgentConfigId = json['FFAgentConfigId'];
        TemplateId = json['TemplateId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FFAgentConfigId': FFAgentConfigId,
        'TemplateId': TemplateId
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'FFAgentConfig': TypeInfo(TypeOf.Class, create:() => FFAgentConfig()),
    'FFSection': TypeInfo(TypeOf.Class, create:() => FFSection()),
    'FFField': TypeInfo(TypeOf.Class, create:() => FFField()),
    'FFFieldExtended': TypeInfo(TypeOf.Class, create:() => FFFieldExtended()),
    'FFSectionExtended': TypeInfo(TypeOf.Class, create:() => FFSectionExtended()),
    'List<FFFieldExtended>': TypeInfo(TypeOf.Class, create:() => <FFFieldExtended>[]),
    'FFAgentConfigExtended': TypeInfo(TypeOf.Class, create:() => FFAgentConfigExtended()),
    'List<FFSectionExtended>': TypeInfo(TypeOf.Class, create:() => <FFSectionExtended>[]),
    'FFAgentConfigResponse': TypeInfo(TypeOf.Class, create:() => FFAgentConfigResponse()),
    'FFAgentConfigTemplateRequest': TypeInfo(TypeOf.Class, create:() => FFAgentConfigTemplateRequest()),
});

Dart FFAgentConfigTemplateRequest DTOs

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

HTTP + XML

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

POST /v1/FFAgentConfigTemplate HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FFAgentConfigTemplateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FFAgentConfigId>00000000-0000-0000-0000-000000000000</FFAgentConfigId>
  <TemplateId>00000000-0000-0000-0000-000000000000</TemplateId>
</FFAgentConfigTemplateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<FFAgentConfigResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <FFAgentConfig>
    <AgentId>0</AgentId>
    <DateCreated>0001-01-01T00:00:00</DateCreated>
    <DateModified>0001-01-01T00:00:00</DateModified>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <FFSections>
      <FFSectionExtended>
        <BorderColor>String</BorderColor>
        <BorderRadius>0</BorderRadius>
        <BorderWidth>0</BorderWidth>
        <DateCreated>0001-01-01T00:00:00</DateCreated>
        <DateModified>0001-01-01T00:00:00</DateModified>
        <FFAgentConfigId>00000000-0000-0000-0000-000000000000</FFAgentConfigId>
        <HasBorder>false</HasBorder>
        <Header>String</Header>
        <Id>00000000-0000-0000-0000-000000000000</Id>
        <IsActive>false</IsActive>
        <Nickname>String</Nickname>
        <SectionTypeId>0</SectionTypeId>
        <ShowHeader>false</ShowHeader>
        <height>0</height>
        <width>0</width>
        <x>0</x>
        <y>0</y>
        <FFFields>
          <FFFieldExtended>
            <FFSectionId>00000000-0000-0000-0000-000000000000</FFSectionId>
            <FieldTypeId>0</FieldTypeId>
            <Id>00000000-0000-0000-0000-000000000000</Id>
            <Text>String</Text>
            <height>0</height>
            <width>0</width>
            <x>0</x>
            <y>0</y>
            <IsYesNo>false</IsYesNo>
            <Name>String</Name>
          </FFFieldExtended>
        </FFFields>
        <SectionTypeDesc>String</SectionTypeDesc>
      </FFSectionExtended>
    </FFSections>
  </FFAgentConfig>
  <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>
</FFAgentConfigResponse>