| POST, GET | /api/C2BGetInstrumentDetail |
|---|
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 C2BPlanCodeGeneric() =
[<DataMember>]
member val Code:String = null with get,set
[<DataMember>]
member val Name:String = null with get,set
[<DataMember>]
member val Months:Int32 = new Int32() with get,set
[<DataMember>]
member val Topic:String = null with get,set
[<DataMember>]
member val Url:String = null with get,set
[<DataMember>]
member val FinalTopic:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BDeliveryInfo() =
[<DataMember>]
member val FirstDelivery:DateTime = new DateTime() with get,set
[<DataMember>]
member val DeliveryTime:DateTime = new DateTime() with get,set
[<DataMember>]
member val DeliveryThreshold:Int32 = new Int32() with get,set
[<DataMember>]
member val SundayDelivery:Boolean = new Boolean() with get,set
[<DataMember>]
member val MondayDelivery:Boolean = new Boolean() with get,set
[<DataMember>]
member val TuesdayDelivery:Boolean = new Boolean() with get,set
[<DataMember>]
member val WednesdayDelivery:Boolean = new Boolean() with get,set
[<DataMember>]
member val ThursdayDelivery:Boolean = new Boolean() with get,set
[<DataMember>]
member val FridayDelivery:Boolean = new Boolean() with get,set
[<DataMember>]
member val SaturdayDelivery:Boolean = new Boolean() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BTeacherGeneric() =
[<DataMember>]
member val TeacherName:String = null with get,set
[<DataMember>]
member val SchoolName:String = null with get,set
[<DataMember>]
member val DistrictName:String = null with get,set
[<DataMember>]
member val Topic:String = null with get,set
[<DataMember>]
member val Id:Int64 = new Int64() with get,set
[<DataMember>]
member val DeliveryInfo:C2BDeliveryInfo = null with get,set
[<DataMember>]
member val AIMSchoolId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BSchoolGeneric() =
[<DataMember>]
member val SchoolName:String = null with get,set
[<DataMember>]
member val DistrictName:String = null with get,set
[<DataMember>]
member val TeacherCount:Int32 = new Int32() with get,set
[<DataMember>]
member val Topic:String = null with get,set
[<DataMember>]
member val Id:Int64 = new Int64() with get,set
[<DataMember>]
member val DeliveryInfo:C2BDeliveryInfo = null with get,set
[<DataMember>]
member val AIMSchoolId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BDistrictGeneric() =
[<DataMember>]
member val DistrictName:String = null with get,set
[<DataMember>]
member val SchoolCount:Int32 = new Int32() with get,set
[<DataMember>]
member val TeacherCount:Int32 = new Int32() with get,set
[<DataMember>]
member val Topic:String = null with get,set
[<DataMember>]
member val Id:Int64 = new Int64() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BGradeGeneric() =
[<DataMember>]
member val Level:Int32 = new Int32() with get,set
[<DataMember>]
member val Grade:String = null with get,set
[<DataMember>]
member val DownPay:Decimal = new Decimal() with get,set
[<DataMember>]
member val DownMaint:Decimal = new Decimal() with get,set
[<DataMember>]
member val MoPay:Decimal = new Decimal() with get,set
[<DataMember>]
member val MoMaint:Decimal = new Decimal() with get,set
[<DataMember>]
member val Id:Int64 = new Int64() with get,set
[<DataMember>]
member val OutOfStock:Boolean = new Boolean() with get,set
[<DataMember>]
member val RentPrice:Decimal = new Decimal() with get,set
[<DataMember>]
member val CashPrice:Decimal = new Decimal() with get,set
[<DataMember>]
member val DownPayTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val DownMaintTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val MoPayTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val MoMaintTax:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val RentPricePlusTax:Decimal = new Decimal() with get,set
[<DataMember>]
member val RentPricePlusTaxLessDownpay:Decimal = new Decimal() with get,set
[<DataMember>]
member val Months:Int32 = new Int32() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BAccessoryGeneric() =
[<DataMember>]
member val AccessoryDesc:String = null with get,set
[<DataMember>]
member val Price:Decimal = new Decimal() with get,set
[<DataMember>]
member val Required:Boolean = new Boolean() with get,set
[<DataMember>]
member val Default:Boolean = new Boolean() with get,set
[<DataMember>]
member val RequiresLocation:Boolean = new Boolean() with get,set
[<DataMember>]
member val Type:String = null with get,set
[<DataMember>]
member val Topic:String = null with get,set
[<DataMember>]
member val Id:Int64 = new Int64() with get,set
[<DataMember>]
member val DisplayOrder:Int32 = new Int32() with get,set
[<DataMember>]
member val Sku:String = null with get,set
[<DataMember>]
member val TaxAmount:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val CatNum:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BInstrumentGeneric() =
[<DataMember>]
member val InstrumentName:String = null with get,set
[<DataMember>]
member val Sku:String = null with get,set
[<DataMember>]
member val Topic:String = null with get,set
[<DataMember>]
member val Image:String = null with get,set
[<DataMember>]
member val Level:Int32 = new Int32() with get,set
[<DataMember>]
member val RentPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val CashPrice:Nullable<Decimal> = new Nullable<Decimal>() with get,set
[<DataMember>]
member val Token:String = null with get,set
[<DataMember>]
member val InstrumentId:Int64 = new Int64() with get,set
[<DataMember>]
member val InstrumentTeacherId:Int64 = new Int64() with get,set
[<DataMember>]
member val GradeList:ResizeArray<C2BGradeGeneric> = new ResizeArray<C2BGradeGeneric>() with get,set
[<DataMember>]
member val HasGrades:Boolean = new Boolean() with get,set
[<DataMember>]
member val DisplayOrder:Int32 = new Int32() with get,set
[<DataMember>]
member val AccessoryList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set
[<DataMember>]
member val DeliveryList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set
[<DataMember>]
member val MaintenanceList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BInstrumentDetailGeneric() =
[<DataMember>]
member val PlanCode:C2BPlanCodeGeneric = null with get,set
[<DataMember>]
member val Teacher:C2BTeacherGeneric = null with get,set
[<DataMember>]
member val School:C2BSchoolGeneric = null with get,set
[<DataMember>]
member val DeliveryDate:String = null with get,set
[<DataMember>]
member val SalesPerson:String = null with get,set
[<DataMember>]
member val District:C2BDistrictGeneric = null with get,set
[<DataMember>]
member val Instrument:C2BInstrumentGeneric = null with get,set
[<DataMember>]
member val Grade:C2BGradeGeneric = null with get,set
[<DataMember>]
member val AccessoryList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set
[<DataMember>]
member val DeliveryList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set
[<DataMember>]
member val MaintenanceList:ResizeArray<C2BAccessoryGeneric> = new ResizeArray<C2BAccessoryGeneric>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type MobileLayout() =
[<DataMember>]
member val title:String = null with get,set
[<DataMember>]
member val returnurl:String = null with get,set
[<DataMember>]
member val sections:Section[] = [||] with get,set
[<DataContract>]
[<AllowNullLiteral>]
type C2BGetInstrumentDetailResponse() =
inherit BaseResponse()
[<DataMember>]
member val InstrumentDetails:C2BInstrumentDetailGeneric = null with get,set
[<DataMember>]
member val MobileLayout:MobileLayout = 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>
///C2BGetInstrumentDetailRequires active-e Contracts Service.
///</summary>
[<DataContract>]
[<AllowNullLiteral>]
type C2BGetInstrumentDetailRequest() =
inherit BaseSecureRequest()
///<summary>
///ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="ID of the Teacher/Instrument record. Either this *or* TeacherId + InstrumentId must be sent.", Format="int64", Name="RsiPk", ParameterType="query")>]
member val RsiPk:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="ID of the Teacher record. Either this+InstrumentID *or* RsiPk must be sent.", Format="int64", Name="TeacherId", ParameterType="query")>]
member val TeacherId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="ID of the Instrument record. Either this+TeacherID *or* RsiPk must be sent.", Format="int64", Name="InstrumentId", ParameterType="query")>]
member val InstrumentId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///ID of the Rate to be used. This is required.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="ID of the Rate to be used. This is required.", Format="int64", IsRequired=true, Name="RateId", ParameterType="query")>]
member val RateId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///If 'Y', then Mobile Layout will be returned.
///</summary>
[<DataMember>]
[<ApiMember(DataType="string", Description="If 'Y', then Mobile Layout will be returned.", Name="IncludeMobileLayout", ParameterType="query")>]
member val IncludeMobileLayout:String = null with get,set
///<summary>
///ID of the Delivery option to be used.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="ID of the Delivery option to be used.", Format="int64", IsRequired=true, Name="DeliveryId", ParameterType="query")>]
member val DeliveryId:Nullable<Int64> = new Nullable<Int64>() with get,set
///<summary>
///ID of the Location. Used for Location required Delivery options.
///</summary>
[<DataMember>]
[<ApiMember(DataType="integer", Description="ID of the Location. Used for Location required Delivery options.", Format="int64", IsRequired=true, Name="LocationId", ParameterType="query")>]
member val LocationId:Nullable<Int64> = new Nullable<Int64>() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Section() =
[<DataMember>]
member val header:String = null with get,set
[<DataMember>]
member val id:String = null with get,set
[<DataMember>]
member val margin:String = null with get,set
[<DataMember>]
member val elements:Element[] = [||] with get,set
[<DataContract>]
[<AllowNullLiteral>]
type LicenseMap() =
[<DataMember>]
member val name:String = null with get,set
[<DataMember>]
member val value:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type Element() =
[<DataMember>]
member val type:String = null with get,set
[<DataMember>]
member val label:String = null with get,set
[<DataMember>]
member val id:String = null with get,set
[<DataMember>]
member val fontsize:String = null with get,set
[<DataMember>]
member val margin:String = null with get,set
[<DataMember>]
member val backgroundcolor:String = null with get,set
[<DataMember>]
member val textcolor:String = null with get,set
[<DataMember>]
member val height:String = null with get,set
[<DataMember>]
member val width:String = null with get,set
[<DataMember>]
member val value:String = null with get,set
[<DataMember>]
member val addvalue:Boolean = new Boolean() with get,set
[<DataMember>]
member val values:String[] = [||] with get,set
[<DataMember>]
member val textalign:String = null with get,set
[<DataMember>]
member val required:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember>]
member val placeholder:String = null with get,set
[<DataMember>]
member val fontbold:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember>]
member val selected:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember>]
member val disabled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember>]
member val totalamount:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember>]
member val elements:IEnumerable<Element> = null with get,set
[<DataMember>]
member val map:IEnumerable<LicenseMap> = null with get,set
F# C2BGetInstrumentDetailRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/C2BGetInstrumentDetail HTTP/1.1
Host: active-ewebservice.biz
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<C2BGetInstrumentDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AIM.WebService">
<ApiKey>String</ApiKey>
<OAuthToken>String</OAuthToken>
<AppId>String</AppId>
<DeviceId>String</DeviceId>
<Token>String</Token>
<DeliveryId>0</DeliveryId>
<IncludeMobileLayout>String</IncludeMobileLayout>
<InstrumentId>0</InstrumentId>
<LocationId>0</LocationId>
<RateId>0</RateId>
<RsiPk>0</RsiPk>
<TeacherId>0</TeacherId>
</C2BGetInstrumentDetailRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<C2BGetInstrumentDetailResponse 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>
<InstrumentDetails xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM" i:nil="true" />
<MobileLayout xmlns:d2p1="http://schemas.datacontract.org/2004/07/AIM.BL.Core.ExternalAPIs.MobileRentals">
<d2p1:returnurl>String</d2p1:returnurl>
<d2p1:sections>
<d2p1:MobileLayout.Section>
<d2p1:elements>
<d2p1:MobileLayout.Element>
<d2p1:addvalue>false</d2p1:addvalue>
<d2p1:backgroundcolor>String</d2p1:backgroundcolor>
<d2p1:disabled>false</d2p1:disabled>
<d2p1:elements i:nil="true" />
<d2p1:fontbold>false</d2p1:fontbold>
<d2p1:fontsize>String</d2p1:fontsize>
<d2p1:height>String</d2p1:height>
<d2p1:id>String</d2p1:id>
<d2p1:label>String</d2p1:label>
<d2p1:map i:nil="true" />
<d2p1:margin>String</d2p1:margin>
<d2p1:placeholder>String</d2p1:placeholder>
<d2p1:required>false</d2p1:required>
<d2p1:selected>false</d2p1:selected>
<d2p1:textalign>String</d2p1:textalign>
<d2p1:textcolor>String</d2p1:textcolor>
<d2p1:totalamount>false</d2p1:totalamount>
<d2p1:type>String</d2p1:type>
<d2p1:value>String</d2p1:value>
<d2p1:values xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</d2p1:values>
<d2p1:width>String</d2p1:width>
</d2p1:MobileLayout.Element>
</d2p1:elements>
<d2p1:header>String</d2p1:header>
<d2p1:id>String</d2p1:id>
<d2p1:margin>String</d2p1:margin>
</d2p1:MobileLayout.Section>
</d2p1:sections>
<d2p1:title>String</d2p1:title>
</MobileLayout>
</C2BGetInstrumentDetailResponse>