| GET | /api/InstructorInvoices |
|---|
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 InstructorInvoice() =
[<DataMember>]
member val Date:DateTime = new DateTime() with get,set
[<DataMember>]
member val InvoiceRef:String = null with get,set
[<DataMember>]
member val Location:LocationInfo = null with get,set
[<DataMember>]
member val StudentName:String = null with get,set
[<DataMember>]
member val Total:Decimal = new Decimal() with get,set
[<DataMember>]
member val Balance:Decimal = new Decimal() with get,set
[<DataMember>]
member val PaidByStudent:Boolean = new Boolean() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type InstructorInvoicesResponse() =
inherit BaseResponse()
[<DataMember>]
member val InstructorInvoices:ResizeArray<InstructorInvoice> = new ResizeArray<InstructorInvoice>() 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>
///InstructorInvoicesRequires active-e Lesson Scheduling Service
///</summary>
[<DataContract>]
[<AllowNullLiteral>]
type InstructorInvoicesRequest() =
inherit BaseSecureRequest()
[<DataMember>]
member val InstructorNumber:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember>]
member val DateFrom:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember>]
member val DateTo:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember>]
member val WithBalanceOnly:Boolean = new Boolean() with get,set
F# InstructorInvoicesRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /api/InstructorInvoices HTTP/1.1 Host: active-ewebservice.biz Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"InstructorInvoices":[{"InvoiceRef":"String","Location":{"Id":0,"Desc":"String","ShortDesc":"String","Region":"String","Latitude":0,"Longitude":0,"InStorePickup":"String","Active":false,"CashSaleAcct":0},"StudentName":"String","Total":0,"Balance":0,"PaidByStudent":false}],"Status":{"StatusCode":"String","Login":"String","ErrorCode":"String","ErrorDisplayText":"String","ErrorMessage":"String","DomainName":"String","IpAddress":"String"}}