AIM Web Services

InstructorInvoicesRequest

InstructorInvoices
Requires active-e Lesson Scheduling Service

The following routes are available for this service:
GET	/api/InstructorInvoices

**InstructorInvoicesRequest** Parameters:
Name	Parameter	Data Type	Required
InstructorNumber	query	int?	No
DateFrom	query	DateTime?	No
DateTo	query	DateTime?	No
WithBalanceOnly	query	bool	No

**BaseSecureRequest** Parameters:
Name	Parameter	Data Type	Required
Token	Header	string	No
DeviceId	Header	string	No
AppId	Header	string	Yes

**BaseRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ApiKey	header	string	Yes	This is your AIM API Key provided by Tri-Tech
OAuthToken	header	string	No

**InstructorInvoicesResponse** Parameters:
Name	Parameter	Data Type	Required	Description
InstructorInvoices	form	List<InstructorInvoice>	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required	Description
Status	body	BaseResponseResult	No

**BaseResponseResult** Parameters:
Name	Parameter	Data Type	Required
StatusCode	body	string	No
Login	body	string	No
ErrorCode	body	string	No
ErrorDisplayText	body	string	No
ErrorMessage	body	string	No
DomainName	body	string	No
IpAddress	body	string	No

**InstructorInvoice** Parameters:
Name	Parameter	Data Type	Required
Date	form	DateTime	No
InvoiceRef	form	string	No
Location	form	LocationInfo	No
StudentName	form	string	No
Total	form	decimal	No
Balance	form	decimal	No
PaidByStudent	form	bool	No

**LocationInfo** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Desc	form	string	No
ShortDesc	form	string	No
Region	form	string	No
Latitude	form	decimal	No
Longitude	form	decimal	No
InStorePickup	form	string	No
Active	form	bool	No
CashSaleAcct	form	int?	No

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>

AIM Web Services

InstructorInvoicesRequest

InstructorInvoices Requires active-e Lesson Scheduling Service

HTTP + XML

InstructorInvoices
Requires active-e Lesson Scheduling Service