[Index]
Fully automated on boarding of a Shared Architecture Customer
Model ref.: view/AddSharedCustomer
The full URL would include the host-proxy name: https://[host-proxy].
Variables are enclosed in square brackets.
{
"$schema": "http://json-schema.org/draft-03/schema",
"type": "object",
"properties": {
"cucmCustomerOption": {
"default": "false",
"type": "boolean",
"title": "Add Call Manager Customer ( CUCM 12.5+ ) "
},
"domain": {
"required": true,
"type": "string",
"description": "Customer domain",
"title": "Domain"
},
"integrateDialPlan": {
"default": "false",
"type": "boolean",
"title": "Integrate Dial Plan"
},
"dpProvResModel": {
"type": "string",
"title": "Reseller Dial Plan Model"
},
"admin_lastname": {
"type": "string",
"description": "Last name of the customer administrator",
"title": "Customer Admin Last Name"
},
"targetCUC": {
"type": "string",
"title": "Target Unity Connection"
},
"vm-unityTrunkDestS": {
"type": "string",
"title": "Call Manager Destination from Unity Secondary"
},
"vm-Mask": {
"type": "string",
"title": "Voice Mail Box Mask"
},
"admin_telephone_number": {
"type": "string",
"description": "Telephone number of the customer administrator",
"title": "Customer Admin Telephone Number "
},
"postal_code": {
"type": "string",
"description": "Postal Code",
"title": "Postal Code"
},
"dpSiteModel": {
"type": "string",
"title": "Site Dial Plan Model"
},
"vm-cucmUsername": {
"type": "string",
"description": "Authentication for sip trunk establish",
"title": "Call Manager Username"
},
"city": {
"type": "string",
"description": "City",
"title": "City"
},
"ucprepProfile": {
"type": "string",
"description": "UCPrep Profile to optionally push per customer",
"title": "UCPrep Profile"
},
"admin_firstname": {
"type": "string",
"description": "First name of the customer administrator",
"title": "Customer Admin First Name"
},
"sites": {
"items": {
"type": "object",
"properties": {
"dialPlanData": {
"items": {
"type": "object",
"properties": {
"seBO": {
"type": "string",
"title": "External Breakout Number"
},
"siteAreaCodes": {
"items": {
"type": "object"
},
"type": "array",
"title": "Site Local Area Codes"
},
"spNum": {
"type": "string",
"title": "Published Number"
},
"scustID": {
"type": "string",
"title": "Custom Site ID"
},
"seNum": {
"type": "string",
"title": "Emergency Call Back Number"
}
}
},
"type": "array",
"title": "Site Dial Plan Data"
},
"city": {
"type": "string",
"description": "City",
"title": "City"
},
"name": {
"pattern": "^[A-Za-z0-9_-]{1,60}$",
"required": false,
"type": "string",
"displayable": true,
"title": "Name"
},
"area": {
"required": false,
"type": "string",
"title": "Area"
},
"address1": {
"type": "string",
"description": "Address 1",
"title": "Address 1"
},
"address2": {
"type": "string",
"description": "Address 2",
"title": "Address 2"
},
"e164_range_start": {
"pattern": "^$|^(\\\\\\+)?[0-9]+$|^\\+?[0-9]+$",
"required": false,
"type": "string",
"title": "DID (E164) Range Start"
},
"site_id": {
"type": "string",
"description": "Unique identifier for this Site",
"title": "Site ID"
},
"emergency_number": {
"is_password": false,
"description": "The site emergency callback number is the calling number when initiating an outgoing emergency call. If you change the emergency callback number, the following calling party transformation patterns are updated to use the new value: *{{ macro.HcsDpSiteId}}*! and *{{ macro.HcsDpSiteId}}*\\+!",
"title": "Emergency number",
"pattern": "^$|^(\\\\\\+)?[0-9]+$|^\\+?[0-9]+$",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"valid_range": {
"required": false,
"type": "string",
"title": "Number range"
},
"state": {
"type": "string",
"description": "State or Province",
"title": "State or Province"
},
"dn_range_start": {
"required": false,
"type": "string",
"title": "Internal (DN) Range Start"
},
"postal_code": {
"type": "string",
"description": "Postal Code",
"title": "Postal Code"
},
"iniStart": {
"type": "string",
"description": "Site Internal Number Inventory Start",
"title": "Site Internal Number Inventory Start"
},
"country": {
"description": "Site country",
"format": "uri",
"required": false,
"choices": [],
"target_attr": "country_name",
"target_model_type": "data/Countries",
"title": "Country",
"type": "string",
"target": "/api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
},
"area_code": {
"pattern": "^[0-9]+$",
"required": false,
"type": "string",
"title": "Area code"
},
"published_number": {
"is_password": false,
"description": "The site published number is the default E164 mask when a line is associated to a phone, device profile, or remote destination profile at a particular site. The default CUCM phone line E164 mask, default CUCM device profile line E164 mask, and the default CUCM remote destination profile line E164 mask in the site default doc are updated with this number, unless those default values in the site defaults doc have been manually updated to some other number. Furthermore, if any existing subscribers are using the site published number in their phone line E164 mask, device profile line E164 mask, or remote destination profile line E164 mask, that value is updated as well.",
"title": "Published number",
"pattern": "^$|^(\\\\\\+)?[0-9]+$|^\\+?[0-9]+$",
"required": false,
"displayable": false,
"readonly": false,
"maxLength": 1024,
"type": "string"
},
"number_allocation": {
"default": "Automatic",
"choices": [
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "Manual",
"title": "Manual"
},
{
"value": "None",
"title": "None"
}
],
"type": "string",
"title": "Number Allocation"
},
"iniEnd": {
"type": "string",
"description": "Site Internal Number Inventory End",
"title": "Site Internal Number Inventory End"
},
"number_range_length": {
"default": "10",
"choices": [
{
"value": "10",
"title": "10"
},
{
"value": "100",
"title": "100"
},
{
"value": "1000",
"title": "1000"
}
],
"required": true,
"type": "string",
"title": " Number Range Required"
}
}
},
"type": "array",
"description": "List of Customer sites",
"title": "Sites"
},
"vm-unityRedundant": {
"default": "true",
"type": "boolean",
"title": "Provision In Unity Redundancy"
},
"state": {
"type": "string",
"description": "State or Province",
"title": "State or Province"
},
"cdialplandata": {
"items": {
"type": "object",
"properties": {
"csipdestsecport": {
"type": "string",
"title": "Secondary SIP Trunk Destination Port"
},
"custCustID": {
"type": "string",
"title": "Custom Customer ID"
},
"cpNum": {
"type": "string",
"title": "Published Number"
},
"ceNum": {
"type": "string",
"title": "Emergency Call Back Number"
},
"csipdestprimport": {
"type": "string",
"title": "Primary SIP Trunk Destination Port"
},
"csipdestprim": {
"type": "string",
"title": "Primary SIP Trunk Destination IP"
},
"ceBO": {
"type": "string",
"title": "External Breakout Number"
},
"csipdestsec": {
"type": "string",
"title": "Secondary SIP Trunk Destination IP"
}
}
},
"type": "array",
"title": "Global Dial Plan Data"
},
"address1": {
"type": "string",
"description": "Address 1",
"title": "Address 1"
},
"customer_id": {
"type": "string",
"description": "Unique identifier for this Customer",
"title": "Customer ID"
},
"targetCUCM": {
"type": "string",
"title": "Target Call Manager"
},
"vm-unityPorts": {
"type": "string",
"description": "Total available ports configured per server. Not total number. ",
"title": "Unity Port Count (Per Server)"
},
"vm-phoneSystem": {
"type": "string",
"title": "Unity Phone System"
},
"address2": {
"type": "string",
"description": "Address 2",
"title": "Address 2"
},
"dpCustModel": {
"type": "string",
"title": "Customer Dial Plan Model"
},
"vm-cucmSecondary": {
"type": "string",
"title": "Call Manager Subscriber for VM Integration"
},
"vm-cucmCMG": {
"type": "string",
"title": "Call Manager Group"
},
"vm-unityTrunkDestP": {
"type": "string",
"description": "The trunk from unity to Call Manager Destination ",
"title": "Call Manager Destination from Unity Primary"
},
"admin_email": {
"required": true,
"type": "string",
"description": "Email of the customer administrator",
"title": "Customer Admin Email"
},
"name": {
"pattern": "^[A-Za-z0-9_-]{1,60}$",
"required": true,
"type": "string",
"description": "Customer name. Can only use characters between A-Z, a-z, 0-9, _ and -",
"title": "Name"
},
"IntegrateVM": {
"default": "false",
"type": "boolean",
"title": "Integrate Voicemail for Tenant"
},
"vm-cucmPass": {
"is_password": true,
"type": "string",
"title": "Call Manager Password"
},
"vm-Pilot": {
"type": "string",
"title": "Voicemail Pilot Number"
},
"vm-DPProfile": {
"type": "string",
"title": "Dial Plan Profile"
},
"country": {
"description": "Customer country",
"format": "uri",
"required": true,
"choices": [],
"target_attr": "country_name",
"target_model_type": "data/Countries",
"title": "Country",
"type": "string",
"target": "/api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
}
}
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/AddSharedCustomer/add/ |
|
The GUI Add form of view/AddSharedCustomer 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/AddSharedCustomer/ | hierarchy=[hierarchy] |
|
tool/Transaction/[trans pkid]shows the View resource has no instance pkid, because a view model stores no instances.
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/AddSharedCustomer/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/AddSharedCustomer/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| List | GET | /api/view/AddSharedCustomer/ |
|
The view/AddSharedCustomer schema and all instances as JSON. |
(The list will return 0 to 3 view/AddSharedCustomer instances)
{
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"pagination": {
"direction": "asc",
"order_by": null,
"maximum_limit": 2000,
"skip": 0,
"current": "/api/view/AddSharedCustomer/?skip=0&limit=3&order_by=None&direction=asc&traversal=default",
"limit": 3,
"total_limit": null,
"total": 0
},
"meta": {
"tags": [],
"cached": true,
"title": "",
"business_key": {},
"schema_version": null,
"references": {
"device": [
{
"pkid": "",
"href": ""
}
],
"children": [],
"parent": [
{
"pkid": "6t0ggef2c0deab00hb595101",
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
}
],
"foreign_key": []
},
"actions": [
{
"add": {
"support_async": false,
"class": "add",
"href": "/api/view/AddSharedCustomer/add/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Add"
}
},
{
"tag": {
"title": "Tag",
"support_async": true,
"method": "PATCH",
"href": "/api/view/AddSharedCustomer/+tag/?hierarchy=[hierarchy]",
"class": "tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"support_async": false,
"class": "config",
"href": "/api/view/AddSharedCustomer/configuration_template/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"support_async": false,
"class": "display_policy",
"href": "/api/view/AddSharedCustomer/field_display_policy/?hierarchy=[hierarchy]",
"method": "GET",
"title": "Field Display Policy"
}
},
{
"list": {
"support_async": false,
"class": "list",
"href": "/api/view/AddSharedCustomer/?hierarchy=[hierarchy]",
"method": "GET",
"title": "List"
}
},
{
"help": {
"support_async": false,
"class": "help",
"href": "/api/view/AddSharedCustomer/help?hierarchy=[hierarchy]",
"method": "GET",
"title": "Help"
}
}
],
"model_type": "view/AddSharedCustomer",
"model_specific_actions": [
"add"
],
"summary_attrs": [
{
"allow_filtering": true,
"name": "hierarchy_friendly_name",
"title": "Located At"
}
],
"api_version": "21.2",
"tagged_versions": []
},
"resources": []
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/AddSharedCustomer. | GET | /api/view/AddSharedCustomer/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/AddSharedCustomer as HTML |
| Task | Call | URL | Parameters | Payload |
|---|---|---|---|---|
| Tag | PATCH | /api/view/AddSharedCustomer/[pkid]/+tag/ | hierarchy=[hierarchy] | If payload required: |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/AddSharedCustomer/[pkid]/ | hierarchy=[hierarchy] | The view/AddSharedCustomer instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/AddSharedCustomer/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/AddSharedCustomer. |