AIM Web Services

<back to all web services

SaleInfoRequest

SaleInfo
Requires active-e Inventory Service

The following routes are available for this service:
GET/api/SaleInfo

// @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 DiscountFromPriceLevel
{
    // @DataMember
    public BasePriceLevel: string;

    // @DataMember
    public DisountPercentage: number;

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

// @DataContract
export class RecurringSaleDay
{
    // @DataMember
    public Weekday: string;

    // @DataMember
    public BeginHour: number;

    // @DataMember
    public BeginMinute: number;

    // @DataMember
    public EndHour: number;

    // @DataMember
    public EndMinute: number;

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

// @DataContract
export class RecurringSaleInfo
{
    // @DataMember
    public Days: RecurringSaleDay[];

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

// @DataContract
export class SaleRecord
{
    // @DataMember
    public SadPk: number;

    // @DataMember
    public SkuPk: number;

    // @DataMember
    public SaqPk: number;

    // @DataMember
    public Model: string;

    // @DataMember
    public SKU: string;

    // @DataMember
    public LocationId: number;

    // @DataMember
    public StartDate: string;

    // @DataMember
    public EndDate: string;

    // @DataMember
    public CustomerAccount?: number;

    // @DataMember
    public CustomerDefaultId?: number;

    // @DataMember
    public Condition: string;

    // @DataMember
    public DiscountFromPriceLevel: DiscountFromPriceLevel;

    // @DataMember
    public DiscountByPriceLevel: string;

    // @DataMember
    public DiscountBySetPrice?: number;

    // @DataMember
    public DiscountByAmount?: number;

    // @DataMember
    public RecurringSale: RecurringSaleInfo;

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

// @DataContract
export class SaleInfoResponse extends BaseResponse
{
    // @DataMember
    public SaleRecords: SaleRecord[];

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

/** @description SaleInfoRequires active-e Inventory Service */
// @DataContract
export class SaleInfoRequest extends BaseSecureRequest
{
    // @DataMember
    public LocationId?: number;

    /** @description If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used */
    // @DataMember
    // @ApiMember(Description="If sent, only sales that are active during the sent Date/Time are returned. Otherwise, the current Date/Time is used", Name="DateTime")
    public DateTime?: string;

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

TypeScript SaleInfoRequest 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.

GET /api/SaleInfo HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<SaleInfoResponse 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>
  <SaleRecords>
    <SaleRecord>
      <Condition>String</Condition>
      <CustomerAccount>0</CustomerAccount>
      <CustomerDefaultId>0</CustomerDefaultId>
      <DiscountByAmount>0</DiscountByAmount>
      <DiscountByPriceLevel>String</DiscountByPriceLevel>
      <DiscountBySetPrice>0</DiscountBySetPrice>
      <DiscountFromPriceLevel>
        <BasePriceLevel>String</BasePriceLevel>
        <DisountPercentage>0</DisountPercentage>
      </DiscountFromPriceLevel>
      <EndDate>0001-01-01T00:00:00</EndDate>
      <LocationId>0</LocationId>
      <Model>String</Model>
      <RecurringSale>
        <Days>
          <RecurringSaleDay>
            <BeginHour>0</BeginHour>
            <BeginMinute>0</BeginMinute>
            <EndHour>0</EndHour>
            <EndMinute>0</EndMinute>
            <Weekday>String</Weekday>
          </RecurringSaleDay>
        </Days>
      </RecurringSale>
      <SKU>String</SKU>
      <SadPk>0</SadPk>
      <SaqPk>0</SaqPk>
      <SkuPk>0</SkuPk>
      <StartDate>0001-01-01T00:00:00</StartDate>
    </SaleRecord>
  </SaleRecords>
</SaleInfoResponse>