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 java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * WebCategoriesRequires active-e Inventory Service
    */
    @DataContract
    public static class WebCategoriesRequest extends BaseSecureRequest
    {
        @DataMember
        public Boolean IncludePossibleAttributes = null;

        @DataMember
        public Boolean IncludeImage = null;
        
        public Boolean isIncludePossibleAttributes() { return IncludePossibleAttributes; }
        public WebCategoriesRequest setIncludePossibleAttributes(Boolean value) { this.IncludePossibleAttributes = value; return this; }
        public Boolean isIncludeImage() { return IncludeImage; }
        public WebCategoriesRequest setIncludeImage(Boolean value) { this.IncludeImage = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static class BaseRequest
    {
        /**
        * 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")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class WebCategoriesResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<WebCategory> WebCategories = null;
        
        public ArrayList<WebCategory> getWebCategories() { return WebCategories; }
        public WebCategoriesResponse setWebCategories(ArrayList<WebCategory> value) { this.WebCategories = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class WebCategory
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public Long ParentId = null;

        @DataMember
        public String Name = null;

        @DataMember
        public String Description = null;

        @DataMember
        public String FullPath = null;

        @DataMember
        public String ShortDescription = null;

        @DataMember
        public String SETitle = null;

        @DataMember
        public String SEKeywords = null;

        @DataMember
        public String SEDescription = null;

        @DataMember
        public String SEAltText = null;

        @DataMember
        public ArrayList<String> PossibleAttributes = null;

        @DataMember
        public ImageInfo Image = null;

        @DataMember
        public Boolean Unpublished = null;
        
        public Long getId() { return Id; }
        public WebCategory setId(Long value) { this.Id = value; return this; }
        public Long getParentId() { return ParentId; }
        public WebCategory setParentId(Long value) { this.ParentId = value; return this; }
        public String getName() { return Name; }
        public WebCategory setName(String value) { this.Name = value; return this; }
        public String getDescription() { return Description; }
        public WebCategory setDescription(String value) { this.Description = value; return this; }
        public String getFullPath() { return FullPath; }
        public WebCategory setFullPath(String value) { this.FullPath = value; return this; }
        public String getShortDescription() { return ShortDescription; }
        public WebCategory setShortDescription(String value) { this.ShortDescription = value; return this; }
        public String getSeTitle() { return SETitle; }
        public WebCategory setSeTitle(String value) { this.SETitle = value; return this; }
        public String getSeKeywords() { return SEKeywords; }
        public WebCategory setSeKeywords(String value) { this.SEKeywords = value; return this; }
        public String getSeDescription() { return SEDescription; }
        public WebCategory setSeDescription(String value) { this.SEDescription = value; return this; }
        public String getSeAltText() { return SEAltText; }
        public WebCategory setSeAltText(String value) { this.SEAltText = value; return this; }
        public ArrayList<String> getPossibleAttributes() { return PossibleAttributes; }
        public WebCategory setPossibleAttributes(ArrayList<String> value) { this.PossibleAttributes = value; return this; }
        public ImageInfo getImage() { return Image; }
        public WebCategory setImage(ImageInfo value) { this.Image = value; return this; }
        public Boolean isUnpublished() { return Unpublished; }
        public WebCategory setUnpublished(Boolean value) { this.Unpublished = value; return this; }
    }

    @DataContract
    public static class ImageInfo
    {
        @DataMember
        public String Url = null;

        @DataMember
        public String ImageStream = null;

        @DataMember
        public String ImageSize = null;

        @DataMember
        public String ErrorMessage = null;

        @DataMember
        public Long UriPk = null;
        
        public String getUrl() { return Url; }
        public ImageInfo setUrl(String value) { this.Url = value; return this; }
        public String getImageStream() { return ImageStream; }
        public ImageInfo setImageStream(String value) { this.ImageStream = value; return this; }
        public String getImageSize() { return ImageSize; }
        public ImageInfo setImageSize(String value) { this.ImageSize = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public ImageInfo setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public Long getUriPk() { return UriPk; }
        public ImageInfo setUriPk(Long value) { this.UriPk = value; return this; }
    }

}

Java 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>