Cisco Cisco Prime Home 5.0 Developer's Guide
Cisco Prime Home – Integration Guide
OL-28557-01 v5.0.1
3
Table of Contents
Introduction ............................................................................................................ 5
Preface ................................................................................................................................................................... 5
Intended Audience ............................................................................................................................................... 5
In This Guide… ....................................................................................................................................................... 5
Prime Home API Capabilities ......................................................................................................................... 5
Device Management: .......................................................................................................................................... 5
Search: ....................................................................................................................................................................... 5
Create Control Panel Sessions: ....................................................................................................................... 5
Getting Started ................................................................................................................................................... 5
Language / Framework Requirements ..................................................................................................... 5
Searching the API ................................................................................................................................................. 6
Devices and Subscribers .................................................................................................................................... 6
Applications & Drivers ................................................................................................................................... 6
Services ................................................................................................................................................................. 7
Device Lifecycle....................................................................................................... 8
Management .......................................................................................................................................................... 9
API REFERENCE ..................................................................................................... 10
REST .................................................................................................................................................................... 10
Anatomy of a REST Call .................................................................................................................................. 10
Kinds of Resources ............................................................................................................................................ 12
Single Item ............................................................................................................................................................ 12
Lists ........................................................................................................................................................................... 12
Processes ................................................................................................................................................................ 12
Compared with SOAP ....................................................................................................................................... 12
JSON .......................................................................................................................................................................... 12
API Standards .................................................................................................................................................. 13
Search and CAQL ................................................................................................... 16
Overview ........................................................................................................................................................... 16
About Search .................................................................................................................................................... 16
Language Specification ................................................................................................................................ 17
Web Services ........................................................................................................ 23
API Catalog ....................................................................................................................................................... 23
Full Text Search .................................................................................................................................................. 23
Provisioning & Management ..................................................................................................................... 23
Troubleshooting ................................................................................................... 29
When Working with Documents ............................................................................................................. 29
Revision Conflict ................................................................................................................................................. 29
Invalid Data .......................................................................................................................................................... 29
JSON Formatting ................................................................................................................................................ 30
Subscriber DTO Schema ........................................................................................ 30
Subscriber ......................................................................................................................................................... 31
Subscriber.Address.{} .................................................................................................................................. 31
Subscriber.Phone.{} ...................................................................................................................................... 31
Examples .............................................................................................................. 32
Example Format ............................................................................................................................................. 32