ServicePlan XML API Documentation (Last Modified: 9/7/2001 4:38:04 PM)

Basic Concepts
The ServicePlan XML API provides a list of Service Plans.
The base URL of this API is http://api.cisp.com/ServicePlan.XML.asp.
 
Input Variables
Name Description
ClientID Client code identifying the client information to access
ID ID of the service plan
Name Min Max Type Required
ClientID 4 4 String True
ID 1 3 Long False
 
Return Document
The return value is a standard XML document with ICOP as the root node.
Each section of the output variables listed below is a child node to the ICOP node. Each parameter within that section is an attribute to that section's node.
Service Plan Output Variables
Name Description Type
HELP Text for help hints String
ID ID of the service plan Long
LABEL Text label for the service plan String
MIN_SERVICE_PERIOD Minimum allowed service period Long
Service Plan Detail Output Variables
Name Description Type
DESCRIPTION Text for the description of the detail String
HELP Text for help hints String
ID ID of the service plan detail Long
KEYWORD Short keyword describing detail String
LABEL Text label for the detail String
NUMBER_ON_SIGNUP Number of times this detail should be displayed on signup Long
NUMBER_TOTAL Number of times this detail can be signed up for Long
Service Plan Detail Item Output Variables
Name Description Type
DESCRIPTION Text for the description of the item String
EXAMPLE Example value for the item String
HELP Text for help hints String
ID ID of the service plan detail item Long
KEYWORD Short keyword describing item String
LABEL Text label for the item String
MAX_SIZE Maximum length of the value for the item Long
MIN_SIZE Minimum length of the value for the item Long
Service Plan Detail Item Visual Format Output Variables
Name Description Type
ID ID of the service plan detail item visual format Long
TYPE Text for the type of input this item should be displayed in String
Service Plan Detail Item Option Output Variables
Name Description Type
LABEL Text label for the option String
VALUE Value for the service plan detail item option String
Service Plan Fee Output Variables
Name Description Type
AMOUNT Amount to be charged for the fee Double
PERIOD Number of months the fee applies to Long
Service Plan Fee Unit Type Output Variables
Name Description Type
ID ID of the service plan fee unit type Long
LABEL Text label for the unit type String
 
Sample Output 
<?xml version="1.0" ?>
<ICOP>
- <SERVICE_PLAN HELP="Standard Dialup Help" ID="1" LABEL="Standard Dialup"
    MIN_SERVICE_PERIOD="1">
  - <DETAIL DESCRIPTION="Dialin account"
      HELP="Dialin account allows you to connect to Internet" ID="1" KEYWORD="Dialin"
      LABEL="Dialin account" NUMBER_ON_SIGNUP="1" NUMBER_TOTAL="1">
    - <ITEM DESCRIPTION="User name for dialup accounts" EXAMPLE="johnd"
        HELP="This is help for User Name item" ID="1" KEYWORD="UserName"
        LABEL="User name" MAX_SIZE="122" MIN_SIZE="2">
      - <VISUAL_FORMAT ID="0" TYPE="Text Box" />
      </ITEM>
    - <ITEM DESCRIPTION="Password" EXAMPLE="jpassd" HELP="" ID="4" KEYWORD="Password"
        LABEL="Password" MAX_SIZE="8" MIN_SIZE="6">
      - <VISUAL_FORMAT ID="0" TYPE="Text Box" />
      </ITEM>
    - <ITEM DESCRIPTION="Dialup Network" EXAMPLE="Q" HELP="" ID="1000"
        KEYWORD="Network" LABEL="Network" MAX_SIZE="2" MIN_SIZE="1">
      - <VISUAL_FORMAT ID="2" TYPE="Select Box" />
      - <OPTION LABEL="MegaPOP" VALUE="C" />
      - <OPTION LABEL="UUNet" VALUE="G" />
      - <OPTION LABEL="Quest" VALUE="Q" />
      </ITEM>
    </DETAIL>
  - <FEE AMOUNT="10" PERIOD="1">
    - <UNIT_TYPE ID="1" LABEL="Setup" />
    </FEE>
  - <FEE AMOUNT="12" PERIOD="1">
    - <UNIT_TYPE ID="2" LABEL="Recurring" />
    </FEE>
  </SERVICE_PLAN>
</ICOP>
 
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.cc/ServicePlan.XML.asp?ClientID=DEMO&ID=1"

' 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("ServicePlan.xsl")

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