[Index]

API Reference for view/MsoQuickSubscriber

Microsoft Quick Add Subscriber ============================== The Microsoft Quick Add Subscriber feature provides provides a simple interface for allocating supported Microsoft UC services to users that have been added to Microsoft Active Directory and synchronized into VOSS Automate from Microsoft Lync / Skype for Business. The interface is for service additions and the detailed configuration is hidden from administrators delegated to perform these operations. The detailed configuration is typically managed by a customer administrator or above using the Configuration Templates specified in Microsoft Quick Add Groups. The VOSS Automate user interface will disable the option of adding Microsoft Lync / Skype for Business if the user already has Microsoft Lync / Skype for Business. Multi-vendor Quick Add Subscriber --------------------------------- The Multivendor Quick Add Subscriber feature enables administrators to add both Cisco and Microsoft UC services to subscribers. **NOTE: Cisco and Microsoft Workflows are combined without modifying the underlying Quick Add Subscriber feature of the solution that is extended by installing the applicable VOSS Automate add-on.** Microsoft Quick Add Subscriber Workflow --------------------------------------- The workflow supports adding the following Microsoft UC services: **If the required AD User is not in the dropdown list:** * Create a user in Microsoft Active Directory **If the Skype for Business check box is selected:** * Enable a user in Microsoft Lync or Skype for Business * Grant the user each of the applicable policies. * Set the Lync / Skype for Business user settings according to the user input and selected telephony options. **If the Voicemail check box is selected:** * Create a mailbox for the user in Microsoft Exchange using the email address of the AD user and with options specified in the Microsoft Exchange Mailbox template in the Microsoft Defaults / Microsoft Quick Add Group. * Enable the mailbox of the user for Unified Messaging using the extension specified. **If the Office 365 check box is checked:** Below see the workflow for provisioning online services. NOTE: If the workflow is rolled back for whatever reason and the creation of a Mailbox is reversed by disabling the mailbox then it has the effect of the AD user's email address being blanked out, which is comes from disabling the mailbox. Microsoft Quick Add Subscriber Online ------------------------------------- The following conditions apply when adding services to a Subscriber enabled for MS Online Services: If the Subscriber has Voicemail or Skype for business the following options will be disabled : * Voicemail * SFB Enabled If the Subscriber does not have Voicemail and/or Skype for Business you can choose to enable the subscriber by just checking the voicemail and/or SfB Enable check boxes. This will enable the Subscriber with on-prem services. If the voicemail checkbox is checked and the Online Mailbox/Voicemail checkbox is checked, the Subscriber will be provisioned for online mailbox and Ummailbox services. If the SfB Enabled checkbox and the Online Skype for Business checkbox is checked the Skype for Business service will be provisioned online. **NOTE**: The Microsoft Quick Add Group selected needs to contain the MS Online Licenses required for the options selected. Microsoft Hybrid 2-stage provisioning ------------------------------------- In the case where Active Directory is synchronized with MS online (i.e. a Hybrid deployment) the provisioning of online service can only be completed once ADFS Dir Sync has been completed. When a Quick Add Subscriber operation is performed before a new AD user has been synchronized with MS Online, VOSS will persist the MS Online Provisioning request. Outstanding online provisioning requests can be seen in the "Services Allocated" tab of Subscribers. A scheduled task is provided as part of sample templates that periodically synchronizes VOSS with MS Online Users. The scheduled task processes any outstanding MS Online Provisioning requests and deletes them once completed. Microsoft Quick Add Subscriber Online Provisioning Workflow ----------------------------------------------------------- The workflow supports adding the following Microsoft Online Services in a hybrid deployment: **If the Online Skype for Business check box is selected:** * Enable a user in Microsoft Lync or Skype for Business (on premises) * Persist a MS Online Provisioning request (to be processed as specified below). **Processing Online Provisioning Requests:** * Synchronize MS Online Users into VOSS (and move them to the site where the AD user exists). * If the MS Online User has been dir synced to MS online then modify the MS online user as follows: * Set the usage location to the usage location configured in the Quick Add Group or (if not specified in the Quick Add Group) the MS Defaults. * License the user according to the licenses specified in the Quick Add Group. * If the Online Skype for Business option had been checked when doing Quick Add Subscriber then: * Move the on-prem Skype for Business user online. * Update the Skype for business online user properties (which will grant the policies configured in the Skype for Business template of the Quick Add Group). * Set the Lync / Skype for Business user settings according to the user input and selected telephony options. * If the Online Mailbox/Voicemail option had been checked when doing Quick Add Subscriber then: * Add an online Exchange Mailbox according the configuration template in the Quick Add Group. * Enable the Exchange Mailbox for Unified Messaging (UM) according the configuration template in the Quick Add Group. * Update VOSS view of the data in on Active Directory user and the Skype for Business Online and Onprem users, since these would have been updated with execution of above steps. .. |VOSS-4-UC| replace:: VOSS-4-UC

