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 net.servicestack.client.*;

public class dtos
{

    /**
    * InstructorInvoicesRequires active-e Lesson Scheduling Service
    */
    @DataContract
    public static class InstructorInvoicesRequest extends BaseSecureRequest
    {
        @DataMember
        public Integer InstructorNumber = null;

        @DataMember
        public Date DateFrom = null;

        @DataMember
        public Date DateTo = null;

        @DataMember
        public Boolean WithBalanceOnly = null;
        
        public Integer getInstructorNumber() { return InstructorNumber; }
        public InstructorInvoicesRequest setInstructorNumber(Integer value) { this.InstructorNumber = value; return this; }
        public Date getDateFrom() { return DateFrom; }
        public InstructorInvoicesRequest setDateFrom(Date value) { this.DateFrom = value; return this; }
        public Date getDateTo() { return DateTo; }
        public InstructorInvoicesRequest setDateTo(Date value) { this.DateTo = value; return this; }
        public Boolean isWithBalanceOnly() { return WithBalanceOnly; }
        public InstructorInvoicesRequest setWithBalanceOnly(Boolean value) { this.WithBalanceOnly = value; return this; }
    }

    @DataContract
    public static class BaseSecureRequest extends BaseRequest
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Token", ParameterType="Header")
        public String Token = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="DeviceId", ParameterType="Header")
        public String DeviceId = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", IsRequired=true, Name="AppId", ParameterType="Header")
        public String AppId = null;
        
        public String getToken() { return Token; }
        public BaseSecureRequest setToken(String value) { this.Token = value; return this; }
        public String getDeviceId() { return DeviceId; }
        public BaseSecureRequest setDeviceId(String value) { this.DeviceId = value; return this; }
        public String getAppId() { return AppId; }
        public BaseSecureRequest setAppId(String value) { this.AppId = value; return this; }
    }

    @DataContract
    public static 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")
        public String ApiKey = null;

        @DataMember
        @ApiMember(DataType="string", Name="OAuthToken", ParameterType="header")
        public String OAuthToken = null;
        
        public String getApiKey() { return ApiKey; }
        public BaseRequest setApiKey(String value) { this.ApiKey = value; return this; }
        public String getOAuthToken() { return OAuthToken; }
        public BaseRequest setOAuthToken(String value) { this.OAuthToken = value; return this; }
    }

    @DataContract
    public static class InstructorInvoicesResponse extends BaseResponse
    {
        @DataMember
        public ArrayList<InstructorInvoice> InstructorInvoices = null;
        
        public ArrayList<InstructorInvoice> getInstructorInvoices() { return InstructorInvoices; }
        public InstructorInvoicesResponse setInstructorInvoices(ArrayList<InstructorInvoice> value) { this.InstructorInvoices = value; return this; }
    }

    @DataContract
    public static class BaseResponse
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="BaseResponseResult", Description="", Name="Status", ParameterType="body")
        public BaseResponseResult Status = null;
        
        public BaseResponseResult getStatus() { return Status; }
        public BaseResponse setStatus(BaseResponseResult value) { this.Status = value; return this; }
    }

    @DataContract
    public static class BaseResponseResult
    {
        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="StatusCode", ParameterType="body")
        public String StatusCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="Login", ParameterType="body")
        public String Login = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorCode", ParameterType="body")
        public String ErrorCode = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorDisplayText", ParameterType="body")
        public String ErrorDisplayText = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", Name="ErrorMessage", ParameterType="body")
        public String ErrorMessage = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="DomainName", ParameterType="body")
        public String DomainName = null;

        /**
        * 
        */
        @DataMember
        @ApiMember(DataType="string", Description="", ExcludeInSchema=true, Name="IPAddress", ParameterType="body")
        public String IpAddress = null;
        
        public String getStatusCode() { return StatusCode; }
        public BaseResponseResult setStatusCode(String value) { this.StatusCode = value; return this; }
        public String getLogin() { return Login; }
        public BaseResponseResult setLogin(String value) { this.Login = value; return this; }
        public String getErrorCode() { return ErrorCode; }
        public BaseResponseResult setErrorCode(String value) { this.ErrorCode = value; return this; }
        public String getErrorDisplayText() { return ErrorDisplayText; }
        public BaseResponseResult setErrorDisplayText(String value) { this.ErrorDisplayText = value; return this; }
        public String getErrorMessage() { return ErrorMessage; }
        public BaseResponseResult setErrorMessage(String value) { this.ErrorMessage = value; return this; }
        public String getDomainName() { return DomainName; }
        public BaseResponseResult setDomainName(String value) { this.DomainName = value; return this; }
        public String getIpAddress() { return IpAddress; }
        public BaseResponseResult setIpAddress(String value) { this.IpAddress = value; return this; }
    }

    @DataContract
    public static class InstructorInvoice
    {
        @DataMember
        public Date Date = null;

        @DataMember
        public String InvoiceRef = null;

        @DataMember
        public LocationInfo Location = null;

        @DataMember
        public String StudentName = null;

        @DataMember
        public BigDecimal Total = null;

        @DataMember
        public BigDecimal Balance = null;

        @DataMember
        public Boolean PaidByStudent = null;
        
        public Date getDate() { return Date; }
        public InstructorInvoice setDate(Date value) { this.Date = value; return this; }
        public String getInvoiceRef() { return InvoiceRef; }
        public InstructorInvoice setInvoiceRef(String value) { this.InvoiceRef = value; return this; }
        public LocationInfo getLocation() { return Location; }
        public InstructorInvoice setLocation(LocationInfo value) { this.Location = value; return this; }
        public String getStudentName() { return StudentName; }
        public InstructorInvoice setStudentName(String value) { this.StudentName = value; return this; }
        public BigDecimal getTotal() { return Total; }
        public InstructorInvoice setTotal(BigDecimal value) { this.Total = value; return this; }
        public BigDecimal getBalance() { return Balance; }
        public InstructorInvoice setBalance(BigDecimal value) { this.Balance = value; return this; }
        public Boolean isPaidByStudent() { return PaidByStudent; }
        public InstructorInvoice setPaidByStudent(Boolean value) { this.PaidByStudent = value; return this; }
    }

    @DataContract
    public static class LocationInfo
    {
        @DataMember
        public Long Id = null;

        @DataMember
        public String Desc = null;

        @DataMember
        public String ShortDesc = null;

        @DataMember
        public String Region = null;

        @DataMember
        public BigDecimal Latitude = null;

        @DataMember
        public BigDecimal Longitude = null;

        @DataMember
        public String InStorePickup = null;

        @DataMember
        public Boolean Active = null;

        @DataMember
        public Integer CashSaleAcct = null;
        
        public Long getId() { return Id; }
        public LocationInfo setId(Long value) { this.Id = value; return this; }
        public String getDesc() { return Desc; }
        public LocationInfo setDesc(String value) { this.Desc = value; return this; }
        public String getShortDesc() { return ShortDesc; }
        public LocationInfo setShortDesc(String value) { this.ShortDesc = value; return this; }
        public String getRegion() { return Region; }
        public LocationInfo setRegion(String value) { this.Region = value; return this; }
        public BigDecimal getLatitude() { return Latitude; }
        public LocationInfo setLatitude(BigDecimal value) { this.Latitude = value; return this; }
        public BigDecimal getLongitude() { return Longitude; }
        public LocationInfo setLongitude(BigDecimal value) { this.Longitude = value; return this; }
        public String getInStorePickup() { return InStorePickup; }
        public LocationInfo setInStorePickup(String value) { this.InStorePickup = value; return this; }
        public Boolean isActive() { return Active; }
        public LocationInfo setActive(Boolean value) { this.Active = value; return this; }
        public Integer getCashSaleAcct() { return CashSaleAcct; }
        public LocationInfo setCashSaleAcct(Integer value) { this.CashSaleAcct = value; return this; }
    }

}

Java InstructorInvoicesRequest DTOs

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

HTTP + XML

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

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

<InstructorInvoicesResponse 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>
  <InstructorInvoices>
    <InstructorInvoice>
      <Balance>0</Balance>
      <Date>0001-01-01T00:00:00</Date>
      <InvoiceRef>String</InvoiceRef>
      <Location xmlns:d4p1="http://schemas.datacontract.org/2004/07/AIM">
        <d4p1:Active>false</d4p1:Active>
        <d4p1:CashSaleAcct>0</d4p1:CashSaleAcct>
        <d4p1:Desc>String</d4p1:Desc>
        <d4p1:Id>0</d4p1:Id>
        <d4p1:InStorePickup>String</d4p1:InStorePickup>
        <d4p1:Latitude>0</d4p1:Latitude>
        <d4p1:Longitude>0</d4p1:Longitude>
        <d4p1:Region>String</d4p1:Region>
        <d4p1:ShortDesc>String</d4p1:ShortDesc>
      </Location>
      <PaidByStudent>false</PaidByStudent>
      <StudentName>String</StudentName>
      <Total>0</Total>
    </InstructorInvoice>
  </InstructorInvoices>
</InstructorInvoicesResponse>