AIM Web Services

<back to all web services

GetImageRequest

GetImage
Requires active-e Customer Service for Customer Images
Requires active-e Inventory Service for Inventory Images.

The following routes are available for this service:
GET/api/GetImage
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 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 GetImageResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<ImageInfo>? Images;

    GetImageResponse({this.Images});
    GetImageResponse.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() => "GetImageResponse";
    TypeContext? context = _ctx;
}

/**
* GetImageRequires active-e Customer Service for Customer ImagesRequires active-e Inventory Service for Inventory Images.
*/
// @DataContract
class GetImageRequest extends BaseRequest implements IConvertible
{
    /**
    * If sent, image(s) for this customer will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, image(s) for this customer will be returned.", Format="int32", Name="CustomerAcct", ParameterType="query")
    int? CustomerAcct;

    /**
    * If sent, image(s) for this inventory item will be returned.
    */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, image(s) for this inventory item will be returned.", Format="int64", Name="InventoryPk", ParameterType="query")
    int? InventoryPk;

    GetImageRequest({this.CustomerAcct,this.InventoryPk});
    GetImageRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

TypeContext _ctx = TypeContext(library: 'active_ewebservice.biz', types: <String, TypeInfo> {
    'BaseRequest': TypeInfo(TypeOf.Class, create:() => BaseRequest()),
    'BaseResponseResult': TypeInfo(TypeOf.Class, create:() => BaseResponseResult()),
    'BaseResponse': TypeInfo(TypeOf.Class, create:() => BaseResponse()),
    'ImageInfo': TypeInfo(TypeOf.Class, create:() => ImageInfo()),
    'GetImageResponse': TypeInfo(TypeOf.Class, create:() => GetImageResponse()),
    'List<ImageInfo>': TypeInfo(TypeOf.Class, create:() => <ImageInfo>[]),
    'GetImageRequest': TypeInfo(TypeOf.Class, create:() => GetImageRequest()),
});

Dart GetImageRequest 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.

GET /api/GetImage HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<GetImageResponse 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>
  <Images>
    <ImageInfo>
      <ErrorMessage>String</ErrorMessage>
      <ImageSize>String</ImageSize>
      <ImageStream>String</ImageStream>
      <UriPk>0</UriPk>
      <Url>String</Url>
    </ImageInfo>
  </Images>
</GetImageResponse>