Model ref.: view/MsoQuickSubscriber

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/MsoQuickSubscriber/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "self_provisioning_profile": {
               "target": "/api/device/cucm/UserProfileProvision/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
               "format": "uri", 
               "required": false, 
               "choices": [], 
               "target_attr": "name", 
               "target_model_type": "device/cucm/UserProfileProvision", 
               "title": "Self Provisioning User Profile", 
               "type": "string"
          }, 
          "ms_teams": {
               "type": "boolean", 
               "title": "Microsoft Teams"
          }, 
          "directoryUri": {
               "required": false, 
               "type": "string", 
               "title": "Directory URI"
          }, 
          "pin": {
               "required": false, 
               "is_password": true, 
               "type": "string", 
               "description": "The corresponding CUCM and CUC user PIN will be set with this PIN", 
               "title": "PIN"
          }, 
          "mobility": {
               "type": "boolean", 
               "title": "Extension Mobility"
          }, 
          "homeNumber": {
               "required": false, 
               "type": "string", 
               "title": "Home Number"
          }, 
          "phones": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "phone_name": {
                              "target": "/api/device/cucm/Phone/choices/?field=name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
                              "format": "uri", 
                              "title": "Phone Name", 
                              "choices": [], 
                              "target_attr": "name", 
                              "target_model_type": "device/cucm/Phone", 
                              "type": "string", 
                              "description": "Name of phone to provision for e.g. SEPABCDEFABCDEF"
                         }
                    }
               }, 
               "type": "array", 
               "title": "Phones"
          }, 
          "existing": {
               "type": "object", 
               "properties": {
                    "ExchangeUM_id": {
                         "type": "integer", 
                         "title": "Exchange UM ID"
                    }, 
                    "phones": {
                         "type": "string", 
                         "title": "Phones"
                    }, 
                    "voicemail": {
                         "type": "string", 
                         "title": "Voicemail Extension"
                    }, 
                    "sip_address": {
                         "type": "string", 
                         "title": "SIP Address"
                    }, 
                    "ext_mobilities": {
                         "type": "string", 
                         "title": "Extension Mobility Profiles"
                    }, 
                    "webex": {
                         "type": "string", 
                         "title": "WebEx"
                    }, 
                    "lync_id": {
                         "type": "string", 
                         "title": "SfB Id"
                    }, 
                    "snr": {
                         "type": "string", 
                         "title": "Single Number Reach"
                    }
               }, 
               "title": "Existing Services"
          }, 
          "manager": {
               "required": false, 
               "type": "string", 
               "title": "Manager"
          }, 
          "lync_details": {
               "type": "object", 
               "properties": {
                    "phone_number": {
                         "type": "string", 
                         "title": "Phone Number"
                    }, 
                    "sip_address": {
                         "type": "string", 
                         "title": "SIP Address"
                    }, 
                    "ext": {
                         "type": "string", 
                         "title": "Extension"
                    }, 
                    "id": {
                         "type": "string", 
                         "title": "Id"
                    }
               }
          }, 
          "jabber": {
               "type": "boolean", 
               "description": "When adding a Jabber device also specify a line to be associated. The first line specified will be used for any Jabber device added here.", 
               "title": "Jabber Device"
          }, 
          "online_voicemail": {
               "type": "boolean", 
               "title": "Online Mailbox/Voicemail"
          }, 
          "user_status": {
               "type": "string", 
               "title": "User status"
          }, 
          "title": {
               "required": false, 
               "type": "string", 
               "title": "Title"
          }, 
          "lync": {
               "type": "boolean", 
               "title": "SfB Enabled"
          }, 
          "normalized_user": {
               "type": "string", 
               "title": "Normalized User"
          }, 
          "office365": {
               "type": "boolean", 
               "title": "Office365 Enabled"
          }, 
          "webex": {
               "type": "boolean", 
               "title": "WebEx"
          }, 
          "department": {
               "required": false, 
               "type": "string", 
               "title": "Department"
          }, 
          "cucm_user_ldapDirectoryName": {
               "type": "string", 
               "title": "CUCM User LDAP Directory Name"
          }, 
          "jabber_agent": {
               "choices": [
                    {
                         "value": "android", 
                         "title": "Android"
                    }, 
                    {
                         "value": "csf", 
                         "title": "CSF"
                    }, 
                    {
                         "value": "ipad", 
                         "title": "iPad"
                    }, 
                    {
                         "value": "iphone", 
                         "title": "iPhone"
                    }
               ], 
               "type": "string", 
               "title": "Jabber Agent"
          }, 
          "email": {
               "pattern": "^([^.@]+)(\\.[^.@]+)*@([^.@]+\\.)+([^.@]+)$", 
               "type": "string", 
               "format": "email", 
               "required": true, 
               "title": "Email Address"
          }, 
          "username": {
               "required": true, 
               "type": "string", 
               "title": "Username"
          }, 
          "online_sfb": {
               "type": "boolean", 
               "title": "Online Skype for Business"
          }, 
          "phone_protocol": {
               "type": "string", 
               "title": "Phone Protocol"
          }, 
          "firstname": {
               "required": false, 
               "type": "string", 
               "title": "First Name"
          }, 
          "lastname": {
               "required": true, 
               "type": "string", 
               "title": "Last Name"
          }, 
          "snr": {
               "type": "boolean", 
               "title": "Single Number Reach"
          }, 
          "mobile_number": {
               "required": false, 
               "type": "string", 
               "title": "SNR Mobile Number"
          }, 
          "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", 
               "title": "LDAP User"
          }, 
          "telephoneNumber": {
               "required": false, 
               "type": "string", 
               "title": "Telephone Number"
          }, 
          "mobileNumber": {
               "required": false, 
               "type": "string", 
               "title": "User's Mobile Number"
          }, 
          "phone_template": {
               "type": "string", 
               "title": "Phone Template"
          }, 
          "voicemail": {
               "type": "boolean", 
               "title": "Voicemail"
          }, 
          "lines": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "directory_number": {
                              "type": "string", 
                              "title": "Directory Number"
                         }
                    }
               }, 
               "required": false, 
               "type": "array", 
               "title": "Lines"
          }, 
          "qagroup_name": {
               "target": "/api/data/LyncQuickAddGroups/choices/?field=group_name&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
               "format": "uri", 
               "default": "default", 
               "required": true, 
               "choices": [], 
               "target_attr": "group_name", 
               "target_model_type": "data/LyncQuickAddGroups", 
               "title": "Quick Add Group", 
               "type": "string"
          }, 
          "self_service_id": {
               "type": "boolean", 
               "title": "Enable Self Provisioning"
          }, 
          "cucm_user": {
               "type": "string", 
               "title": "CUCM User"
          }, 
          "jabber_devices": {
               "items": {
                    "type": "object", 
                    "properties": {
                         "mobile_identity_destination": {
                              "type": "string", 
                              "title": "Destination"
                         }, 
                         "mobile_identity": {
                              "type": "boolean", 
                              "title": "Mobile Identity"
                         }, 
                         "jabber_agent": {
                              "choices": [
                                   {
                                        "value": "android", 
                                        "title": "Android"
                                   }, 
                                   {
                                        "value": "csf", 
                                        "title": "CSF"
                                   }, 
                                   {
                                        "value": "ipad", 
                                        "title": "iPad"
                                   }, 
                                   {
                                        "value": "iphone", 
                                        "title": "iPhone"
                                   }
                              ], 
                              "type": "string", 
                              "title": "Jabber Agent"
                         }, 
                         "device_name": {
                              "type": "string", 
                              "title": "Device Name"
                         }
                    }
               }, 
               "type": "array", 
               "title": "Jabber Devices"
          }, 
          "voice": {
               "type": "boolean", 
               "title": "Voice"
          }, 
          "phone_type": {
               "type": "string", 
               "title": "Phone Type"
          }
     }, 
     "schema_version": "1.6"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/view/MsoQuickSubscriber/add/	hierarchy=[hierarchy] format=json	The GUI Add form of view/MsoQuickSubscriber 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/MsoQuickSubscriber	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/MsoQuickSubscriber	POST	/api/view/MsoQuickSubscriber/export_bulkload_template/	hierarchy=[hierarchy] modeltype=view/MsoQuickSubscriber	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
List	GET	/api/view/MsoQuickSubscriber/	hierarchy=[hierarchy] format=json schema=true	The view/MsoQuickSubscriber schema and all instances as JSON.

(The list will return 0 to 3 view/MsoQuickSubscriber instances)

GET http://[host]/api/view/MsoQuickSubscriber/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "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/MsoQuickSubscriber/?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": "1.6", 
          "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/MsoQuickSubscriber/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/view/MsoQuickSubscriber/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/view/MsoQuickSubscriber/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/view/MsoQuickSubscriber/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }
          ], 
          "model_type": "view/MsoQuickSubscriber", 
          "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/MsoQuickSubscriber.	GET	/api/view/MsoQuickSubscriber/help	hierarchy=[hierarchy]	On-line help of Model ref.: view/MsoQuickSubscriber 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
Help	GET	/api/view/MsoQuickSubscriber/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for view/MsoQuickSubscriber.

API Reference for view/MsoQuickSubscriber

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

Get the Add form

Create

Export Bulk Load Template

List

GET http://[host]/api/view/MsoQuickSubscriber/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Help