AIM Web Services

<back to all web services

ContractScheduledReturnsRequest

ContractScheduledReturns
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/ContractScheduledReturns
namespace AIM.WebService

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponseResult() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")>]
        member val StatusCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")>]
        member val Login:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")>]
        member val ErrorCode:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")>]
        member val ErrorDisplayText:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")>]
        member val ErrorMessage:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")>]
        member val DomainName:String = null with get,set

        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")>]
        member val IpAddress:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseResponse() = 
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")>]
        member val Status:BaseResponseResult = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ContractScheduledReturnInfo() = 
        [<DataMember>]
        member val Acct:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Sub:Int32 = new Int32() with get,set

        [<DataMember>]
        member val Name:String = null with get,set

        [<DataMember>]
        member val Address:String = null with get,set

        [<DataMember>]
        member val Address2:String = null with get,set

        [<DataMember>]
        member val City:String = null with get,set

        [<DataMember>]
        member val Student:String = null with get,set

        [<DataMember>]
        member val School:String = null with get,set

        [<DataMember>]
        member val District:String = null with get,set

        [<DataMember>]
        member val Item:String = null with get,set

        [<DataMember>]
        member val Employee:String = null with get,set

        [<DataMember>]
        member val ReturnedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val ScheduledReturnDate:DateTime = new DateTime() with get,set

        [<DataMember>]
        member val StockNumber:String = null with get,set

        [<DataMember>]
        member val Serial:String = null with get,set

        [<DataMember>]
        member val ReturnOption:String = null with get,set

        [<DataMember>]
        member val ScheduledReturnedRef:String = null with get,set

        [<DataMember>]
        member val Status:String = null with get,set

        [<DataMember>]
        member val AutoPayHoldDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val MobileReturnedStatus:Boolean = new Boolean() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type ContractScheduledReturnsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val Contracts:ResizeArray<ContractScheduledReturnInfo> = new ResizeArray<ContractScheduledReturnInfo>() with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type 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")>]
        member val ApiKey:String = null with 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")>]
        member val OAuthToken:String = null with 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")>]
        member val DeviceId:String = null with 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")>]
        member val AppId:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit 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")>]
        member val Token:String = null with get,set

    ///<summary>
    ///ContractScheduledReturnsRequires active-e Contracts Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type ContractScheduledReturnsRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val DateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val DateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set

        [<DataMember>]
        member val DistrictId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val SchoolId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val LocationId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val StatusId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val OptionId:Nullable<Int64> = new Nullable<Int64>() with get,set

        [<DataMember>]
        member val IncludeReturned:Nullable<Boolean> = new Nullable<Boolean>() with get,set

        [<DataMember>]
        member val LanId:String = null with get,set

F# ContractScheduledReturnsRequest 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/ContractScheduledReturns HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<ContractScheduledReturnsResponse 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>
  <Contracts>
    <ContractScheduledReturnInfo>
      <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>
      <Item>String</Item>
      <MobileReturnedStatus>false</MobileReturnedStatus>
      <Name>String</Name>
      <ReturnOption>String</ReturnOption>
      <ReturnedDate>0001-01-01T00:00:00</ReturnedDate>
      <ScheduledReturnDate>0001-01-01T00:00:00</ScheduledReturnDate>
      <ScheduledReturnedRef>String</ScheduledReturnedRef>
      <School>String</School>
      <Serial>String</Serial>
      <Status>String</Status>
      <StockNumber>String</StockNumber>
      <Student>String</Student>
      <Sub>0</Sub>
    </ContractScheduledReturnInfo>
  </Contracts>
</ContractScheduledReturnsResponse>