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
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* C2BGetUnfinishedContractsRequires active-e Contracts Service.
*/
@DataContract
open class C2BGetUnfinishedContractsRequest : BaseSecureRequest()
{
    @DataMember
    open var Type:String? = null

    @DataMember
    open var StartOffset:Int? = null

    @DataMember
    open var RecordCount:Int? = null

    @DataMember
    open var SearchStr:String? = null

    @DataMember
    open var IncludeContractsEnteredByOtherUsers:Boolean? = null

    @DataMember
    open var DistrictId:Long? = null

    @DataMember
    open var SchoolId:Long? = null

    @DataMember
    open var TeacherId:Long? = null

    @DataMember
    open var DeliveryDesc:String? = null

    @DataMember
    open var Status:String? = null
}

@DataContract
open class BaseSecureRequest : BaseRequest()
{
    /**
    * 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")
    open var Token:String? = null
}

@DataContract
open class BaseRequest
{
    /**
    * 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")
    open var ApiKey:String? = null

    /**
    * The OAuthToken token return by AeServices30
    */
    @DataMember
    @ApiMember(DataType="string", Description="The OAuthToken token return by AeServices30", IsRequired=true, Name="OAuthToken", ParameterType="Header")
    open var OAuthToken:String? = null

    /**
    * 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")
    open var DeviceId:String? = null

    /**
    * An identifier for your integration
    */
    @DataMember
    @ApiMember(DataType="string", Description="An identifier for your integration", IsRequired=true, Name="AppId", ParameterType="Header")
    open var AppId:String? = null
}

@DataContract
open class C2BGetUnfinishedContractsResponse : BaseResponse()
{
    @DataMember
    open var UnfinishedContracts:ArrayList<UnfinishedContract>? = null

    @DataMember
    open var Topic:String? = null

    @DataMember
    open var BaseUrl:String? = null
}

@DataContract
open class BaseResponse
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
    open var Status:BaseResponseResult? = null
}

@DataContract
open class BaseResponseResult
{
    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
    open var StatusCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
    open var Login:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
    open var ErrorCode:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
    open var ErrorDisplayText:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
    open var ErrorMessage:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
    open var DomainName:String? = null

    /**
    * 
    */
    @DataMember
    @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
    open var IpAddress:String? = null
}

@DataContract
open class UnfinishedContract
{
    @DataMember
    open var CustomerName:String? = null

    @DataMember
    open var CustomerAcct:Int? = null

    @DataMember
    open var StudentName:String? = null

    @DataMember
    open var Ref:String? = null

    @DataMember
    open var DateTime:Date? = null

    @DataMember
    open var Location:LocationInfo? = null

    @DataMember
    open var District:String? = null

    @DataMember
    open var School:String? = null

    @DataMember
    open var Teacher:String? = null

    @DataMember
    open var Instrument:String? = null

    @DataMember
    open var Status:String? = null

    @DataMember
    open var Notes:String? = null

    @DataMember
    open var LockedBy:String? = null

    @DataMember
    open var InstrumentGrade:String? = null

    @DataMember
    open var Serial:String? = null

    @DataMember
    open var Salesperson:String? = null

    @DataMember
    open var WebNotes:String? = null

    @DataMember
    open var Email:String? = null

    @DataMember
    open var Phone:String? = null

    @DataMember
    open var DeliveryDate:Date? = null

    @DataMember
    open var FirstDue:Date? = null

    @DataMember
    open var Accessories:ArrayList<C2BAccessory>? = null

    @DataMember
    open var DownPay:BigDecimal? = null

    @DataMember
    open var MonthlyPay:BigDecimal? = null

    @DataMember
    open var DownMaint:BigDecimal? = null

    @DataMember
    open var MonthlyMaint:BigDecimal? = null

    @DataMember
    open var DownLease:BigDecimal? = null

    @DataMember
    open var MonthlyLease:BigDecimal? = null

    @DataMember
    open var DownTotal:BigDecimal? = null

    @DataMember
    open var Address:String? = null

    @DataMember
    open var Address2:String? = null

    @DataMember
    open var City:String? = null

    @DataMember
    open var State:String? = null

    @DataMember
    open var Zip:String? = null

    @DataMember
    open var Country:String? = null

    @DataMember
    open var InvoiceCreated:Boolean? = null

    @DataMember
    open var ContractCreated:Boolean? = null
}

@DataContract
open class LocationInfo
{
    @DataMember
    open var Id:Long? = null

    @DataMember
    open var Desc:String? = null

    @DataMember
    open var ShortDesc:String? = null

    @DataMember
    open var Region:String? = null

    @DataMember
    open var Latitude:BigDecimal? = null

    @DataMember
    open var Longitude:BigDecimal? = null

    @DataMember
    open var InStorePickup:String? = null

    @DataMember
    open var Active:Boolean? = null

    @DataMember
    open var CashSaleAcct:Int? = null
}

@DataContract
open class C2BAccessory
{
    @DataMember
    open var Id:Long? = null

    @DataMember
    open var Description:String? = null

    @DataMember
    open var Price:BigDecimal? = null

    @DataMember
    open var Type:String? = null

    @DataMember
    open var Sku:String? = null

    @DataMember
    open var Category:Int? = null

    @DataMember
    open var Delivered:Boolean? = null
}

Kotlin C2BGetUnfinishedContractsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json

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

{"UnfinishedContracts":[{"CustomerName":"String","CustomerAcct":0,"StudentName":"String","Ref":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"District":"String","School":"String","Teacher":"String","Instrument":"String","Status":"String","Notes":"String","LockedBy":"String","InstrumentGrade":"String","Serial":"String","Salesperson":"String","WebNotes":"String","Email":"String","Phone":"String","DeliveryDate":"0001-01-01T00:00:00.0000000","FirstDue":"0001-01-01T00:00:00.0000000","Accessories":[{"Id":0,"Description":"String","Price":0,"Type":"String","Sku":"String","Category":0,"Delivered":false}],"DownPay":0,"MonthlyPay":0,"DownMaint":0,"MonthlyMaint":0,"DownLease":0,"MonthlyLease":0,"DownTotal":0,"Address":"String","Address2":"String","City":"String","State":"String","Zip":"String","Country":"String","InvoiceCreated":false,"ContractCreated":false}],"Topic":"String","BaseUrl":"String","Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}