Deployment Guide
276 | Administration Dell Networking W- ClearPass Guest 6.1 | Deployment Guide
Audience
This API is intended for developers of applications that must interoperate with a ClearPass Guest-based visitor
management solution. Solution developers are assumed to be familiar with HTTP-based Web services and the
associated concepts and technologies related to these services, including Extensible Markup Language (XML), XML
Schemas, Web Service Definition Language (WSDL), and the Simple Object Access Protocol (SOAP).
Many software development tools provide assistance with Web services integration. While this document cannot
cover all possible integration methods, examples are given using Microsoft Visual C# 2008.
API Documentation Overview
l "About the SOAPAPI" on page 276 provides a high-level overview of the API, explaining what it is and how to
use it.
l "Integration Example" on page 281 provides an integration example to demonstrate the usage of SOAP web
services.
l "API Documentation" on page 285 contains a detailed list of the available API calls, including documentation
about each method defined by the web services.
Disclaimer
The topics of network design, security architectures, and visitor access are complex subjects, and no single document
can hope to cover all of the possible combinations of network equipment, network design, deployment requirements,
and device configurations, nor can all the possible security implications for a particular recommendation be covered.
Therefore, while you read this document, it is best to consider it as a guide to developing your own understanding of
the network design topics covered, and as a basis for further investigation.
About the SOAPAPI
The ClearPass Guest SOAP API provides direct access to the underlying functionality of Dell Networking W-
ClearPass Guest. Developers wishing to provide integrated applications can make use of this API to
programmatically perform actions that would otherwise require manual operation of the user interface.
Architecture Overview
The ClearPass Guest software is built using multiple layers: