[Index]

API Reference for view/AddPhone

View to add either a standalone Phone or one that is associated with an existing Subscriber.

Model ref.: view/AddPhone

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

GET http://[host-proxy]/api/view/AddPhone/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "username": {
               "type": "string", 
               "description": "Username of the subscriber.", 
               "title": "Username"
          }, 
          "name": {
               "required": true, 
               "type": "string", 
               "description": "Name of the phone.", 
               "title": "Phone Name"
          }, 
          "standalone": {
               "default": "true", 
               "type": "boolean", 
               "description": "Either add this as a standalone phone or associate with an existing Subscriber (user).", 
               "title": "Standalone Phone"
          }, 
          "template_name": {
               "type": "string", 
               "description": "Phone template to use for feature configuration settings.", 
               "title": "Phone Template"
          }, 
          "lines": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "line_filter": {
                              "default": "default", 
                              "choices": [
                                   {
                                        "value": "default", 
                                        "title": "Default"
                                   }, 
                                   {
                                        "value": "lines_e164_unused_local", 
                                        "title": "Show Unused Numbers with Associated E164's (Site Only)"
                                   }, 
                                   {
                                        "value": "lines_e164_unused", 
                                        "title": "Show Unused Numbers with Associated E164's"
                                   }, 
                                   {
                                        "value": "lines_used_only_local", 
                                        "title": "Show Used Numbers (Site Only)"
                                   }, 
                                   {
                                        "value": "lines_used_only", 
                                        "title": "Show Used Numbers"
                                   }, 
                                   {
                                        "value": "lines_userid_used", 
                                        "title": "Show Numbers belonging to this Subscriber"
                                   }
                              ], 
                              "required": false, 
                              "type": "string", 
                              "title": "Inventory Filter"
                         }, 
                         "template_name": {
                              "type": "string", 
                              "description": "Line template to use for configuration settings.", 
                              "title": "Line Template"
                         }, 
                         "label": {
                              "type": "string", 
                              "description": "Label to use for this line.", 
                              "title": "Label"
                         }, 
                         "display": {
                              "type": "string", 
                              "description": "Display to use for this line.", 
                              "title": "Display"
                         }, 
                         "directory_number": {
                              "required": true, 
                              "type": "string", 
                              "description": "Directory Number of line to assign.", 
                              "title": "Directory Number"
                         }
                    }
               }, 
               "type": "array", 
               "title": "Lines"
          }, 
          "device_type": {
               "required": true, 
               "type": "string", 
               "description": "Device type of the phone.", 
               "title": "Device Type"
          }, 
          "cucm_bkey": {
               "required": false, 
               "type": "string", 
               "description": "Business Key of the CUCM. If not specified the workflow will attempt to find the correct UCM server based on Customer or Site.", 
               "title": "Cisco UCM Server"
          }
     }, 
     "schema_version": "1.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/AddPhone/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/AddPhone as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/view/AddPhone/	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

The GET call to

tool/Transaction/[trans pkid]

shows the View resource has no instance pkid, because a view model stores no instances.

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for view/AddPhone	POST	/api/view/AddPhone/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/AddPhone	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/view/AddPhone/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/view/AddPhone/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get the on-line Help for view/AddPhone.	GET	/api/view/AddPhone/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/AddPhone as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Response
Get	GET	/api/view/AddPhone/[pkid]/	hierarchy=[hierarchy]	The view/AddPhone instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/view/AddPhone/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/AddPhone.

API Reference for view/AddPhone

GET http://[host-proxy]/api/view/AddPhone/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Export Bulk Load Template

Configuration Template

Field Display Policy

Help

Instance API Reference

Get

Help