[Index]
View to add a Subscriber using a Service Profile.
Model ref.: view/AddSubscriberFromProfile
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": {
"send_email_flag": {
"type": "boolean",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
"title": "Send Email to user flag"
},
"new_services_status": {
"type": "boolean",
"description": "New Services status field.",
"title": "New Services status field"
},
"pin": {
"required": false,
"is_password": true,
"type": "string",
"description": "The corresponding CUCM and CUC user PIN will be set with this PIN",
"title": "PIN"
},
"existing": {
"properties": {
"contact_center": {
"type": "string",
"title": "Contact Center"
},
"phones": {
"type": "string",
"title": "Phones"
},
"voicemail": {
"type": "string",
"title": "Voicemail Extension"
},
"ext_mobilities": {
"type": "string",
"title": "Extension Mobility Profile"
},
"webex": {
"type": "string",
"title": "WebEx"
},
"snr": {
"type": "string",
"title": "Single Number Reach"
},
"spark": {
"type": "string",
"title": "Webex Teams"
}
},
"type": "object",
"description": "Subscriber's existing services.",
"title": "Existing Services"
},
"subscriber_profile_services": {
"properties": {
"jabber_android": {
"type": "string",
"title": "Jabber (Android)"
},
"jabber_csf": {
"type": "string",
"title": "Jabber (CSF)"
},
"contact_center": {
"type": "string",
"title": "Contact Center"
},
"jabber_iphone": {
"type": "string",
"title": "Jabber (iPhone)"
},
"jabber_cim": {
"type": "string",
"title": "Jabber (CIM)"
},
"voicemail": {
"type": "string",
"title": "Voicemail Extension"
},
"jabber_tablet": {
"type": "string",
"title": "Jabber (Tablet)"
},
"jabber_cti": {
"type": "string",
"title": "Jabber (CTI)"
},
"phone": {
"type": "string",
"title": "Phone"
},
"webex": {
"type": "string",
"title": "WebEx"
},
"snr": {
"type": "string",
"title": "Single Number Reach"
},
"line": {
"type": "string",
"title": "Line"
},
"ext_mobilities": {
"type": "string",
"title": "Extension Mobility Profile"
},
"spark": {
"type": "string",
"title": "Webex Teams"
}
},
"type": "object",
"description": "Subscriber Profile Services that will be added.",
"title": "New Services"
},
"send_email": {
"type": "boolean",
"description": "Send Email to user using predefined HTML Email Template. Email template used is 'Quick Add Subscriber'",
"title": "Send welcome email"
},
"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"
},
"cucm_bkey": {
"required": false,
"type": "string",
"description": "Business Key of the CUCM.",
"title": "CUCM bkey"
},
"cucm_user_ldapDirectoryName": {
"type": "string",
"description": "The CUCM User LDAP directory name field.",
"title": "CUCM User LDAP Directory Name"
},
"phone_name": {
"type": "string",
"description": "Name to be used when provisioning a phone for e.g. SEPAABBCCDDEEFF. The specific format is dependent on the phone type specified in the profile configuration. This is only applicable if the selected Subscriber Profile has the Voice service enabled.",
"title": "Phone Name"
},
"email": {
"pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$",
"required": true,
"type": "string",
"description": "Email address of the subscriber.",
"title": "Email Address"
},
"username": {
"required": true,
"type": "string",
"description": "Username of the subscriber.",
"title": "Username"
},
"generate_phone_name": {
"default": "true",
"type": "boolean",
"description": "A random phone name will be generated by the system. This is only applicable if the selected Subscriber Profile has the Voice service enabled.",
"title": "Use generated phone name"
},
"firstname": {
"type": "string",
"description": "First name of the subscriber.",
"title": "First Name"
},
"lastname": {
"required": true,
"type": "string",
"description": "Last name of the subscriber.",
"title": "Last Name"
},
"mobile_number": {
"pattern": "^(\\+?[0-9]*)$",
"type": "string",
"description": "Mobile number of the subscriber.",
"title": "Mobile Number"
},
"line": {
"type": "string",
"description": "The line number to use for this subscriber.",
"title": "Line"
},
"password": {
"required": false,
"is_password": true,
"type": "string",
"description": "The corresponding CUCM, CUC and WebEx user password will be set with this password",
"title": "Password"
},
"ldap_user": {
"type": "string",
"description": "The LDAP user field.",
"title": "LDAP User"
},
"automatic_line": {
"default": "true",
"type": "boolean",
"description": "Use the next available line from the inventory.",
"title": "Use next available line"
},
"subscriber_profile": {
"required": true,
"type": "string",
"description": "The profile to use for subscriber configuration.",
"title": "Subscriber Profile"
},
"cucm_user": {
"type": "string",
"description": "The CUCM User field.",
"title": "CUCM User"
}
},
"schema_version": "1.2"
}
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the GUI Add form. | GET | /api/view/AddSubscriberFromProfile/add/ |
|
The GUI Add form of view/AddSubscriberFromProfile 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/AddSubscriberFromProfile/ | 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 |
|---|---|---|---|---|
| Get a compressed format of the Bulk Load spreadsheet template for view/AddSubscriberFromProfile | POST | /api/view/AddSubscriberFromProfile/export_bulkload_template/ |
|
The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Configuration Template | GET | /api/view/AddSubscriberFromProfile/configuration_template/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Field Display Policy | GET | /api/view/AddSubscriberFromProfile/field_display_policy/ | hierarchy=[hierarchy] |
|
POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get the on-line Help for view/AddSubscriberFromProfile. | GET | /api/view/AddSubscriberFromProfile/help | hierarchy=[hierarchy] | On-line help of Model ref.: view/AddSubscriberFromProfile as HTML |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Get | GET | /api/view/AddSubscriberFromProfile/[pkid]/ | hierarchy=[hierarchy] | The view/AddSubscriberFromProfile instance with [pkid]. |
| Task | Call | URL | Parameters | Response |
|---|---|---|---|---|
| Help | GET | /api/view/AddSubscriberFromProfile/[pkid]/help | hierarchy=[hierarchy] | The on-line Help for view/AddSubscriberFromProfile. |