AIM Web Services

<back to all web services

ScheduledExchangesPostRequest

ScheduledExchanges
Requires active-e Contracts Service.

The following routes are available for this service:
POST/api/ScheduledExchanges
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 ScheduledExchangesPostResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    int? ExchangeID;

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

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

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

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

// @DataContract(Name="FormInput")
class FormInput implements IConvertible
{
    /**
    * Field Name of the Input Field
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Field Name of the Input Field", IsRequired=true, Name="Key", ParameterType="query")
    String? Key;

    /**
    * Value of the Input Field.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Value of the Input Field.", IsRequired=true, Name="Value", ParameterType="query")
    String? Value;

    /**
    * Whether or not the field is encryped with the C2B encryption key.
    */
    // @DataMember
    // @ApiMember(DataType="boolean", Description="Whether or not the field is encryped with the C2B encryption key.", IsRequired=true, Name="Encrypted", ParameterType="query")
    bool? Encrypted;

    FormInput({this.Key,this.Value,this.Encrypted});
    FormInput.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Key = json['Key'];
        Value = json['Value'];
        Encrypted = json['Encrypted'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Key': Key,
        'Value': Value,
        'Encrypted': Encrypted
    };

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

/**
* ScheduledExchangesRequires active-e Contracts Service.
*/
// @DataContract
class ScheduledExchangesPostRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    int? Acct;

    // @DataMember
    int? Sub;

    // @DataMember
    int? ExchangedItemID;

    // @DataMember
    DateTime? PostingDate;

    // @DataMember
    DateTime? ScheduledDate;

    // @DataMember
    String? NewSku;

    // @DataMember
    int? OptionId;

    // @DataMember
    String? ExchangeNotes;

    // @DataMember
    bool? Processed;

    // @DataMember
    int? StatusId;

    /**
    * Key/Value pair only. The 'Encrypted' proprety is not used for this API call.
    */
    // @DataMember
    // @ApiMember(DataType="array", Description="Key/Value pair only. The 'Encrypted' proprety is not used for this API call.", Name="FormInputList", ParameterType="query")
    List<FormInput>? FormInputList;

    ScheduledExchangesPostRequest({this.Acct,this.Sub,this.ExchangedItemID,this.PostingDate,this.ScheduledDate,this.NewSku,this.OptionId,this.ExchangeNotes,this.Processed,this.StatusId,this.FormInputList});
    ScheduledExchangesPostRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Acct = json['Acct'];
        Sub = json['Sub'];
        ExchangedItemID = json['ExchangedItemID'];
        PostingDate = JsonConverters.fromJson(json['PostingDate'],'DateTime',context!);
        ScheduledDate = JsonConverters.fromJson(json['ScheduledDate'],'DateTime',context!);
        NewSku = json['NewSku'];
        OptionId = json['OptionId'];
        ExchangeNotes = json['ExchangeNotes'];
        Processed = json['Processed'];
        StatusId = json['StatusId'];
        FormInputList = JsonConverters.fromJson(json['FormInputList'],'List<FormInput>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Acct': Acct,
        'Sub': Sub,
        'ExchangedItemID': ExchangedItemID,
        'PostingDate': JsonConverters.toJson(PostingDate,'DateTime',context!),
        'ScheduledDate': JsonConverters.toJson(ScheduledDate,'DateTime',context!),
        'NewSku': NewSku,
        'OptionId': OptionId,
        'ExchangeNotes': ExchangeNotes,
        'Processed': Processed,
        'StatusId': StatusId,
        'FormInputList': JsonConverters.toJson(FormInputList,'List<FormInput>',context!)
    });

    getTypeName() => "ScheduledExchangesPostRequest";
    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()),
    'ScheduledExchangesPostResponse': TypeInfo(TypeOf.Class, create:() => ScheduledExchangesPostResponse()),
    'FormInput': TypeInfo(TypeOf.Class, create:() => FormInput()),
    'ScheduledExchangesPostRequest': TypeInfo(TypeOf.Class, create:() => ScheduledExchangesPostRequest()),
    'List<FormInput>': TypeInfo(TypeOf.Class, create:() => <FormInput>[]),
});

Dart ScheduledExchangesPostRequest 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 /api/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ScheduledExchangesPostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <Acct>0</Acct>
  <ExchangeNotes>String</ExchangeNotes>
  <ExchangedItemID>0</ExchangedItemID>
  <FormInputList>
    <FormInput>
      <Encrypted>false</Encrypted>
      <Key>String</Key>
      <Value>String</Value>
    </FormInput>
  </FormInputList>
  <NewSku>String</NewSku>
  <OptionId>0</OptionId>
  <PostingDate>0001-01-01T00:00:00</PostingDate>
  <Processed>false</Processed>
  <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
  <StatusId>0</StatusId>
  <Sub>0</Sub>
</ScheduledExchangesPostRequest>

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

<ScheduledExchangesPostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <Status>
    <DomainName>String</DomainName>
    <ErrorCode>String</ErrorCode>
    <ErrorDisplayText>String</ErrorDisplayText>
    <ErrorMessage>String</ErrorMessage>
    <IpAddress>String</IpAddress>
    <Login>String</Login>
    <StatusCode>String</StatusCode>
  </Status>
  <ExchangeID>0</ExchangeID>
</ScheduledExchangesPostResponse>