AIM Web Services

<back to all web services

ScheduledExchangesGetRequest

ScheduledExchanges
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/ScheduledExchanges
// @ts-nocheck

// @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 ScheduledExchangesGetInfo
{
    // @DataMember
    public ExchangeID: number;

    // @DataMember
    public Acct: number;

    // @DataMember
    public Sub: number;

    // @DataMember
    public Name?: string;

    // @DataMember
    public Address?: string;

    // @DataMember
    public Address2?: string;

    // @DataMember
    public City?: string;

    // @DataMember
    public Student?: string;

    // @DataMember
    public School?: string;

    // @DataMember
    public District?: string;

    // @DataMember
    public Item?: string;

    // @DataMember
    public Employee?: string;

    // @DataMember
    public ReturnedDate?: string;

    // @DataMember
    public StockNumber?: string;

    // @DataMember
    public Serial?: string;

    // @DataMember
    public ReturnOption?: string;

    // @DataMember
    public ScheduledReturnedRef?: string;

    // @DataMember
    public Status?: string;

    // @DataMember
    public History?: string;

    // @DataMember
    public ExchangeRef?: number;

    // @DataMember
    public AutoPayHoldDate?: string;

    // @DataMember
    public ExchangedItem?: string;

    // @DataMember
    public PostingDate: string;

    // @DataMember
    public ScheduledDate: string;

    // @DataMember
    public NewSku?: string;

    // @DataMember
    public Notes?: string;

    // @DataMember
    public Source?: string;

    // @DataMember
    public Option?: string;

    // @DataMember
    public Processed: boolean;

    // @DataMember
    public MobileExchangedStatus: boolean;

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

// @DataContract
export class ScheduledExchangesGetResponse extends BaseResponse
{
    // @DataMember
    public ScheduledExchanges?: ScheduledExchangesGetInfo[];

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

/** @description ScheduledExchangesRequires active-e Contracts Service. */
// @DataContract
export class ScheduledExchangesGetRequest extends BaseSecureRequest
{
    // @DataMember
    public ScheduledDateFrom?: string;

    // @DataMember
    public ScheduledDateTo?: string;

    // @DataMember
    public DistrictId?: number;

    // @DataMember
    public SchoolId?: number;

    // @DataMember
    public LocationId?: number;

    // @DataMember
    public StatusId?: number;

    // @DataMember
    public OptionId?: number;

    // @DataMember
    public IncludeProcessed?: boolean;

    // @DataMember
    public LanId?: string;

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

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

GET /api/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

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

{"ScheduledExchanges":[{"ExchangeID":0,"Acct":0,"Sub":0,"Name":"String","Address":"String","Address2":"String","City":"String","Student":"String","School":"String","District":"String","Item":"String","Employee":"String","ReturnedDate":"0001-01-01T00:00:00.0000000","StockNumber":"String","Serial":"String","ReturnOption":"String","ScheduledReturnedRef":"String","Status":"String","History":"String","ExchangeRef":0,"AutoPayHoldDate":"0001-01-01T00:00:00.0000000","ExchangedItem":"String","NewSku":"String","Notes":"String","Source":"String","Option":"String","Processed":false,"MobileExchangedStatus":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}