AIM Web Services

<back to all web services

ContractFulfillmentRequest

ContractFulfillment
Requires active-e Contracts Service.
This API call used to be named C2BSetContractSerial.

The following routes are available for this service:
POST/api/ContractFulfillment
POST/api/C2BSetContractSerial
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 UpdateContractErrorObj implements IConvertible
{
    // @DataMember
    String? Ref;

    // @DataMember
    String? ErrorMessage;

    UpdateContractErrorObj({this.Ref,this.ErrorMessage});
    UpdateContractErrorObj.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Ref': Ref,
        'ErrorMessage': ErrorMessage
    };

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

// @DataContract
class ContractFulfillmentResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<UpdateContractErrorObj>? MassUpdateErrors;

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

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

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

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

// @DataContract
class DeliveredAccessory implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    bool? Delivered;

    DeliveredAccessory({this.Id,this.Delivered});
    DeliveredAccessory.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Delivered': Delivered
    };

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

// @DataContract(Name="Accessory")
class Accessory implements IConvertible
{
    // @DataMember
    String? Desc;

    // @DataMember
    double? Price;

    // @DataMember
    String? Type;

    // @DataMember
    int? CatNum;

    // @DataMember
    String? Sku;

    // @DataMember
    bool? Report;

    Accessory({this.Desc,this.Price,this.Type,this.CatNum,this.Sku,this.Report});
    Accessory.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Desc = json['Desc'];
        Price = JsonConverters.toDouble(json['Price']);
        Type = json['Type'];
        CatNum = json['CatNum'];
        Sku = json['Sku'];
        Report = json['Report'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Desc': Desc,
        'Price': Price,
        'Type': Type,
        'CatNum': CatNum,
        'Sku': Sku,
        'Report': Report
    };

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

// @DataContract
class UpdateContractObj implements IConvertible
{
    // @DataMember
    String? Ref;

    // @DataMember
    String? Serial;

    // @DataMember
    int? SerialPk;

    // @DataMember
    double? CashPrice;

    // @DataMember
    String? NewStatus;

    // @DataMember
    String? Notes;

    // @DataMember
    DateTime? DeliveryDate;

    // @DataMember
    List<DeliveredAccessory>? DeliveredAccessories;

    // @DataMember
    List<int>? DeletedAccessoryIds;

    // @DataMember
    List<Accessory>? AddedAccessories;

    // @DataMember
    DateTime? FirstDue;

    // @DataMember
    int? NewCustomerAcct;

    // @DataMember
    bool? Unlock;

    UpdateContractObj({this.Ref,this.Serial,this.SerialPk,this.CashPrice,this.NewStatus,this.Notes,this.DeliveryDate,this.DeliveredAccessories,this.DeletedAccessoryIds,this.AddedAccessories,this.FirstDue,this.NewCustomerAcct,this.Unlock});
    UpdateContractObj.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Ref = json['Ref'];
        Serial = json['Serial'];
        SerialPk = json['SerialPk'];
        CashPrice = JsonConverters.toDouble(json['CashPrice']);
        NewStatus = json['NewStatus'];
        Notes = json['Notes'];
        DeliveryDate = JsonConverters.fromJson(json['DeliveryDate'],'DateTime',context!);
        DeliveredAccessories = JsonConverters.fromJson(json['DeliveredAccessories'],'List<DeliveredAccessory>',context!);
        DeletedAccessoryIds = JsonConverters.fromJson(json['DeletedAccessoryIds'],'List<int>',context!);
        AddedAccessories = JsonConverters.fromJson(json['AddedAccessories'],'List<Accessory>',context!);
        FirstDue = JsonConverters.fromJson(json['FirstDue'],'DateTime',context!);
        NewCustomerAcct = json['NewCustomerAcct'];
        Unlock = json['Unlock'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Ref': Ref,
        'Serial': Serial,
        'SerialPk': SerialPk,
        'CashPrice': CashPrice,
        'NewStatus': NewStatus,
        'Notes': Notes,
        'DeliveryDate': JsonConverters.toJson(DeliveryDate,'DateTime',context!),
        'DeliveredAccessories': JsonConverters.toJson(DeliveredAccessories,'List<DeliveredAccessory>',context!),
        'DeletedAccessoryIds': JsonConverters.toJson(DeletedAccessoryIds,'List<int>',context!),
        'AddedAccessories': JsonConverters.toJson(AddedAccessories,'List<Accessory>',context!),
        'FirstDue': JsonConverters.toJson(FirstDue,'DateTime',context!),
        'NewCustomerAcct': NewCustomerAcct,
        'Unlock': Unlock
    };

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

/**
* ContractFulfillmentRequires active-e Contracts Service.This API call used to be named C2BSetContractSerial.
*/
// @DataContract
class ContractFulfillmentRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    String? Ref;

