POPLookup XML API Documentation (Last Modified: 3/14/2005 1:13:18 PM)

Basic Concepts
The POPLookup XML API provides a list of POPs for the networks assigned.
The base URL of this API is http://api.cisp.com/POPLookup.XML.asp.
 
Input Variables
Name Description
ClientID Client code identifying the client information to access
AreaCode Area code to filter the POP list to
City City to filter the POP list to
State State to filter the POP list to
Country Country to filter the POP list to
NetworkLetter Letter of the network to filter the POP list to
Page Page number to display (pages are split with one network per page - pass 0 or nothing for all pages)
Name Min Max Type Required
ClientID 4 4 String True
AreaCode 0 3 String False
City 0 128 String False
State 0 128 String False
Country 0 128 String False
NetworkLetter 0 1 String False
Page 0 4 Integer 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.
POP Output Variables
Name Description Type
NETWORK_LETTER Network letter for this POP String
NUMBER 7 digit phone number for this POP String
AREA_CODE Area code for this POP String
CITY City for this POP String
STATE State for this POP String
COUNTRY Country for this POP String
MAX_HOURS Maximum allowed hours of usage on the network of this POP String
REALM Realm value that needs to be appended to the username for the network of this POP String
Pages Output Variables
Name Description Type
CURRENT Current page number Integer
NUMBER Total number of pages (some pages may contain no POPs) Integer
 
Sample Output 
<?xml version="1.0" ?>
<ICOP>
- <POP NETWORK_LETTER="T" NUMBER="1111111" AREA_CODE="419" CITY="Fostoria" STATE="OH" COUNTRY="USA" MAX_HOURS="200" REALM="test-t.net" />
- <POP NETWORK_LETTER="T" NUMBER="2222222" AREA_CODE="419" CITY="Toledo" STATE="OH" COUNTRY="USA" MAX_HOURS="200" REALM="test-t.net" />
- <POP NETWORK_LETTER="E" NUMBER="3333333" AREA_CODE="419" CITY="Mansfield" STATE="OH" COUNTRY="USA" MAX_HOURS="150" REALM="test-e.net" />
- <POP NETWORK_LETTER="E" NUMBER="4444444" AREA_CODE="419" CITY="Sandusky" STATE="OH" COUNTRY="USA" MAX_HOURS="150" REALM="test-e.net" />
- <POP NETWORK_LETTER="E" NUMBER="5555555" AREA_CODE="419" CITY="Toledo" STATE="OH" COUNTRY="USA" MAX_HOURS="150" REALM="test-e.net" />
- <PAGES CURRENT="0" NUMBER="2" />
</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.com/POPLookup.XML.asp?ClientID=DEMO&Page=0&AreaCode=419"

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

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