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

// @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 .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/ScheduledExchanges HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ScheduledExchangesGetResponse 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>
  <ScheduledExchanges>
    <ScheduledExchangesGetInfo>
      <Acct>0</Acct>
      <Address>String</Address>
      <Address2>String</Address2>
      <AutoPayHoldDate>0001-01-01T00:00:00</AutoPayHoldDate>
      <City>String</City>
      <District>String</District>
      <Employee>String</Employee>
      <ExchangeID>0</ExchangeID>
      <ExchangeRef>0</ExchangeRef>
      <ExchangedItem>String</ExchangedItem>
      <History>String</History>
      <Item>String</Item>
      <MobileExchangedStatus>false</MobileExchangedStatus>
      <Name>String</Name>
      <NewSku>String</NewSku>
      <Notes>String</Notes>
      <Option>String</Option>
      <PostingDate>0001-01-01T00:00:00</PostingDate>
      <Processed>false</Processed>
      <ReturnOption>String</ReturnOption>
      <ReturnedDate>0001-01-01T00:00:00</ReturnedDate>
      <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
      <ScheduledReturnedRef>String</ScheduledReturnedRef>
      <School>String</School>
      <Serial>String</Serial>
      <Source>String</Source>
      <Status>String</Status>
      <StockNumber>String</StockNumber>
      <Student>String</Student>
      <Sub>0</Sub>
    </ScheduledExchangesGetInfo>
  </ScheduledExchanges>
</ScheduledExchangesGetResponse>