AIM Web Services

EditContactRecordRequest

EditContactRecord web service.

The following routes are available for this service:
POST	/api/EditContactRecord

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 EditContactRecordResponse extends BaseResponse implements IConvertible
{
    EditContactRecordResponse();
    EditContactRecordResponse.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() => "EditContactRecordResponse";
    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 FileAttachment implements IConvertible
{
    // @DataMember
    String? FileName;

    // @DataMember
    String? Base64Contents;

    FileAttachment({this.FileName,this.Base64Contents});
    FileAttachment.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'FileName': FileName,
        'Base64Contents': Base64Contents
    };

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

/**
* EditContactRecord web service.
*/
// @DataContract
class EditContactRecordRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    String? RefNumber;

    // @DataMember
    String? Contact;

    // @DataMember
    int? CustomerAcct;

    // @DataMember
    int? ActionId;

    // @DataMember
    DateTime? ActionDate;

    // @DataMember
    bool? PopUp;

    // @DataMember
    int? TopicId;

    // @DataMember
    bool? Closed;

    // @DataMember
    DateTime? ClosedDate;

    // @DataMember
    int? ColorValue;

    // @DataMember
    String? LanID;

    // @DataMember
    bool? FormattedNotes;

    // @DataMember
    bool? AppendNotes;

    // @DataMember
    String? Note1;

    // @DataMember
    String? Note2;

    // @DataMember
    String? Note3;

    // @DataMember
    List<AttributeValuePair>? Attributes;

    // @DataMember
    List<FileAttachment>? NewAttachments;

    EditContactRecordRequest({this.RefNumber,this.Contact,this.CustomerAcct,this.ActionId,this.ActionDate,this.PopUp,this.TopicId,this.Closed,this.ClosedDate,this.ColorValue,this.LanID,this.FormattedNotes,this.AppendNotes,this.Note1,this.Note2,this.Note3,this.Attributes,this.NewAttachments});
    EditContactRecordRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        RefNumber = json['RefNumber'];
        Contact = json['Contact'];
        CustomerAcct = json['CustomerAcct'];
        ActionId = json['ActionId'];
        ActionDate = JsonConverters.fromJson(json['ActionDate'],'DateTime',context!);
        PopUp = json['PopUp'];
        TopicId = json['TopicId'];
        Closed = json['Closed'];
        ClosedDate = JsonConverters.fromJson(json['ClosedDate'],'DateTime',context!);
        ColorValue = json['ColorValue'];
        LanID = json['LanID'];
        FormattedNotes = json['FormattedNotes'];
        AppendNotes = json['AppendNotes'];
        Note1 = json['Note1'];
        Note2 = json['Note2'];
        Note3 = json['Note3'];
        Attributes = JsonConverters.fromJson(json['Attributes'],'List<AttributeValuePair>',context!);
        NewAttachments = JsonConverters.fromJson(json['NewAttachments'],'List<FileAttachment>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'RefNumber': RefNumber,
        'Contact': Contact,
        'CustomerAcct': CustomerAcct,
        'ActionId': ActionId,
        'ActionDate': JsonConverters.toJson(ActionDate,'DateTime',context!),
        'PopUp': PopUp,
        'TopicId': TopicId,
        'Closed': Closed,
        'ClosedDate': JsonConverters.toJson(ClosedDate,'DateTime',context!),
        'ColorValue': ColorValue,
        'LanID': LanID,
        'FormattedNotes': FormattedNotes,
        'AppendNotes': AppendNotes,
        'Note1': Note1,
        'Note2': Note2,
        'Note3': Note3,
        'Attributes': JsonConverters.toJson(Attributes,'List<AttributeValuePair>',context!),
        'NewAttachments': JsonConverters.toJson(NewAttachments,'List<FileAttachment>',context!)
    });

    getTypeName() => "EditContactRecordRequest";
    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()),
    'EditContactRecordResponse': TypeInfo(TypeOf.Class, create:() => EditContactRecordResponse()),
    'AttributeValuePair': TypeInfo(TypeOf.Class, create:() => AttributeValuePair()),
    'FileAttachment': TypeInfo(TypeOf.Class, create:() => FileAttachment()),
    'EditContactRecordRequest': TypeInfo(TypeOf.Class, create:() => EditContactRecordRequest()),
    'List<AttributeValuePair>': TypeInfo(TypeOf.Class, create:() => <AttributeValuePair>[]),
    'List<FileAttachment>': TypeInfo(TypeOf.Class, create:() => <FileAttachment>[]),
});

Dart EditContactRecordRequest 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

HTTP + JSON

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

POST /api/EditContactRecord HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"RefNumber":"String","Contact":"String","CustomerAcct":0,"ActionId":0,"ActionDate":"0001-01-01T00:00:00.0000000","PopUp":false,"TopicId":0,"Closed":false,"ClosedDate":"0001-01-01T00:00:00.0000000","ColorValue":0,"LanID":"String","FormattedNotes":false,"AppendNotes":false,"Note1":"String","Note2":"String","Note3":"String","Attributes":[{"Name":"String","Value":"String"}],"NewAttachments":[{"FileName":"String","Base64Contents":"String"}],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}