[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": {
"name": {
"title": "Name",
"description": "Customer name. Can only use characters between A-Z, a-z, 0-9, _ and -",
"type": "string",
"required": true,
"pattern": "^[A-Za-z0-9_-]{1,60}$"
},
"domain": {
"title": "Domain",
"description": "Customer domain",
"type": "string",
"required": true
},
"admin_firstname": {
"title": "Customer Admin First Name",
"description": "First name of the customer administrator",
"type": "string"
},
"admin_lastname": {
"title": "Customer Admin Last Name",
"description": "Last name of the customer administrator",
"type": "string"
},
"admin_email": {
"title": "Customer Admin Email",
"description": "Email of the customer administrator",
"type": "string",
"required": true
},
"admin_telephone_number": {
"title": "Customer Admin Telephone Number ",
"description": "Telephone number of the customer administrator",
"type": "string"
},
"customer_id": {
"title": "Customer ID",
"description": "Unique identifier for this Customer",
"type": "string"
},
"address1": {
"title": "Address 1",
"description": "Address 1",
"type": "string"
},
"address2": {
"title": "Address 2",
"description": "Address 2",
"type": "string"
},
"city": {
"title": "City",
"description": "City",
"type": "string"
},
"state": {
"title": "State or Province",
"description": "State or Province",
"type": "string"
},
"postal_code": {
"title": "Postal Code",
"description": "Postal Code",
"type": "string"
},
"country": {
"title": "Country",
"description": "Customer country",
"type": "string",
"format": "uri",
"required": true,
"target": "/api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "country_name",
"target_model_type": "data/Countries",
"choices": []
},
"ucprepProfile": {
"title": "UCPrep Profile",
"description": "UCPrep Profile to optionally push per customer",
"type": "string"
},
"sites": {
"title": "Sites",
"description": "List of Customer sites",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"title": "Name",
"type": "string",
"required": false,
"displayable": true,
"pattern": "^[A-Za-z0-9_-]{1,60}$"
},
"site_id": {
"title": "Site ID",
"description": "Unique identifier for this Site",
"type": "string"
},
"address1": {
"title": "Address 1",
"description": "Address 1",
"type": "string"
},
"address2": {
"title": "Address 2",
"description": "Address 2",
"type": "string"
},
"city": {
"title": "City",
"description": "City",
"type": "string"
},
"state": {
"title": "State or Province",
"description": "State or Province",
"type": "string"
},
"postal_code": {
"title": "Postal Code",
"description": "Postal Code",
"type": "string"
},
"country": {
"title": "Country",
"description": "Site country",
"type": "string",
"format": "uri",
"required": false,
"target": "/api/data/Countries/choices/?field=country_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken],
"target_attr": "country_name",
"target_model_type": "data/Countries",
"choices": []
},
"area": {
"title": "Area",
"type": "string",
"required": false
},
"area_code": {
"title": "Area code",
"type": "string",
"required": false,
"pattern": "^[0-9]+$"
},
"number_allocation": {
"title": "Number Allocation",
"type": "string",
"default": "Automatic",
"choices": [
{
"value": "Automatic",
"title": "Automatic"
},
{
"value": "Manual",
"title": "Manual"
},
{
"value": "None",
"title": "None"
}
]
},
"number_range_length": {
"title": " Number Range Required",
"type": "string",
"required": true,
"default": "10",
"choices": [
{
"value": "10",
"title": "10"
},
{
"value": "100",
"title": "100"
},
{
"value": "1000",
"title": "1000"
}
]
},
"valid_range": {
"title": "Number range",
"type": "string",
"required": false
},
"e164_range_start": {
"title": "DID (E164) Range Start",
"type": "string",
"required": false,
"pattern": "^$|^(\\\\\\+)?[0-9]+$|^\\+?[0-9]+$"
},
"dn_range_start": {
"title": "Internal (DN) Range Start",
"type": "string",
"required": false
},
"published_number": {
"title": "Published number",
"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.",
"type": "string",
"maxLength": 1024,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false,
"pattern": "^$|^(\\\\\\+)?[0-9]+$|^\\+?[0-9]+$"
},
"emergency_number": {
"title": "Emergency number",
"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}}*\\+!",
"type": "string",
"maxLength": 1024,
"is_password": false,
"required": false,
"readonly": false,
"displayable": false,
"pattern": "^$|^(\\\\\\+)?[0-9]+$|^\\+?[0-9]+$"
},
"iniStart": {
"title": "Site Internal Number Inventory Start",
"description": "Site Internal Number Inventory Start",
"type": "string"
},
"iniEnd": {
"title": "Site Internal Number Inventory End",
"description": "Site Internal Number Inventory End",
"type": "string"
},
"dialPlanData": {
"title": "Site Dial Plan Data",
"type": "array",
"items": {
"type": "object",
"properties": {
"scustID": {
"title": "Custom Site ID",
"type": "string"
},
"seBO": {
"title": "External Breakout Number",
"type": "string"
},
"spNum": {
"title": "Published Number",
"type": "string"
},
"seNum": {
"title": "Emergency Call Back Number",
"type": "string"
},
"siteAreaCodes": {
"title": "Site Local Area Codes",
"type": "array",
"items": {
"type": "object"
}
}
}
}
}
}
}
},
"IntegrateVM": {
"title": "Integrate Voicemail for Tenant",
"type": "boolean",
"default": "false"
},
"vm-cucmSecondary": {
"title": "Call Manager Subscriber for VM Integration",
"type": "string"
},
"vm-DPProfile": {
"title": "Dial Plan Profile",
"type": "string"
},
"vm-unityRedundant": {
"title": "Provision In Unity Redundancy",
"type": "boolean",
"default": "true"
},
"vm-phoneSystem": {
"title": "Unity Phone System",
"type": "string"
},
"vm-cucmUsername": {
"title": "Call Manager Username",
"description": "Authentication for sip trunk establish",
"type": "string"
},
"vm-cucmPass": {
"title": "Call Manager Password",
"type": "string",
"is_password": true
},
"vm-unityPorts": {
"title": "Unity Port Count (Per Server)",
"description": "Total available ports configured per server. Not total number. ",
"type": "string"
},
"vm-Pilot": {
"title": "Voicemail Pilot Number",
"type": "string"
},
"vm-Mask": {
"title": "Voice Mail Box Mask",
"type": "string"
},
"vm-unityTrunkDestP": {
"title": "Call Manager Destination from Unity Primary",
"description": "The trunk from unity to Call Manager Destination ",
"type": "string"
},
"vm-unityTrunkDestS": {
"title": "Call Manager Destination from Unity Secondary",
"type": "string"
},
"vm-cucmCMG": {
"title": "Call Manager Group",
"type": "string"
},
"integrateDialPlan": {
"title": "Integrate Dial Plan",
"type": "boolean",
"default": "false"
},
"dpProvResModel": {
"title": "Reseller Dial Plan Model",
"type": "string"
},
"dpCustModel": {
"title": "Customer Dial Plan Model",
"type": "string"
},
"dpSiteModel": {
"title": "Site Dial Plan Model",
"type": "string"
},
"targetCUCM": {
"title": "Target Call Manager",
"type": "string"
},
"targetCUC": {
"title": "Target Unity Connection",
"type": "string"
},
"cdialplandata": {
"title": "Global Dial Plan Data",
"type": "array",
"items": {
"type": "object",
"properties": {
"custCustID": {
"title": "Custom Customer ID",
"type": "string"
},
"ceBO": {
"title": "External Breakout Number",
"type": "string"
},
"cpNum": {
"title": "Published Number",
"type": "string"
},
"ceNum": {
"title": "Emergency Call Back Number",
"type": "string"
},
"csipdestprim": {
"title": "Primary SIP Trunk Destination IP",
"type": "string"
},
"csipdestprimport": {
"title": "Primary SIP Trunk Destination Port",
"type": "string"
},
"csipdestsec": {
"title": "Secondary SIP Trunk Destination IP",
"type": "string"
},
"csipdestsecport": {
"title": "Secondary SIP Trunk Destination Port",
"type": "string"
}
}
}
},
"cucmCustomerOption": {
"title": "Add Call Manager Customer ( CUCM 12.5+ ) ",
"type": "boolean",
"default": "false"
}
}
}
| 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 |
|---|---|---|---|---|
| Tag | PATCH | /api/view/AddSharedCustomer/+tag/ |
|
| 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)
{
"pagination": {
"skip": 0,
"limit": 3,
"maximum_limit": 2000,
"total": 0,
"total_limit": null,
"order_by": null,
"direction": "asc",
"current": "/api/view/AddSharedCustomer/?skip=0&limit=3&order_by=None&direction=asc&traversal=down"
},
"operations": [
"add",
"help",
"configuration_template",
"field_display_policy",
"export_bulkload_template",
"transform"
],
"meta": {
"model_type": "view/AddSharedCustomer",
"summary_attrs": [
{
"name": "hierarchy_friendly_name",
"title": "Located At",
"allow_filtering": true
}
],
"tagged_versions": [],
"tags": [],
"title": "",
"business_key": {},
"api_version": "21.2",
"cached": true,
"references": {
"children": [],
"parent": [
{
"href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101",
"pkid": "6t0ggef2c0deab00hb595101"
}
],
"device": [
{
"href": "",
"pkid": ""
}
],
"foreign_key": []
},
"model_specific_actions": [
"add"
],
"schema_version": null,
"actions": [
{
"add": {
"method": "GET",
"class": "add",
"href": "/api/view/AddSharedCustomer/add/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Add"
}
},
{
"tag": {
"method": "PATCH",
"class": "tag",
"href": "/api/view/AddSharedCustomer/+tag/?hierarchy=[hierarchy]",
"support_async": true,
"title": "Tag",
"view": "/api/view/TagNameForm/add/?auth_token=[authtoken]
}
},
{
"configuration_template": {
"method": "GET",
"class": "config",
"href": "/api/view/AddSharedCustomer/configuration_template/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Configuration Template"
}
},
{
"field_display_policy": {
"method": "GET",
"class": "display_policy",
"href": "/api/view/AddSharedCustomer/field_display_policy/?hierarchy=[hierarchy]",
"support_async": false,
"title": "Field Display Policy"
}
},
{
"list": {
"method": "GET",
"class": "list",
"href": "/api/view/AddSharedCustomer/?hierarchy=[hierarchy]",
"support_async": false,
"title": "List"
}
},
{
"help": {
"method": "GET",
"class": "help",
"href": "/api/view/AddSharedCustomer/help?hierarchy=[hierarchy]",
"support_async": false,
"title": "Help"
}
}
]
},
"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. |