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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")]
        public virtual string ApiKey { get; set; }

        [DataMember]
        [ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")]
        public virtual string OAuthToken { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class ImageInfo
    {
        [DataMember]
        public virtual string Url { get; set; }

        [DataMember]
        public virtual string ImageStream { get; set; }

        [DataMember]
        public virtual string ImageSize { get; set; }

        [DataMember]
        public virtual string ErrorMessage { get; set; }

        [DataMember]
        public virtual long? UriPk { get; set; }
    }

    ///<summary>
    ///WebCategoriesRequires active-e Inventory Service
    ///</summary>
    [DataContract]
    public partial class WebCategoriesRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual bool IncludePossibleAttributes { get; set; }

        [DataMember]
        public virtual bool IncludeImage { get; set; }
    }

    [DataContract]
    public partial class WebCategoriesResponse
        : BaseResponse
    {
        public WebCategoriesResponse()
        {
            WebCategories = new List<WebCategory>{};
        }

        [DataMember]
        public virtual List<WebCategory> WebCategories { get; set; }
    }

    [DataContract]
    public partial class WebCategory
    {
        public WebCategory()
        {
            PossibleAttributes = new List<string>{};
        }

        [DataMember]
        public virtual long Id { get; set; }

        [DataMember]
        public virtual long? ParentId { get; set; }

        [DataMember]
        public virtual string Name { get; set; }

        [DataMember]
        public virtual string Description { get; set; }

        [DataMember]
        public virtual string FullPath { get; set; }

        [DataMember]
        public virtual string ShortDescription { get; set; }

        [DataMember]
        public virtual string SETitle { get; set; }

        [DataMember]
        public virtual string SEKeywords { get; set; }

        [DataMember]
        public virtual string SEDescription { get; set; }

        [DataMember]
        public virtual string SEAltText { get; set; }

        [DataMember]
        public virtual List<string> PossibleAttributes { get; set; }

        [DataMember]
        public virtual ImageInfo Image { get; set; }

        [DataMember]
        public virtual bool Unpublished { get; set; }
    }

}

C# 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>