Preface

This preface describes the audience for the API User Guide for the Cisco TelePresence Exchange System Release 1.0, and the document organization and conventions.

Audience

This guide is a technical resource for application developers who build custom applications that use the Cisco TelePresence Exchange System Application Programming Interface (API).

You should have an advanced level of understanding of web services technology and be familiar with the functionality offered by the Cisco TelePresence Exchange System.

Book Organization

The API User Guide for the Cisco TelePresence Exchange System Release 1.0 includes the following chapters:

Chapter
Contents

Overview

Provides an overview of the Cisco TelePresence Exchange System APIs.

API for Call Detail Records

Describes the API services for retrieving and managing call detail records.

Scheduling API

Describes the API services for scheduling and managing meetings.


Conventions

This document uses the following conventions:

Convention
Description

boldface font

Commands, command options, and keywords are in boldface.

italic font

Arguments for which you supply values are in italics.

[   ]

Elements in square brackets are optional.

{ x | y | z }

Alternative keywords are grouped in braces and separated by vertical bars.

[ x | y | z ]

Optional alternative keywords are grouped in brackets and separated by vertical bars.

string

A set of characters. Do not use quotation marks around the string or the string will include the quotation marks.

screen font

Terminal sessions and information the system displays are in screen font.

boldface screen font

Information you must enter is in boldface screen font.

italic screen font

Arguments for which you supply values are in italic screen font.

 

This pointer highlights an important line of text in an example.

^

The symbol ^ represents the key labeled Control—for example, the key combination ^D in a screen display means hold down the Control key while you press the D key.

<   >

Non-printing characters, such as passwords are in angle brackets.


This document also uses the following conventions:

Note Means reader take note. Notes contain helpful suggestions or references to material not covered in the publication.

Caution Means reader be careful. In this situation, you might do something that could result in equipment damage or loss of data.

Obtaining Documentation, Obtaining Support, and Security Guidelines

For information on obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and also recommended aliases and general Cisco documents, see the monthly What's New in Cisco Product Documentation, which also lists all new and revised Cisco technical documentation, at:

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Subscribe to the What's New in Cisco Product Documentation as a Really Simple Syndication (RSS) feed and set content to be delivered directly to your desktop using a reader application. The RSS feeds are a free service and Cisco currently supports RSS Version 2.0.