AIM Web Services

<back to all web services

TransferInventoryOutRequest

TransferInventoryOut
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/TransferInventoryOut
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;
using AIM;

namespace AIM
{
    [DataContract]
    public partial class ExceptionInfo
    {
        [DataMember]
        public virtual string Barcode { get; set; }

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

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

        [DataMember]
        public virtual int Category { get; set; }

        [DataMember]
        public virtual int? SubCategory { get; set; }
    }

    [DataContract]
    public partial class ScanErrorItem
        : IScanItem
    {
        [DataMember]
        public virtual long? SkuPk { get; set; }

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

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

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

        [DataMember]
        public virtual decimal Quantity { get; set; }

        [DataMember]
        public virtual ExceptionInfo ExceptionInfo { get; set; }

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

}

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>
    ///TransferInventoryOutRequires active-e Inventory Service
    ///</summary>
    [DataContract]
    public partial class TransferInventoryOutRequest
        : BaseSecureRequest
    {
        public TransferInventoryOutRequest()
        {
            Items = new List<ScanTransferOutItem>{};
        }

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

        [DataMember]
        public virtual int ReasonCategory { get; set; }

        [DataMember]
        public virtual int? VendorNumber { get; set; }

        [DataMember]
        public virtual int? CustomerAcct { get; set; }

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

        [DataMember]
        public virtual List<ScanTransferOutItem> Items { get; set; }
        [DataContract]
        public partial class ScanTransferOutItem
            : IScanItem
        {
            [DataMember]
            public virtual long? SkuPk { get; set; }

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

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

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

            [DataMember]
            public virtual decimal Quantity { get; set; }

            [DataMember]
            public virtual ExceptionInfo ExceptionInfo { get; set; }

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

    }

    [DataContract]
    public partial class TransferInventoryOutResponse
        : BaseResponse
    {
        public TransferInventoryOutResponse()
        {
            ErrorItems = new List<ScanErrorItem>{};
        }

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

        [DataMember]
        public virtual List<ScanErrorItem> ErrorItems { get; set; }
    }

}

C# TransferInventoryOutRequest 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.

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

<TransferInventoryOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <OAuthToken>String</OAuthToken>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <Token>String</Token>
  <CustomerAcct>0</CustomerAcct>
  <Items>
    <TransferInventoryOutRequest.ScanTransferOutItem>
      <ExceptionInfo xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Barcode>String</d4p1:Barcode>
        <d4p1:Base64Image>String</d4p1:Base64Image>
        <d4p1:Category>0</d4p1:Category>
        <d4p1:Description>String</d4p1:Description>
        <d4p1:SubCategory>0</d4p1:SubCategory>
      </ExceptionInfo>
      <Pending>false</Pending>
      <Quantity>0</Quantity>
      <SasPk>0</SasPk>
      <Serial>String</Serial>
      <Sku>String</Sku>
      <SkuPk>0</SkuPk>
    </TransferInventoryOutRequest.ScanTransferOutItem>
  </Items>
  <LocationPk>0</LocationPk>
  <RMA>String</RMA>
  <ReasonCategory>0</ReasonCategory>
  <VendorNumber>0</VendorNumber>
</TransferInventoryOutRequest>

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

<TransferInventoryOutResponse 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>
  <ErrorItems xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM">
    <d2p1:ScanErrorItem>
      <d2p1:ErrorMessage>String</d2p1:ErrorMessage>
      <d2p1:ExceptionInfo>
        <d2p1:Barcode>String</d2p1:Barcode>
        <d2p1:Base64Image>String</d2p1:Base64Image>
        <d2p1:Category>0</d2p1:Category>
        <d2p1:Description>String</d2p1:Description>
        <d2p1:SubCategory>0</d2p1:SubCategory>
      </d2p1:ExceptionInfo>
      <d2p1:Quantity>0</d2p1:Quantity>
      <d2p1:SasPk>0</d2p1:SasPk>
      <d2p1:Serial>String</d2p1:Serial>
      <d2p1:Sku>String</d2p1:Sku>
      <d2p1:SkuPk>0</d2p1:SkuPk>
    </d2p1:ScanErrorItem>
  </ErrorItems>
  <RefNumber>String</RefNumber>
</TransferInventoryOutResponse>