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

Namespace Global

    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 Overridable Property ApiKey As String

            '''<Summary>
            '''The OAuthToken token return by AeServices30
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The OAuthToken token return by AeServices30", IsRequired:=true, Name:="OAuthToken", ParameterType:="Header")>
            Public Overridable Property OAuthToken As String

            '''<Summary>
            '''The Device ID of the Mobile Device. Not used for non-mobile devices.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name:="DeviceId", ParameterType:="Header")>
            Public Overridable Property DeviceId As String

            '''<Summary>
            '''An identifier for your integration
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="An identifier for your integration", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits BaseRequest
            '''<Summary>
            '''The Login Token return by the Security API. Required for secured calls.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="The Login Token return by the Security API. Required for secured calls.", Name:="Token", ParameterType:="Header")>
            Public Overridable Property Token As String
        End Class

        <DataContract>
        Public Partial Class ImageInfo
            <DataMember>
            Public Overridable Property Url As String

            <DataMember>
            Public Overridable Property ImageStream As String

            <DataMember>
            Public Overridable Property ImageSize As String

            <DataMember>
            Public Overridable Property ErrorMessage As String

            <DataMember>
            Public Overridable Property UriPk As Nullable(Of Long)
        End Class

        '''<Summary>
        '''WebCategoriesRequires active-e Inventory Service
        '''</Summary>
        <DataContract>
        Public Partial Class WebCategoriesRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property IncludePossibleAttributes As Boolean

            <DataMember>
            Public Overridable Property IncludeImage As Boolean
        End Class

        <DataContract>
        Public Partial Class WebCategoriesResponse
            Inherits BaseResponse
            Public Sub New()
                WebCategories = New List(Of WebCategory)
            End Sub

            <DataMember>
            Public Overridable Property WebCategories As List(Of WebCategory)
        End Class

        <DataContract>
        Public Partial Class WebCategory
            Public Sub New()
                PossibleAttributes = New List(Of String)
            End Sub

            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property ParentId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property FullPath As String

            <DataMember>
            Public Overridable Property ShortDescription As String

            <DataMember>
            Public Overridable Property SETitle As String

            <DataMember>
            Public Overridable Property SEKeywords As String

            <DataMember>
            Public Overridable Property SEDescription As String

            <DataMember>
            Public Overridable Property SEAltText As String

            <DataMember>
            Public Overridable Property PossibleAttributes As List(Of String)

            <DataMember>
            Public Overridable Property Image As ImageInfo

            <DataMember>
            Public Overridable Property Unpublished As Boolean
        End Class
    End Namespace
End Namespace

VB.NET 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>