AIM Web Services

<back to all web services

CategoryListingRequest

CategoryListing
Requires active-e Inventory Service.

The following routes are available for this service:
GET/api/CategoryListing
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 CategoryInfo
            Public Sub New()
                SubCategoryListing = New List(Of SubCategoryInfo)
            End Sub

            <DataMember>
            Public Overridable Property CategoryNumber As Integer

            <DataMember>
            Public Overridable Property CategoryType As String

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Active As Boolean

            <DataMember>
            Public Overridable Property SubCategoryListing As List(Of SubCategoryInfo)

            <DataMember>
            Public Overridable Property PaymentCategoryType As String

            <DataMember>
            Public Overridable Property AllowedOnMobile As Nullable(Of Boolean)
        End Class

        '''<Summary>
        '''CategoryListingRequires active-e Inventory Service.
        '''</Summary>
        <DataContract>
        Public Partial Class CategoryListingRequest
            Inherits BaseSecureRequest
            '''<Summary>
            '''If true, Inactive Categories and Subcategories will be returned. Defaults to false.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="If true, Inactive Categories and Subcategories will be returned. Defaults to false.", Name:="IncludeInactive", ParameterType:="query")>
            Public Overridable Property IncludeInactive As Nullable(Of Boolean)

            '''<Summary>
            '''Category Number lookup. If sent, only this category and it's subs will be returned. Further parameters will be ignored.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="integer", Description:="Category Number lookup. If sent, only this category and it's subs will be returned. Further parameters will be ignored.", Format:="int64", Name:="CategoryNumber", ParameterType:="query")>
            Public Overridable Property CategoryNumber As Nullable(Of Integer)

            '''<Summary>
            '''If true, Inventory Categories will be returned. Defaults to true.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="If true, Inventory Categories will be returned. Defaults to true.", Name:="IncludeInventory", ParameterType:="query")>
            Public Overridable Property IncludeInventory As Nullable(Of Boolean)

            '''<Summary>
            '''If true, Non-Inventory Categories will be returned. Defaults to false.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="If true, Non-Inventory Categories will be returned. Defaults to false.", Name:="IncludeNonInventory", ParameterType:="query")>
            Public Overridable Property IncludeNonInventory As Nullable(Of Boolean)

            '''<Summary>
            '''If true, Return Payment Categories will be returned. Defaults to false.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="If true, Return Payment Categories will be returned. Defaults to false.", Name:="IncludeReturn", ParameterType:="query")>
            Public Overridable Property IncludeReturn As Nullable(Of Boolean)

            '''<Summary>
            '''If true, Payment Categories will be returned. Defaults to false.
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="boolean", Description:="If true, Payment Categories will be returned. Defaults to false.", Name:="IncludePayment", ParameterType:="query")>
            Public Overridable Property IncludePayment As Nullable(Of Boolean)
        End Class

        <DataContract>
        Public Partial Class CategoryListingResponse
            Inherits BaseResponse
            Public Sub New()
                CategoryListing = New List(Of CategoryInfo)
            End Sub

            <DataMember>
            Public Overridable Property CategoryListing As List(Of CategoryInfo)
        End Class

        <DataContract>
        Public Partial Class SubCategoryAttributeInfo
            <DataMember>
            Public Overridable Property AttributeName As String

            <DataMember>
            Public Overridable Property Priority As Integer
        End Class

        <DataContract>
        Public Partial Class SubCategoryInfo
            Public Sub New()
                SkuAttributes = New List(Of SubCategoryAttributeInfo)
                SerialAttributes = New List(Of SubCategoryAttributeInfo)
            End Sub

            <DataMember>
            Public Overridable Property SubNumber As Integer

            <DataMember>
            Public Overridable Property Description As String

            <DataMember>
            Public Overridable Property Active As Boolean

            <DataMember>
            Public Overridable Property Price As Decimal

            <DataMember>
            Public Overridable Property SkuAttributes As List(Of SubCategoryAttributeInfo)

            <DataMember>
            Public Overridable Property SerialAttributes As List(Of SubCategoryAttributeInfo)
        End Class
    End Namespace
End Namespace

VB.NET CategoryListingRequest 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/CategoryListing HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<CategoryListingResponse 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>
  <CategoryListing>
    <CategoryInfo>
      <Active>false</Active>
      <AllowedOnMobile>false</AllowedOnMobile>
      <CategoryNumber>0</CategoryNumber>
      <CategoryType>String</CategoryType>
      <Description>String</Description>
      <PaymentCategoryType>String</PaymentCategoryType>
      <SubCategoryListing>
        <SubCategoryInfo>
          <Active>false</Active>
          <Description>String</Description>
          <Price>0</Price>
          <SerialAttributes>
            <SubCategoryAttributeInfo>
              <AttributeName>String</AttributeName>
              <Priority>0</Priority>
            </SubCategoryAttributeInfo>
          </SerialAttributes>
          <SkuAttributes>
            <SubCategoryAttributeInfo>
              <AttributeName>String</AttributeName>
              <Priority>0</Priority>
            </SubCategoryAttributeInfo>
          </SkuAttributes>
          <SubNumber>0</SubNumber>
        </SubCategoryInfo>
      </SubCategoryListing>
    </CategoryInfo>
  </CategoryListing>
</CategoryListingResponse>