AIM Web Services

<back to all web services

InventoryImageRequest

InventoryImage
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET/api/InventoryImage
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 ImageInfo implements IConvertible
{
    // @DataMember
    String? Url;

    // @DataMember
    String? ImageStream;

    // @DataMember
    String? ImageSize;

    // @DataMember
    String? ErrorMessage;

    // @DataMember
    int? UriPk;

    ImageInfo({this.Url,this.ImageStream,this.ImageSize,this.ErrorMessage,this.UriPk});
    ImageInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'Url': Url,
        'ImageStream': ImageStream,
        'ImageSize': ImageSize,
        'ErrorMessage': ErrorMessage,
        'UriPk': UriPk
    };

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

// @DataContract
class InventoryImageResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<ImageInfo>? Images;

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

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

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

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

// @DataContract
class NewImageInfo implements IConvertible
{
    // @DataMember
    String? FileName;

    // @DataMember
    String? Description;

    // @DataMember
    String? Base64Image;

    NewImageInfo({this.FileName,this.Description,this.Base64Image});
    NewImageInfo.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

/**
* InventoryImageRequires active-e Inventory Service
*/
// @DataContract
class InventoryImageRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    String? Item;

    // @DataMember
    int? ItemPk;

    /**
    * Model, SKU, or Serial. Defaults to Model.
    */
    // @DataMember
    // @ApiMember(DataType="string", Description="Model, SKU, or Serial. Defaults to Model.", Name="ItemType", ParameterType="query")
    String? ItemType;

    /**
    * Images (in Base64) to add to the Item. Only for POST.
    */
    // @DataMember
    // @ApiMember(Description="Images (in Base64) to add to the Item. Only for POST.", Name="NewImages", ParameterType="query")
    List<NewImageInfo>? NewImages;

    /**
    * URI Image PKs to remove from the Item. Only for POST.
    */
    // @DataMember
    // @ApiMember(Description="URI Image PKs to remove from the Item. Only for POST.", Name="UriImagePksToDelete", ParameterType="query")
    List<int>? UriImagePksToDelete;

    InventoryImageRequest({this.Item,this.ItemPk,this.ItemType,this.NewImages,this.UriImagePksToDelete});
    InventoryImageRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        super.fromMap(json);
        Item = json['Item'];
        ItemPk = json['ItemPk'];
        ItemType = json['ItemType'];
        NewImages = JsonConverters.fromJson(json['NewImages'],'List<NewImageInfo>',context!);
        UriImagePksToDelete = JsonConverters.fromJson(json['UriImagePksToDelete'],'List<int>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => super.toJson()..addAll({
        'Item': Item,
        'ItemPk': ItemPk,
        'ItemType': ItemType,
        'NewImages': JsonConverters.toJson(NewImages,'List<NewImageInfo>',context!),
        'UriImagePksToDelete': JsonConverters.toJson(UriImagePksToDelete,'List<int>',context!)
    });

    getTypeName() => "InventoryImageRequest";
    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()),
    'ImageInfo': TypeInfo(TypeOf.Class, create:() => ImageInfo()),
    'InventoryImageResponse': TypeInfo(TypeOf.Class, create:() => InventoryImageResponse()),
    'List<ImageInfo>': TypeInfo(TypeOf.Class, create:() => <ImageInfo>[]),
    'NewImageInfo': TypeInfo(TypeOf.Class, create:() => NewImageInfo()),
    'InventoryImageRequest': TypeInfo(TypeOf.Class, create:() => InventoryImageRequest()),
    'List<NewImageInfo>': TypeInfo(TypeOf.Class, create:() => <NewImageInfo>[]),
});

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

{"Item":"String","ItemPk":0,"ItemType":"String","NewImages":[{"FileName":"String","Description":"String","Base64Image":"String"}],"UriImagePksToDelete":[0],"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Images":[{"Url":"String","ImageStream":"String","ImageSize":"String","ErrorMessage":"String","UriPk":0}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}