Cisco IPICS API Reference Guide, Release 4.0
Preface
Downloads: This chapterpdf (PDF - 76.0KB) The complete bookPDF (PDF - 6.21MB) | Feedback

Preface

Table Of Contents

Preface

Audience

Organization

Obtaining Documentation, Obtaining Support, and Security Guidelines


Preface


This document provides the information that is required to understand and use the Cisco IP Interoperability and Collaboration System (IPICS) release 4.0(x) application programming interface (API).

Audience

This document is intended for developers who want to use the Cisco IPICS API to control various Cisco IPICS features and functions. It assumes that developers have knowledge or experience with Cisco IPICS, a high-level programming language, and the following:

Extensible Markup Language (XML)

XML schema

Web services

REST web standards

Eclipse integrated development environment (IDE)

Hyper Text Transport Protocol (HTTP) or Secure HTTP (HTTPS)

Simple Object Access Protocol (SOAP)

Organization

This document is organized as follows:

Chapter 1, "Overview of Web Services API"

Introduces the web services API, describes how to perform API requests, and describes API security and API logging

Chapter 2, "Web Services API Functions"

Provides a summary of each Cisco IPICS web services API function and describes each function in detail

Chapter 3, "Value Objects"

Provides detailed descriptions of each value object that is used by the Cisco IPICS web services API functions

Chapter 4, "REST API Function"

Describes the Cisco IPICS API uploadData function, which is a REST function that uploads a resource (photo, video, journal) to the Cisco IPICS server and associates the resource with an incident


Obtaining Documentation, Obtaining Support, and Security Guidelines

For information about obtaining documentation, obtaining support, providing documentation feedback, security guidelines, and 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