Scope of API
This is a web interface for provisioning Service Provider, Customer and the following clusters and cluster applications using REST APIs:
-
Cisco Unified Communications Manager
-
Cisco Unity Connection
-
Cisco Emergency Responder
The provisioning must be in the following order:
Service Provider
Create Service Provider
Title |
Create Service Provider |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
NA |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Update Service Provider
Title |
Update Service Provider |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Delete Service Provider
Title |
Delete Service Provider |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
id – Integer |
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read Service Provider
Title |
Read Service Provider Based on ID |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read All Service Provider
Title |
Read All Service Provider |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example | |
Notes |
Json Schema for Service Provider
Title |
Json Schema for Service Provider |
---|---|
Root URL |
|
URL |
v10_0 |
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example | |
Notes |
Customer
Create a Customer
Title |
Create a Customer |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
NA |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Updates a Customer
Title |
Updates a Customer |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Delete a Customer
Title |
Delete a Customer |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read a Customer
Title |
Get a Customer |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read All Customers
Title |
Get All Customers |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example | |
Notes |
Json Schema for a Customer
Title |
Json Schema for a Customer |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
200 |
Error Response |
404- Resource not found |
Example | |
Notes |
Cisco Unified Communications Manager Cluster
Create Cisco Unified Communications Manager Cluster
Title |
Creates Cisco Unified Communications Manager Cluster |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
NA |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Updates Cisco Unified Communications Manager Cluster
Title |
Updates Cisco Unified Communications Manager Cluster |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Delete Cisco Unified Communications Manager Cluster
Title |
Delete Cisco Unified Communications Manager Cluster |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read Cisco Unified Communications Manager Cluster
Title |
Get Cisco Unified Communications Manager Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read All Cisco Unified Communications Manager Cluster
Title |
Get All Cisco Unified Communications Manager Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Schema Cisco Unified Communications Manager Cluster
Title |
Schema Cisco Unified Communications Manager Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Cisco Unity Connection Cluster
Create Cisco Unity Connection Cluster
Title |
Creates Cisco Unity Connection Cluster |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
NA |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Updates Cisco Unity Connection Cluster
Title |
Updates Cisco Unity Connection Cluster |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Delete Cisco Unity Connection Cluster
Title |
Delete Cisco Unity Connection Cluster |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read Cisco Unity Connection Cluster
Title |
Get Cisco Unity Connection Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read All Cisco Unity Connection Cluster
Title |
Get All Cisco Unity Connection Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Schema for Cisco Unity Connection Cluster
Title |
Schema for Cisco Unity Connection Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Cisco Emergency Responder Cluster
Create Cisco Emergency Responder Cluster
Title |
Creates Cisco Emergency Responder Cluster |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
NA |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Updates Cisco Emergency Responder Cluster
Title |
Updates Cisco Emergency Responder Cluster |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Delete Cisco Emergency Responder Cluster
Title |
Delete Cisco Emergency Responder Cluster |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read Cisco Emergency Responder Cluster
Title |
Get Cisco Emergency Responder Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read All Cisco Emergency Responder Cluster
Title |
Get All Cisco Emergency Responder Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Schema for Cisco Emergency Responder Cluster
Title |
Schema for Cisco Emergency Responder Cluster |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Cisco Unified Communications Manager
Create Cisco Unified Communications Manager
Title |
Creates Cisco Unified Communications Manager |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
NA |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Updates Cisco Unified Communications Manager
Title |
Updates Cisco Unified Communications Manager |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Delete Cisco Unified Communications Manager
Title |
Delete Cisco Unified Communications Manager |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read Cisco Unified Communications Manager
Title |
Get Cisco Unified Communications Manager |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read All Cisco Unified Communications Manager
Title |
Get All Cisco Unified Communications Manager |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Schema for Cisco Unified Communications Manager
Title |
Schema for Cisco Unified Communications Manager |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Cisco Unity Connection
Create Cisco Unity Connection
Title |
Creates Cisco Unity Connection |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
NA |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Updates Cisco Unity Connection
Title |
Updates Cisco Unity Connection |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Delete Cisco Unity Connection
Title |
Delete Cisco Unity Connection |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read Cisco Unity Connection
Title |
Get Cisco Unity Connection |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read All Cisco Unity Connection
Title |
Get All Cisco Unity Connection |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Schema for Cisco Unity Connection
Title |
Schema for Cisco Unity Connection |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Cisco Emergency Responder
Create Cisco Emergency Responder
Title |
Creates Cisco Emergency Responder |
---|---|
Root URL |
|
URL |
|
Method |
POST |
URL Params |
NA |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example |
|
Notes |
Updates Cisco Emergency Responder
Title |
Updates Cisco Emergency Responder |
---|---|
Root URL |
|
URL |
|
Method |
PUT |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Delete Cisco Emergency Responder
Title |
Delete Cisco Emergency Responder |
---|---|
Root URL |
|
URL |
|
Method |
DELETE |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read Cisco Emergency Responder
Title |
Get Cisco Emergency Responder |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
id – Integer |
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Read All Cisco Emergency Responder
Title |
Get All Cisco Emergency Responder |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |
Schema for Cisco Emergency Responder
Title |
Schema for Cisco Emergency Responder |
---|---|
Root URL |
|
URL |
|
Method |
GET |
URL Params |
|
Data Params |
|
Success Response |
201 |
Error Response |
404- Resource not found |
Example | |
Notes |