    // @DataMember
    String? Serial;

    // @DataMember
    int? SerialPk;

    // @DataMember
    double? CashPrice;

    // @DataMember
    String? NewStatus;

    // @DataMember
    String? Notes;

    // @DataMember
    DateTime? DeliveryDate;

    // @DataMember
    List<DeliveredAccessory>? DeliveredAccessories;

    // @DataMember
    List<int>? DeletedAccessoryIds;

    // @DataMember
    List<Accessory>? AddedAccessories;

    // @DataMember
    DateTime? FirstDue;

    // @DataMember
    int? CustomerAcct;

    // @DataMember
    bool? Unlock;

    // @DataMember
    List<UpdateContractObj>? MassUpdateItems;

    ContractFulfillmentRequest({this.Ref,this.Serial,this.SerialPk,this.CashPrice,this.NewStatus,this.Notes,this.DeliveryDate,this.DeliveredAccessories,this.DeletedAccessoryIds,this.AddedAccessories,this.FirstDue,this.CustomerAcct,this.Unlock,this.MassUpdateItems});
    ContractFulfillmentRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Ref = json['Ref'];
        Serial = json['Serial'];
        SerialPk = json['SerialPk'];
        CashPrice = JsonConverters.toDouble(json['CashPrice']);
        NewStatus = json['NewStatus'];
        Notes = json['Notes'];
        DeliveryDate = JsonConverters.fromJson(json['DeliveryDate'],'DateTime',context!);
        DeliveredAccessories = JsonConverters.fromJson(json['DeliveredAccessories'],'List<DeliveredAccessory>',context!);
        DeletedAccessoryIds = JsonConverters.fromJson(json['DeletedAccessoryIds'],'List<int>',context!);
        AddedAccessories = JsonConverters.fromJson(json['AddedAccessories'],'List<Accessory>',context!);
        FirstDue = JsonConverters.fromJson(json['FirstDue'],'DateTime',context!);
        CustomerAcct = json['CustomerAcct'];
        Unlock = json['Unlock'];
        MassUpdateItems = JsonConverters.fromJson(json['MassUpdateItems'],'List<UpdateContractObj>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Ref': Ref,
        'Serial': Serial,
        'SerialPk': SerialPk,
        'CashPrice': CashPrice,
        'NewStatus': NewStatus,
        'Notes': Notes,
        'DeliveryDate': JsonConverters.toJson(DeliveryDate,'DateTime',context!),
        'DeliveredAccessories': JsonConverters.toJson(DeliveredAccessories,'List<DeliveredAccessory>',context!),
        'DeletedAccessoryIds': JsonConverters.toJson(DeletedAccessoryIds,'List<int>',context!),
        'AddedAccessories': JsonConverters.toJson(AddedAccessories,'List<Accessory>',context!),
        'FirstDue': JsonConverters.toJson(FirstDue,'DateTime',context!),
        'CustomerAcct': CustomerAcct,
        'Unlock': Unlock,
        'MassUpdateItems': JsonConverters.toJson(MassUpdateItems,'List<UpdateContractObj>',context!)
    });

