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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using AIM.WebService;

namespace AIM.WebService
{
    [DataContract]
    public partial class BaseRequest
    {
        ///<summary>
        ///This is your AIM API Key provided by Tri-Tech
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="This is your AIM API Key provided by Tri-Tech", IsRequired=true, Name="ApiKey", ParameterType="Header")]
        public virtual string ApiKey { get; set; }

        ///<summary>
        ///The OAuthToken token return by AeServices30
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")]
        public virtual string OAuthToken { get; set; }

        ///<summary>
        ///The Device ID of the Mobile Device. Not used for non-mobile devices.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Device ID of the Mobile Device. Not used for non-mobile devices.", Name="DeviceId", ParameterType="Header")]
        public virtual string DeviceId { get; set; }

        ///<summary>
        ///An identifier for your integration
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")]
        public virtual string AppId { get; set; }
    }

    [DataContract]
    public partial class BaseResponse
    {
        ///<summary>
        ///
        ///</summary>
        [DataMember]
        [ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")]
        public virtual BaseResponseResult Status { get; set; }
        [DataContract]
        public partial class BaseResponseResult
        {
            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")]
            public virtual string StatusCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")]
            public virtual string Login { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")]
            public virtual string ErrorCode { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")]
            public virtual string ErrorDisplayText { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")]
            public virtual string ErrorMessage { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")]
            public virtual string DomainName { get; set; }

            ///<summary>
            ///
            ///</summary>
            [DataMember]
            [ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")]
            public virtual string IpAddress { get; set; }
        }

    }

    [DataContract]
    public partial class BaseSecureRequest
        : BaseRequest
    {
        ///<summary>
        ///The Login Token return by the Security API. Required for secured calls.
        ///</summary>
        [DataMember]
        [ApiMember(DataType="string", Description="The Login Token return by the Security API. Required for secured calls.", Name="Token", ParameterType="Header")]
        public virtual string Token { get; set; }
    }

    [DataContract]
    public partial class ScheduledExchangesGetInfo
    {
        [DataMember]
        public virtual long ExchangeID { get; set; }

        [DataMember]
        public virtual int Acct { get; set; }

        [DataMember]
        public virtual int Sub { get; set; }

        [DataMember]
        public virtual string Name { get; set; }

        [DataMember]
        public virtual string Address { get; set; }

        [DataMember]
        public virtual string Address2 { get; set; }

        [DataMember]
        public virtual string City { get; set; }

        [DataMember]
        public virtual string Student { get; set; }

        [DataMember]
        public virtual string School { get; set; }

        [DataMember]
        public virtual string District { get; set; }

        [DataMember]
        public virtual string Item { get; set; }

        [DataMember]
        public virtual string Employee { get; set; }

        [DataMember]
        public virtual DateTime? ReturnedDate { get; set; }

        [DataMember]
        public virtual string StockNumber { get; set; }

        [DataMember]
        public virtual string Serial { get; set; }

        [DataMember]
        public virtual string ReturnOption { get; set; }

        [DataMember]
        public virtual string ScheduledReturnedRef { get; set; }

        [DataMember]
        public virtual string Status { get; set; }

        [DataMember]
        public virtual string History { get; set; }

        [DataMember]
        public virtual long? ExchangeRef { get; set; }

        [DataMember]
        public virtual DateTime? AutoPayHoldDate { get; set; }

        [DataMember]
        public virtual string ExchangedItem { get; set; }

        [DataMember]
        public virtual DateTime PostingDate { get; set; }

        [DataMember]
        public virtual DateTime ScheduledDate { get; set; }

        [DataMember]
        public virtual string NewSku { get; set; }

        [DataMember]
        public virtual string Notes { get; set; }

        [DataMember]
        public virtual string Source { get; set; }

        [DataMember]
        public virtual string Option { get; set; }

        [DataMember]
        public virtual bool Processed { get; set; }

        [DataMember]
        public virtual bool MobileExchangedStatus { get; set; }
    }

    ///<summary>
    ///ScheduledExchangesRequires active-e Contracts Service.
    ///</summary>
    [DataContract]
    public partial class ScheduledExchangesGetRequest
        : BaseSecureRequest
    {
        [DataMember]
        public virtual DateTime? ScheduledDateFrom { get; set; }

        [DataMember]
        public virtual DateTime? ScheduledDateTo { get; set; }

        [DataMember]
        public virtual long? DistrictId { get; set; }

        [DataMember]
        public virtual long? SchoolId { get; set; }

        [DataMember]
        public virtual long? LocationId { get; set; }

        [DataMember]
        public virtual long? StatusId { get; set; }

        [DataMember]
        public virtual long? OptionId { get; set; }

        [DataMember]
        public virtual bool? IncludeProcessed { get; set; }

        [DataMember]
        public virtual string LanId { get; set; }
    }

    [DataContract]
    public partial class ScheduledExchangesGetResponse
        : BaseResponse
    {
        public ScheduledExchangesGetResponse()
        {
            ScheduledExchanges = new List<ScheduledExchangesGetInfo>{};
        }

        [DataMember]
        public virtual List<ScheduledExchangesGetInfo> ScheduledExchanges { get; set; }
    }

}

C# 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>