AIM Web Services

<back to all web services

ScanForImportRequest

ScanForImport
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/ScanForImport
namespace AIM

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 ExceptionInfo() = 
        [<DataMember>]
        member val Barcode:String = null with get,set

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type ScanErrorItem() = 
        [<DataMember>]
        member val SkuPk:Nullable<Int64> = new Nullable<Int64>() with get,set

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type ScanForImportResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val ErrorItems:ResizeArray<ScanErrorItem> = new ResizeArray<ScanErrorItem>() 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

    [<DataContract>]
    [<AllowNullLiteral>]
    type ScanItem() = 
        [<DataMember>]
        member val SkuPk:Nullable<Int64> = new Nullable<Int64>() with get,set

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

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

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

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

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

    ///<summary>
    ///ScanForImportRequires active-e Inventory Service
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type ScanForImportRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Description:String = null with get,set

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

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

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

F# ScanForImportRequest DTOs

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

HTTP + OTHER

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

POST /api/ScanForImport HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Description":"String","Items":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0}}],"ReceiveInventoryMode":false,"AppendMode":false,"Token":"String","DeviceId":"String","AppId":"String","ApiKey":"String","OAuthToken":"String"}

HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ErrorItems":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0},"ErrorMessage":"String"}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}