    getTypeName() => "ContractFulfillmentRequest";
    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()),
    'UpdateContractErrorObj': TypeInfo(TypeOf.Class, create:() => UpdateContractErrorObj()),
    'ContractFulfillmentResponse': TypeInfo(TypeOf.Class, create:() => ContractFulfillmentResponse()),
    'List<UpdateContractErrorObj>': TypeInfo(TypeOf.Class, create:() => <UpdateContractErrorObj>[]),
    'DeliveredAccessory': TypeInfo(TypeOf.Class, create:() => DeliveredAccessory()),
    'Accessory': TypeInfo(TypeOf.Class, create:() => Accessory()),
    'UpdateContractObj': TypeInfo(TypeOf.Class, create:() => UpdateContractObj()),
    'List<DeliveredAccessory>': TypeInfo(TypeOf.Class, create:() => <DeliveredAccessory>[]),
    'List<Accessory>': TypeInfo(TypeOf.Class, create:() => <Accessory>[]),
    'ContractFulfillmentRequest': TypeInfo(TypeOf.Class, create:() => ContractFulfillmentRequest()),
    'List<UpdateContractObj>': TypeInfo(TypeOf.Class, create:() => <UpdateContractObj>[]),
});

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

<ContractFulfillmentRequest 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>
  <AddedAccessories>
    <Accessory>
      <CatNum>0</CatNum>
      <Desc>String</Desc>
      <Price>0</Price>
      <Report>false</Report>
      <Sku>String</Sku>
      <Type>String</Type>
    </Accessory>
  </AddedAccessories>
  <CashPrice>0</CashPrice>
  <CustomerAcct>0</CustomerAcct>
  <DeletedAccessoryIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:long>0</d2p1:long>
  </DeletedAccessoryIds>
  <DeliveredAccessories>
    <ContractFulfillmentRequest.DeliveredAccessory>
      <Delivered>false</Delivered>
      <Id>0</Id>
    </ContractFulfillmentRequest.DeliveredAccessory>
  </DeliveredAccessories>
  <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
  <FirstDue>0001-01-01T00:00:00</FirstDue>
  <MassUpdateItems>
    <ContractFulfillmentRequest.UpdateContractObj>
      <AddedAccessories>
        <Accessory>
          <CatNum>0</CatNum>
          <Desc>String</Desc>
          <Price>0</Price>
          <Report>false</Report>
          <Sku>String</Sku>
          <Type>String</Type>
        </Accessory>
      </AddedAccessories>
      <CashPrice>0</CashPrice>
      <DeletedAccessoryIds xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:long>0</d4p1:long>
      </DeletedAccessoryIds>
      <DeliveredAccessories>
        <ContractFulfillmentRequest.DeliveredAccessory>
          <Delivered>false</Delivered>
          <Id>0</Id>
        </ContractFulfillmentRequest.DeliveredAccessory>
      </DeliveredAccessories>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <FirstDue>0001-01-01T00:00:00</FirstDue>
      <NewCustomerAcct>0</NewCustomerAcct>
      <NewStatus>String</NewStatus>
      <Notes>String</Notes>
      <Ref>String</Ref>
      <Serial>String</Serial>
      <SerialPk>0</SerialPk>
      <Unlock>false</Unlock>
    </ContractFulfillmentRequest.UpdateContractObj>
  </MassUpdateItems>
  <NewStatus>String</NewStatus>
  <Notes>String</Notes>
  <Ref>String</Ref>
  <Serial>String</Serial>
  <SerialPk>0</SerialPk>
  <Unlock>false</Unlock>
</ContractFulfillmentRequest>

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

<ContractFulfillmentResponse 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>
  <MassUpdateErrors>
    <UpdateContractErrorObj>
      <ErrorMessage>String</ErrorMessage>
      <Ref>String</Ref>
    </UpdateContractErrorObj>
  </MassUpdateErrors>
</ContractFulfillmentResponse>