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
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SubCategoryAttributeInfo() = 
        [<DataMember>]
        member val AttributeName:String = null with get,set

        [<DataMember>]
        member val Priority:Int32 = new Int32() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type SubCategoryInfo() = 
        [<DataMember>]
        member val SubNumber:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Active:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val Price:Decimal = new Decimal() with get,set

        [<DataMember>]
        member val SkuAttributes:ResizeArray<SubCategoryAttributeInfo> = new ResizeArray<SubCategoryAttributeInfo>() with get,set

        [<DataMember>]
        member val SerialAttributes:ResizeArray<SubCategoryAttributeInfo> = new ResizeArray<SubCategoryAttributeInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CategoryInfo() = 
        [<DataMember>]
        member val CategoryNumber:Int32 = new Int32() with get,set

        [<DataMember>]
        member val CategoryType:String = null with get,set

        [<DataMember>]
        member val Description:String = null with get,set

        [<DataMember>]
        member val Active:Boolean = new Boolean() with get,set

        [<DataMember>]
        member val SubCategoryListing:ResizeArray<SubCategoryInfo> = new ResizeArray<SubCategoryInfo>() with get,set

        [<DataMember>]
        member val PaymentCategoryType:String = null with get,set

        [<DataMember>]
        member val AllowedOnMobile:Nullable<Boolean> = new Nullable<Boolean>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type CategoryListingResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val CategoryListing:ResizeArray<CategoryInfo> = new ResizeArray<CategoryInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with get,set

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")>]
        member val DeviceId:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")>]
        member val AppId:String = null with get,set

    ///<summary>
    ///CategoryListingRequires active-e Inventory Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type CategoryListingRequest() = 
        inherit 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")>]
        member val IncludeInactive:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<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")>]
        member val CategoryNumber:Nullable<Int32> = new Nullable<Int32>() with get,set

        ///<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")>]
        member val IncludeInventory:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<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")>]
        member val IncludeNonInventory:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<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")>]
        member val IncludeReturn:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        ///<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")>]
        member val IncludePayment:Nullable<Boolean> = new Nullable<Boolean>() with get,set

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