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

Namespace Global

    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 Overridable Property ApiKey As String

            '''<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 Overridable Property OAuthToken As String

            '''<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 Overridable Property DeviceId As String

            '''<Summary>
            '''An identifier for your integration
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="string", Description:="An identifier for your integration", IsRequired:=true, Name:="AppId", ParameterType:="Header")>
            Public Overridable Property AppId As String
        End Class

        <DataContract>
        Public Partial Class BaseResponse
            '''<Summary>
            '''
            '''</Summary>
            <DataMember>
            <ApiMember(DataType:="BaseResponseResult", Description:="", Name:="Status", ParameterType:="body")>
            Public Overridable Property Status As BaseResponseResult

            <DataContract>
            Public Partial Class BaseResponseResult
                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="StatusCode", ParameterType:="body")>
                Public Overridable Property StatusCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="Login", ParameterType:="body")>
                Public Overridable Property Login As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorCode", ParameterType:="body")>
                Public Overridable Property ErrorCode As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorDisplayText", ParameterType:="body")>
                Public Overridable Property ErrorDisplayText As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", Name:="ErrorMessage", ParameterType:="body")>
                Public Overridable Property ErrorMessage As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="DomainName", ParameterType:="body")>
                Public Overridable Property DomainName As String

                '''<Summary>
                '''
                '''</Summary>
                <DataMember>
                <ApiMember(DataType:="string", Description:="", ExcludeInSchema:=true, Name:="IPAddress", ParameterType:="body")>
                Public Overridable Property IpAddress As String
            End Class
        End Class

        <DataContract>
        Public Partial Class BaseSecureRequest
            Inherits 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 Overridable Property Token As String
        End Class

        <DataContract>
        Public Partial Class ContractScheduledReturnInfo
            <DataMember>
            Public Overridable Property Acct As Integer

            <DataMember>
            Public Overridable Property Sub As Integer

            <DataMember>
            Public Overridable Property Name As String

            <DataMember>
            Public Overridable Property Address As String

            <DataMember>
            Public Overridable Property Address2 As String

            <DataMember>
            Public Overridable Property City As String

            <DataMember>
            Public Overridable Property Student As String

            <DataMember>
            Public Overridable Property School As String

            <DataMember>
            Public Overridable Property District As String

            <DataMember>
            Public Overridable Property Item As String

            <DataMember>
            Public Overridable Property Employee As String

            <DataMember>
            Public Overridable Property ReturnedDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property ScheduledReturnDate As Date

            <DataMember>
            Public Overridable Property StockNumber As String

            <DataMember>
            Public Overridable Property Serial As String

            <DataMember>
            Public Overridable Property ReturnOption As String

            <DataMember>
            Public Overridable Property ScheduledReturnedRef As String

            <DataMember>
            Public Overridable Property Status As String

            <DataMember>
            Public Overridable Property AutoPayHoldDate As Nullable(Of Date)

            <DataMember>
            Public Overridable Property MobileReturnedStatus As Boolean
        End Class

        '''<Summary>
        '''ContractScheduledReturnsRequires active-e Contracts Service.
        '''</Summary>
        <DataContract>
        Public Partial Class ContractScheduledReturnsRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property DateFrom As Nullable(Of Date)

            <DataMember>
            Public Overridable Property DateTo As Nullable(Of Date)

            <DataMember>
            Public Overridable Property DistrictId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property SchoolId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property LocationId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property StatusId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property OptionId As Nullable(Of Long)

            <DataMember>
            Public Overridable Property IncludeReturned As Nullable(Of Boolean)

            <DataMember>
            Public Overridable Property LanId As String
        End Class

        <DataContract>
        Public Partial Class ContractScheduledReturnsResponse
            Inherits BaseResponse
            Public Sub New()
                Contracts = New List(Of ContractScheduledReturnInfo)
            End Sub

            <DataMember>
            Public Overridable Property Contracts As List(Of ContractScheduledReturnInfo)
        End Class
    End Namespace
End Namespace

VB.NET 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>