ProxyAccountUsage XML API Documentation (Last Modified: 10/14/2005 3:54:10 PM GMT)

Basic Concepts
The ProxyAccountUsage XML API provides a list of users' account usage for a proxy client.
The base URL of this API is http://api.cisp.com/ProxyAccountUsage.XML.asp.
 
Input Variables
Name Description
ClientID Client code identifying the client information to access
UserName Username to filter the usage list to (use "*" as a wild card operator)
Network Network letter to filter the usage list to
Online Online status to filter the usage list to ("0" = Offline, "1" = Online)
Comparator Comparator to filter the usage list to (operators used, "=", "<", ">", "<=", ">=")
HoursUsed Hours used to filter the usage list to
Abuse Abuse status to filter the usage list to ("0" = No, "1" = Yes)
LastChange Last changed date to filter the usage list to
Name Min Max Type Required
ClientID 4 4 String True
UserName 0 256 String False
Network 0 1 String False
Online 0 1 Integer False
Comparator 0 256 String False
HoursUsed 0 256 String False
Abuse 0 1 Integer False
LastChange 0 256 String False
 
Return Document
The return value is a standard XML document with CISP as the root node.
Each section of the output variables listed below is a child node to the CISP node. Each parameter within that section is an attribute to that section's node.
Account Usage Output Variables
Name Description Type
USERNAME Username for this account String
NETWORK Network letter and name for this account String
TIMEUSED Time used for this account Numeric
ABUSE Abuse status for this account Boolean
ONLINE Online status for this account Boolean
LASTCHANGESTATUS Last changed status date and time for this account DateTime
TIMEONLINE Time online for this account Numeric
 
Sample Output 
<?xml version="1.0" ?>
<CISP>
- <ACCOUNTUSAGE USERNAME="johndoe@mydomain.com" NETWORK="L - Level 3 Communications" TIMEUSED="195" ABUSE="0" ONLINE="0" LASTCHANGESTATUS="9/3/2005 5:01:19 PM" TIMEUSED="123531" />
- <ACCOUNTUSAGE USERNAME="janedoe@mydomain.com" NETWORK="C - Megapop" TIMEUSED="293.428055555556" ABUSE="0" ONLINE="1" LASTCHANGESTATUS="10/14/2005 5:38:36 PM" TIMEUSED="3930" />
- <ACCOUNTUSAGE USERNAME="joeschmo@mydomain.com" NETWORK="Q - Qwest" TIMEUSED="185.215" ABUSE="1" ONLINE="0" LASTCHANGESTATUS="10/11/2005 10:16:16 AM" TIMEUSED="97437" />
- <ACCOUNTUSAGE USERNAME="janeschmo@mydomain.com" NETWORK="G - UUNet" TIMEUSED="156.54" ABUSE="0" ONLINE="1" LASTCHANGESTATUS="10/1/2005 3:35:35 AM" TIMEUSED="114113" />
</CISP>
 
Sample ASP Code 
<%
Option Explicit
Dim objXML, objXSL

' Create the MSXML DOMDocument object for the xml document output of the API
Set objXML = Server.CreateObject("MSXML2.DOMDocument")
objXML.async = False
objXML.setProperty "ServerHTTPRequest", True
objXML.load "http://api.cisp.com/ProxyAccountUsage.XML.asp?ClientID=DEMO&UserName=&Network=&Online=&Comparator=&HoursUsed=&Abuse=&LastChange="

' Create the MSXML DOMDocument object for the xsl stylesheet to transform the xml
Set objXSL = Server.CreateObject("MSXML2.DOMDocument")
objXSL.async = False
objXSL.load Server.MapPath("ProxyAccountUsage.xsl")

' Transform the xml with the xsl stylesheet and write the result HTML
Response.Write objXML.transformNode(objXSL)
%>