AIM Web Services

BarcodeLabelsRequest

In development, not yet for public use.

The following routes are available for this service:
POST	/api/BarcodeLabels


// @DataContract
export class BaseRequest
{
    /** @description 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")
    public ApiKey: string;

    // @DataMember
    // @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
    public OAuthToken: string;

    public constructor(init?: Partial<BaseRequest>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
    public Token: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
    public AppId: string;

    public constructor(init?: Partial<BaseSecureRequest>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponseResult
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    public StatusCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    public Login: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    public ErrorCode: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    public ErrorDisplayText: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    public ErrorMessage: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    public DomainName: string;

    /** @description  */
    // @DataMember
    // @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    public IpAddress: string;

    public constructor(init?: Partial<BaseResponseResult>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BaseResponse
{
    /** @description  */
    // @DataMember
    // @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    public Status: BaseResponseResult;

    public constructor(init?: Partial<BaseResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ExceptionInfo
{
    // @DataMember
    public Barcode: string;

    // @DataMember
    public Description: string;

    // @DataMember
    public Base64Image: string;

    // @DataMember
    public Category: number;

    // @DataMember
    public SubCategory?: number;

    public constructor(init?: Partial<ExceptionInfo>) { (Object as any).assign(this, init); }
}

// @DataContract
export class ScanErrorItem implements IScanItem
{
    // @DataMember
    public SkuPk?: number;

    // @DataMember
    public SasPk?: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public ExceptionInfo: ExceptionInfo;

    // @DataMember
    public ErrorMessage: string;

    public constructor(init?: Partial<ScanErrorItem>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BarcodeLabelsResponse extends BaseResponse
{
    // @DataMember
    public ErrorItems: ScanErrorItem[];

    public constructor(init?: Partial<BarcodeLabelsResponse>) { super(init); (Object as any).assign(this, init); }
}

// @DataContract
export class ScanItem implements IScanItem
{
    // @DataMember
    public SkuPk?: number;

    // @DataMember
    public SasPk?: number;

    // @DataMember
    public Sku: string;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Quantity: number;

    // @DataMember
    public ExceptionInfo: ExceptionInfo;

    public constructor(init?: Partial<ScanItem>) { (Object as any).assign(this, init); }
}

/** @description In development, not yet for public use. */
// @DataContract
export class BarcodeLabelsRequest extends BaseSecureRequest
{
    /** @description The listening workstation to handle the request. */
    // @DataMember
    // @ApiMember(Description="The listening workstation to handle the request.", Name="OutputWorkstation", ParameterType="query")
    public OutputWorkstation?: number;

    // @DataMember
    public Items: ScanItem[];

    public constructor(init?: Partial<BarcodeLabelsRequest>) { super(init); (Object as any).assign(this, init); }
}

TypeScript BarcodeLabelsRequest 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/BarcodeLabels HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json
Content-Type: application/json
Content-Length: length

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

HTTP/1.1 200 OK
Content-Type: application/json
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"}}