AIM Web Services

<back to all web services

InstructorInvoicesRequest

InstructorInvoices
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET/api/InstructorInvoices
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


/**
* InstructorInvoicesRequires active-e Lesson Scheduling Service
*/
@DataContract
open class InstructorInvoicesRequest : BaseSecureRequest()
{
    @DataMember
    open var InstructorNumber:Int? = null

    @DataMember
    open var DateFrom:Date? = null

    @DataMember
    open var DateTo:Date? = null

    @DataMember
    open var WithBalanceOnly:Boolean? = 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 InstructorInvoicesResponse : BaseResponse()
{
    @DataMember
    open var InstructorInvoices:ArrayList<InstructorInvoice>? = 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 InstructorInvoice
{
    @DataMember
    open var Date:Date? = null

    @DataMember
    open var InvoiceRef:String? = null

    @DataMember
    open var Location:LocationInfo? = null

    @DataMember
    open var StudentName:String? = null

    @DataMember
    open var Total:BigDecimal? = null

    @DataMember
    open var Balance:BigDecimal? = null

    @DataMember
    open var PaidByStudent: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
}

Kotlin InstructorInvoicesRequest 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/InstructorInvoices HTTP/1.1 
Host: active-ewebservice.biz 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
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"}}