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
namespace AIM

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 LocationInfo() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

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

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

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BAccessory() = 
        [<DataMember>]
        member val Id:Int64 = new Int64() with get,set

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

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

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type UnfinishedContract() = 
        [<DataMember>]
        member val CustomerName:String = null with get,set

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

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

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

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

        [<DataMember>]
        member val Location:LocationInfo = null with get,set

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

        [<DataMember>]
        member val Accessories:ResizeArray<C2BAccessory> = new ResizeArray<C2BAccessory>() with get,set

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

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

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

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

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

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

        [<DataMember>]
        member val DownTotal:Decimal = new Decimal() 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 State:String = null with get,set

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

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

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

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

    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BGetUnfinishedContractsResponse() = 
        inherit BaseResponse()
        [<DataMember>]
        member val UnfinishedContracts:ResizeArray<UnfinishedContract> = new ResizeArray<UnfinishedContract>() with get,set

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

        [<DataMember>]
        member val BaseUrl:String = null 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

        [<DataMember>]
        [<ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")>]
        member val OAuthToken:String = null with get,set

    [<DataContract>]
    [<AllowNullLiteral>]
    type BaseSecureRequest() = 
        inherit BaseRequest()
        ///<summary>
        ///
        ///</summary>
        [<DataMember>]
        [<ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")>]
        member val Token:String = null with get,set

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

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

    ///<summary>
    ///C2BGetUnfinishedContractsRequires active-e Contracts Service.
    ///</summary>
    [<DataContract>]
    [<AllowNullLiteral>]
    type C2BGetUnfinishedContractsRequest() = 
        inherit BaseSecureRequest()
        [<DataMember>]
        member val Type:String = null with get,set

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

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

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

        [<DataMember>]
        member val IncludeContractsEnteredByOtherUsers:Boolean = new Boolean() 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 TeacherId:Nullable<Int64> = new Nullable<Int64>() with get,set

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

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

F# 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"}}