AIM Web Services

<back to all web services

PhysicalSpotCheckRequest

PhysicalSpotCheck
Requires active-e Inventory Service

The following routes are available for this service:
POST/api/PhysicalSpotCheck
import java.math.*
import java.util.*
import net.servicestack.client.*


/**
* PhysicalSpotCheckRequires active-e Inventory Service
*/
@DataContract
open class PhysicalSpotCheckRequest : BaseSecureRequest()
{
    @DataMember
    var LocPk:Long? = null

    @DataMember
    var Location:String? = null

    @DataMember
    var Items:ArrayList<ScanItem> = ArrayList<ScanItem>()

    @DataMember
    var BatchName:String? = null

    @DataMember
    var AppendMode:Boolean? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    var Token:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    var DeviceId:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    var AppId:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * This is your AIM API Key provided by Tri-Tech
    */
    @DataMember
    @ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="header")
    var ApiKey:String? = null

    @DataMember
    @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    var OAuthToken:String? = null
}

@DataContract
open class ScanItem : IScanItem
{
    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SasPk:Long? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var ExceptionInfo:ExceptionInfo? = null
}

@DataContract
open class ExceptionInfo
{
    @DataMember
    var Barcode:String? = null

    @DataMember
    var Description:String? = null

    @DataMember
    var Base64Image:String? = null

    @DataMember
    var Category:Int? = null

    @DataMember
    var SubCategory:Int? = null
}

@DataContract
open class PhysicalSpotCheckResponse : BaseResponse()
{
    @DataMember
    var ErrorItems:ArrayList<ScanErrorItem> = ArrayList<ScanErrorItem>()
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    var IpAddress:String? = null
}

@DataContract
open class ScanErrorItem : IScanItem
{
    @DataMember
    var SkuPk:Long? = null

    @DataMember
    var SasPk:Long? = null

    @DataMember
    var Sku:String? = null

    @DataMember
    var Serial:String? = null

    @DataMember
    var Quantity:BigDecimal? = null

    @DataMember
    var ExceptionInfo:ExceptionInfo? = null

    @DataMember
    var ErrorMessage:String? = null
}

Kotlin PhysicalSpotCheckRequest 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/PhysicalSpotCheck HTTP/1.1 
Host: active-ewebservice.biz 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"LocPk":0,"Location":"String","Items":[{"SkuPk":0,"SasPk":0,"Sku":"String","Serial":"String","Quantity":0,"ExceptionInfo":{"Barcode":"String","Description":"String","Base64Image":"String","Category":0,"SubCategory":0}}],"BatchName":"String","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"}}