AIM Web Services

<back to all web services

EditInventoryRequest

EditInventory
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/EditInventory
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; }
    }

    ///<summary>
    ///EditInventoryRequires active-e Inventory Service
    ///</summary>
    [DataContract]
    public partial class EditInventoryRequest
        : BaseSecureRequest
    {
        public EditInventoryRequest()
        {
            Barcodes = new List<string>{};
        }

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

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

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

        [DataMember]
        public virtual decimal? OurPrice { get; set; }

        [DataMember]
        public virtual decimal? RetailPrice { get; set; }

        [DataMember]
        public virtual decimal? PriceA { get; set; }

        [DataMember]
        public virtual decimal? PriceB { get; set; }

        [DataMember]
        public virtual decimal? PriceC { get; set; }

        [DataMember]
        public virtual decimal? MinPrice { get; set; }

        [DataMember]
        public virtual decimal? ActiveEPrice { get; set; }

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

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

        ///<summary>
        ///List of Barcodes. If barcodes are sent, they will overwrite existing barcodes.
        ///</summary>
        [DataMember]
        [ApiMember(Description="List of Barcodes. If barcodes are sent, they will overwrite existing barcodes.", Name="Barcodes", ParameterType="body")]
        public virtual List<string> Barcodes { get; set; }

        [DataMember]
        public virtual decimal? NewComputerQuantity { get; set; }
    }

    [DataContract]
    public partial class EditInventoryResponse
        : BaseResponse
    {
    }

}

C# EditInventoryRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/EditInventory HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"SaqPk":0,"SasPk":0,"Description":"String","OurPrice":0,"RetailPrice":0,"PriceA":0,"PriceB":0,"PriceC":0,"MinPrice":0,"ActiveEPrice":0,"Locator":"String","UpdateAllLocations":false,"Barcodes":["String"],"NewComputerQuantity":0,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

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

{"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}