AIM Web Services

<back to all web services

SerialDetailRequest

SerialDetail
Requires active-e Inventory Service

The following routes are available for this service:
POST, GET/api/SerialDetail

// @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;

    /** @description The OAuthToken token return by AeServices30 */
    // @DataMember
    // @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    public OAuthToken: string;

    /** @description The Device ID of the Mobile Device. Not used for non-mobile devices. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")
    public DeviceId: string;

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

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

// @DataContract
export class BaseSecureRequest extends BaseRequest
{
    /** @description The Login Token return by the Security API. Required for secured calls. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")
    public Token: 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 InventoryDetailAttribute
{
    // @DataMember
    public Name: string;

    // @DataMember
    public Value: string;

    // @DataMember
    public Priority: number;

    /** @description 1 is 'Don't Send to Web', 2 is 'Send To Web' */
    // @DataMember
    // @ApiMember(DataType="int", Description="1 is 'Don't Send to Web', 2 is 'Send To Web'", Name="WebType", ParameterType="query")
    public WebType: number;

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

// @DataContract
export class ImageInfo
{
    // @DataMember
    public Url: string;

    // @DataMember
    public ImageStream: string;

    // @DataMember
    public ImageSize: string;

    // @DataMember
    public ErrorMessage: string;

    // @DataMember
    public UriPk?: number;

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

// @DataContract
export class InventoryDetailBySerial
{
    // @DataMember
    public SasPk: number;

    // @DataMember
    public Serial: string;

    // @DataMember
    public Retail: number;

    // @DataMember
    public OurPrice: number;

    // @DataMember
    public SalePrice?: number;

    // @DataMember
    public Status: string;

    // @DataMember
    public SaleInfo: string;

    // @DataMember
    public PriceA: number;

    // @DataMember
    public PriceB: number;

    // @DataMember
    public PriceC: number;

    // @DataMember
    public MinPrice: number;

    // @DataMember
    public ActiveEPrice: number;

    // @DataMember
    public AllowPriceChange: boolean;

    // @DataMember
    public Cost?: number;

    // @DataMember
    public WeightedCost?: number;

    // @DataMember
    public Notes: string;

    // @DataMember
    public Attributes: InventoryDetailAttribute[];

    // @DataMember
    public Images: ImageInfo[];

    // @DataMember
    public HasImages: boolean;

    // @DataMember
    public IsActiveeHoldback: boolean;

    // @DataMember
    public CustomerAcct?: number;

    // @DataMember
    public AvailableForSTR: boolean;

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

// @DataContract
export class SerialDetailResponse extends BaseResponse
{
    // @DataMember
    public SasPk: number;

    // @DataMember
    public Serial: string;

    // @DataMember
    public SaqPk: number;

    // @DataMember
    public LocPk: number;

    // @DataMember
    public Location: string;

    // @DataMember
    public SkuPk: number;

    // @DataMember
    public SKU: string;

    // @DataMember
    public SadPk: number;

    // @DataMember
    public Model: string;

    // @DataMember
    public Details: InventoryDetailBySerial;

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

/** @description SerialDetailRequires active-e Inventory Service */
// @DataContract
export class SerialDetailRequest extends BaseSecureRequest
{
    /** @description The PK being used for lookup. Do not use if Serial is passed in. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="The PK being used for lookup. Do not use if Serial is passed in.", Format="int64", Name="Pk", ParameterType="query")
    public Pk?: number;

    /** @description The Serial# being used for lookup. Do not use if Pk is passed in. */
    // @DataMember
    // @ApiMember(DataType="string", Description="The Serial# being used for lookup. Do not use if Pk is passed in.", Name="Serial", ParameterType="query")
    public Serial: string;

    // @DataMember
    public SkipImages: boolean;

    /** @description If sent, the Customer Acct will be used for customer specific pricing. */
    // @DataMember
    // @ApiMember(DataType="integer", Description="If sent, the Customer Acct will be used for customer specific pricing.", Format="int32", Name="CustomerAcct", ParameterType="query")
    public CustomerAcct?: number;

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

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

<SerialDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
  <ApiKey>String</ApiKey>
  <AppId>String</AppId>
  <DeviceId>String</DeviceId>
  <OAuthToken>String</OAuthToken>
  <Token>String</Token>
  <CustomerAcct>0</CustomerAcct>
  <Pk>0</Pk>
  <Serial>String</Serial>
  <SkipImages>false</SkipImages>
</SerialDetailRequest>

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

<SerialDetailResponse 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>
  <Details i:nil="true" />
  <LocPk>0</LocPk>
  <Location>String</Location>
  <Model>String</Model>
  <SKU>String</SKU>
  <SadPk>0</SadPk>
  <SaqPk>0</SaqPk>
  <SasPk>0</SasPk>
  <Serial>String</Serial>
  <SkuPk>0</SkuPk>
</SerialDetailResponse>