AIM Web Services

<back to all web services

C2BGetUnfinishedContractsRequest

C2BGetUnfinishedContracts
Requires active-e Contracts Service.

The following routes are available for this service:
GET/api/C2BGetUnfinishedContracts
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports AIM.WebService
Imports AIM

Namespace Global

    Namespace AIM

        <DataContract>
        Public Partial Class LocationInfo
            <DataMember>
            Public Overridable Property Id As Long

            <DataMember>
            Public Overridable Property Desc As String

            <DataMember>
            Public Overridable Property ShortDesc As String

            <DataMember>
            Public Overridable Property Region As String

            <DataMember>
            Public Overridable Property Latitude As Decimal

            <DataMember>
            Public Overridable Property Longitude As Decimal

            <DataMember>
            Public Overridable Property InStorePickup As String

            <DataMember>
            Public Overridable Property Active As Boolean

            <DataMember>
            Public Overridable Property CashSaleAcct As Nullable(Of Integer)
        End Class
    End Namespace

    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

        '''<Summary>
        '''C2BGetUnfinishedContractsRequires active-e Contracts Service.
        '''</Summary>
        <DataContract>
        Public Partial Class C2BGetUnfinishedContractsRequest
            Inherits BaseSecureRequest
            <DataMember>
            Public Overridable Property Type As String

            <DataMember>
            Public Overridable Property StartOffset As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property RecordCount As Nullable(Of Integer)

            <DataMember>
            Public Overridable Property SearchStr As String

            <DataMember>
            Public Overridable Property IncludeContractsEnteredByOtherUsers As Boolean

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

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

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

            <DataMember>
            Public Overridable Property DeliveryDesc As String

            <DataMember>
            Public Overridable Property Status As String
        End Class

        <DataContract>
        Public Partial Class C2BGetUnfinishedContractsResponse
            Inherits BaseResponse
            Public Sub New()
                UnfinishedContracts = New List(Of UnfinishedContract)
            End Sub

            <DataMember>
            Public Overridable Property UnfinishedContracts As List(Of UnfinishedContract)

            <DataMember>
            Public Overridable Property Topic As String

            <DataMember>
            Public Overridable Property BaseUrl As String

            <DataContract>
            Public Partial Class UnfinishedContract
                Public Sub New()
                    Accessories = New List(Of C2BAccessory)
                End Sub

                <DataMember>
                Public Overridable Property CustomerName As String

                <DataMember>
                Public Overridable Property CustomerAcct As Integer

                <DataMember>
                Public Overridable Property StudentName As String

                <DataMember>
                Public Overridable Property Ref As String

                <DataMember>
                Public Overridable Property DateTime As Date

                <DataMember>
                Public Overridable Property Location As LocationInfo

                <DataMember>
                Public Overridable Property District As String

                <DataMember>
                Public Overridable Property School As String

                <DataMember>
                Public Overridable Property Teacher As String

                <DataMember>
                Public Overridable Property Instrument As String

                <DataMember>
                Public Overridable Property Status As String

                <DataMember>
                Public Overridable Property Notes As String

                <DataMember>
                Public Overridable Property LockedBy As String

                <DataMember>
                Public Overridable Property InstrumentGrade As String

                <DataMember>
                Public Overridable Property Serial As String

                <DataMember>
                Public Overridable Property Salesperson As String

                <DataMember>
                Public Overridable Property WebNotes As String

                <DataMember>
                Public Overridable Property Email As String

                <DataMember>
                Public Overridable Property Phone As String

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

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

                <DataMember>
                Public Overridable Property Accessories As List(Of C2BAccessory)

                <DataMember>
                Public Overridable Property DownPay As Decimal

                <DataMember>
                Public Overridable Property MonthlyPay As Decimal

                <DataMember>
                Public Overridable Property DownMaint As Decimal

                <DataMember>
                Public Overridable Property MonthlyMaint As Decimal

                <DataMember>
                Public Overridable Property DownLease As Decimal

                <DataMember>
                Public Overridable Property MonthlyLease As Decimal

                <DataMember>
                Public Overridable Property DownTotal As Decimal

                <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 State As String

                <DataMember>
                Public Overridable Property Zip As String

                <DataMember>
                Public Overridable Property Country As String

                <DataMember>
                Public Overridable Property InvoiceCreated As Boolean

                <DataMember>
                Public Overridable Property ContractCreated As Boolean

                <DataContract>
                Public Partial Class C2BAccessory
                    <DataMember>
                    Public Overridable Property Id As Long

                    <DataMember>
                    Public Overridable Property Description As String

                    <DataMember>
                    Public Overridable Property Price As Decimal

                    <DataMember>
                    Public Overridable Property Type As String

                    <DataMember>
                    Public Overridable Property Sku As String

                    <DataMember>
                    Public Overridable Property Category As Nullable(Of Integer)

                    <DataMember>
                    Public Overridable Property Delivered As Boolean
                End Class
            End Class
        End Class
    End Namespace
End Namespace

VB.NET C2BGetUnfinishedContractsRequest 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/C2BGetUnfinishedContracts HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/xml

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

<C2BGetUnfinishedContractsResponse 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>
  <BaseUrl>String</BaseUrl>
  <Topic>String</Topic>
  <UnfinishedContracts>
    <C2BGetUnfinishedContractsResponse.UnfinishedContract>
      <Accessories>
        <C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
          <Category>0</Category>
          <Delivered>false</Delivered>
          <Description>String</Description>
          <Id>0</Id>
          <Price>0</Price>
          <Sku>String</Sku>
          <Type>String</Type>
        </C2BGetUnfinishedContractsResponse.UnfinishedContract.C2BAccessory>
      </Accessories>
      <Address>String</Address>
      <Address2>String</Address2>
      <City>String</City>
      <ContractCreated>false</ContractCreated>
      <Country>String</Country>
      <CustomerAcct>0</CustomerAcct>
      <CustomerName>String</CustomerName>
      <DateTime>0001-01-01T00:00:00</DateTime>
      <DeliveryDate>0001-01-01T00:00:00</DeliveryDate>
      <District>String</District>
      <DownLease>0</DownLease>
      <DownMaint>0</DownMaint>
      <DownPay>0</DownPay>
      <DownTotal>0</DownTotal>
      <Email>String</Email>
      <FirstDue>0001-01-01T00:00:00</FirstDue>
      <Instrument>String</Instrument>
      <InstrumentGrade>String</InstrumentGrade>
      <InvoiceCreated>false</InvoiceCreated>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Active>false</d4p1:Active>
        <d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
        <d4p1:Desc>String</d4p1:Desc>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:InStorePickup>String</d4p1:InStorePickup>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:ShortDesc>String</d4p1:ShortDesc>
      </Location>
      <LockedBy>String</LockedBy>
      <MonthlyLease>0</MonthlyLease>
      <MonthlyMaint>0</MonthlyMaint>
      <MonthlyPay>0</MonthlyPay>
      <Notes>String</Notes>
      <Phone>String</Phone>
      <Ref>String</Ref>
      <Salesperson>String</Salesperson>
      <School>String</School>
      <Serial>String</Serial>
      <State>String</State>
      <Status>String</Status>
      <StudentName>String</StudentName>
      <Teacher>String</Teacher>
      <WebNotes>String</WebNotes>
      <Zip>String</Zip>
    </C2BGetUnfinishedContractsResponse.UnfinishedContract>
  </UnfinishedContracts>
</C2BGetUnfinishedContractsResponse>