AIM Web Services

<back to all web services

EditInventoryRequest

EditInventory
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/EditInventory
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 EditInventoryResponse extends BaseResponse implements IConvertible
{
    EditInventoryResponse();
    EditInventoryResponse.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() => "EditInventoryResponse";
    TypeContext? context = _ctx;
}

/**
* EditInventoryRequires active-e Inventory Service
*/
// @DataContract
class EditInventoryRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    int? SaqPk;

    // @DataMember
    int? SasPk;

    // @DataMember
    String? Description;

    // @DataMember
    double? OurPrice;

    // @DataMember
    double? RetailPrice;

    // @DataMember
    double? PriceA;

    // @DataMember
    double? PriceB;

    // @DataMember
    double? PriceC;

    // @DataMember
    double? MinPrice;

    // @DataMember
    double? ActiveEPrice;

    // @DataMember
    String? Locator;

    // @DataMember
    bool? UpdateAllLocations;

    /**
    * List of Barcodes. If barcodes are sent, they will overwrite existing barcodes.
    */
    // @DataMember
    // @ApiMember(Description="List of Barcodes. If barcodes are sent, they will overwrite existing barcodes.", Name="Barcodes", ParameterType="body")
    List<String>? Barcodes;

    // @DataMember
    double? NewComputerQuantity;

    EditInventoryRequest({this.SaqPk,this.SasPk,this.Description,this.OurPrice,this.RetailPrice,this.PriceA,this.PriceB,this.PriceC,this.MinPrice,this.ActiveEPrice,this.Locator,this.UpdateAllLocations,this.Barcodes,this.NewComputerQuantity});
    EditInventoryRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        SaqPk = json['SaqPk'];
        SasPk = json['SasPk'];
        Description = json['Description'];
        OurPrice = JsonConverters.toDouble(json['OurPrice']);
        RetailPrice = JsonConverters.toDouble(json['RetailPrice']);
        PriceA = JsonConverters.toDouble(json['PriceA']);
        PriceB = JsonConverters.toDouble(json['PriceB']);
        PriceC = JsonConverters.toDouble(json['PriceC']);
        MinPrice = JsonConverters.toDouble(json['MinPrice']);
        ActiveEPrice = JsonConverters.toDouble(json['ActiveEPrice']);
        Locator = json['Locator'];
        UpdateAllLocations = json['UpdateAllLocations'];
        Barcodes = JsonConverters.fromJson(json['Barcodes'],'List<String>',context!);
        NewComputerQuantity = JsonConverters.toDouble(json['NewComputerQuantity']);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'SaqPk': SaqPk,
        'SasPk': SasPk,
        'Description': Description,
        'OurPrice': OurPrice,
        'RetailPrice': RetailPrice,
        'PriceA': PriceA,
        'PriceB': PriceB,
        'PriceC': PriceC,
        'MinPrice': MinPrice,
        'ActiveEPrice': ActiveEPrice,
        'Locator': Locator,
        'UpdateAllLocations': UpdateAllLocations,
        'Barcodes': JsonConverters.toJson(Barcodes,'List<String>',context!),
        'NewComputerQuantity': NewComputerQuantity
    });

    getTypeName() => "EditInventoryRequest";
    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()),
    'EditInventoryResponse': TypeInfo(TypeOf.Class, create:() => EditInventoryResponse()),
    'EditInventoryRequest': TypeInfo(TypeOf.Class, create:() => EditInventoryRequest()),
});

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

<EditInventoryRequest 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>
  <ActiveEPrice>0</ActiveEPrice>
  <Barcodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Barcodes>
  <Description>String</Description>
  <Locator>String</Locator>
  <MinPrice>0</MinPrice>
  <NewComputerQuantity>0</NewComputerQuantity>
  <OurPrice>0</OurPrice>
  <PriceA>0</PriceA>
  <PriceB>0</PriceB>
  <PriceC>0</PriceC>
  <RetailPrice>0</RetailPrice>
  <SaqPk>0</SaqPk>
  <SasPk>0</SasPk>
  <UpdateAllLocations>false</UpdateAllLocations>
</EditInventoryRequest>

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

<EditInventoryResponse 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>
</EditInventoryResponse>