AIM Web Services

<back to all web services

WebCategoriesRequest

WebCategories
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/WebCategories
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 WebCategory implements IConvertible
{
    // @DataMember
    int? Id;

    // @DataMember
    int? ParentId;

    // @DataMember
    String? Name;

    // @DataMember
    String? Description;

    // @DataMember
    String? FullPath;

    // @DataMember
    String? ShortDescription;

    // @DataMember
    String? SETitle;

    // @DataMember
    String? SEKeywords;

    // @DataMember
    String? SEDescription;

    // @DataMember
    String? SEAltText;

    // @DataMember
    List<String>? PossibleAttributes;

    // @DataMember
    ImageInfo? Image;

    // @DataMember
    bool? Unpublished;

    WebCategory({this.Id,this.ParentId,this.Name,this.Description,this.FullPath,this.ShortDescription,this.SETitle,this.SEKeywords,this.SEDescription,this.SEAltText,this.PossibleAttributes,this.Image,this.Unpublished});
    WebCategory.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        ParentId = json['ParentId'];
        Name = json['Name'];
        Description = json['Description'];
        FullPath = json['FullPath'];
        ShortDescription = json['ShortDescription'];
        SETitle = json['SETitle'];
        SEKeywords = json['SEKeywords'];
        SEDescription = json['SEDescription'];
        SEAltText = json['SEAltText'];
        PossibleAttributes = JsonConverters.fromJson(json['PossibleAttributes'],'List<String>',context!);
        Image = JsonConverters.fromJson(json['Image'],'ImageInfo',context!);
        Unpublished = json['Unpublished'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'ParentId': ParentId,
        'Name': Name,
        'Description': Description,
        'FullPath': FullPath,
        'ShortDescription': ShortDescription,
        'SETitle': SETitle,
        'SEKeywords': SEKeywords,
        'SEDescription': SEDescription,
        'SEAltText': SEAltText,
        'PossibleAttributes': JsonConverters.toJson(PossibleAttributes,'List<String>',context!),
        'Image': JsonConverters.toJson(Image,'ImageInfo',context!),
        'Unpublished': Unpublished
    };

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

// @DataContract
class WebCategoriesResponse extends BaseResponse implements IConvertible
{
    // @DataMember
    List<WebCategory>? WebCategories;

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

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

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

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

/**
* WebCategoriesRequires active-e Inventory Service
*/
// @DataContract
class WebCategoriesRequest extends BaseSecureRequest implements IConvertible
{
    // @DataMember
    bool? IncludePossibleAttributes;

    // @DataMember
    bool? IncludeImage;

    WebCategoriesRequest({this.IncludePossibleAttributes,this.IncludeImage});
    WebCategoriesRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

Dart WebCategoriesRequest 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/WebCategories HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<WebCategoriesResponse 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>
  <WebCategories>
    <WebCategory>
      <Description>String</Description>
      <FullPath>String</FullPath>
      <Id>0</Id>
      <Image>
        <ErrorMessage>String</ErrorMessage>
        <ImageSize>String</ImageSize>
        <ImageStream>String</ImageStream>
        <UriPk>0</UriPk>
        <Url>String</Url>
      </Image>
      <Name>String</Name>
      <ParentId>0</ParentId>
      <PossibleAttributes xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </PossibleAttributes>
      <SEAltText>String</SEAltText>
      <SEDescription>String</SEDescription>
      <SEKeywords>String</SEKeywords>
      <SETitle>String</SETitle>
      <ShortDescription>String</ShortDescription>
      <Unpublished>false</Unpublished>
    </WebCategory>
  </WebCategories>
</WebCategoriesResponse>