[Index]

API Reference for relation/MsoSubscriber

. Subscriber Management in a Microsoft UC Environment =================================================== The Subscriber Management interface makes it easy for an Administrator to add, modify or delete users, associate devices and subscribe them to services from a single tabbed form. A user is added to the system by adding a user to Microsoft Active Directory (AD) and then synchronizing VOSS-4-UC with AD. If the relevant services are selected, these are also added to Microsoft Skype for Business and to other network devices such as Microsoft Exchange and Online Servers such as Skype for Business Online and Exchange Online. **Note:** Adding or deleting a device while modifying a Subscriber requires more than one task. In other words, a Subscriber's details cannot for example be modified at the same time that a device is added or removed. **Note:** Adding an Online Mailbox or Online Skype for Business User should be done using Quick Add Subscriber. The MS Provider level subscribers provide an example of a user interface that can be built. Customer level and Site level subscribers can have different user interfaces to Subscriber Management. A Customer level administrator who uses the interface from the Site level hierarchy, could be provided with a more detailed interface than the Site level Administrator at the same level. The following devices and services can be provisioned by means of the Subscriber Management interface: * Active Directory User properties * Microsoft Skype for Business Users * Exchange Mailbox * Exchange Unified Messaging (Voicemail) * Skype for Business Online * Exchange Online To ensure that the Subscriber workflows execute successfully, the following items must first be configured or created on Microsoft Active Directory, Skype for Business, Exchange, Skype for Business Online and Exchange Online and then imported into VOSS-4-UC: 1. Skype for Business: * SIP Domains * Policies * Front End Pools 2. Exchange: * UM Mailbox Policy * Mailboxes * UM Mailboxes 3. Active Directory: * AD Users 4. Skype for Business Online: * Policies 5. Exchange Online: * UM Mailbox Policy * Mailboxes * UM Mailboxes The following settings need to be configured in the Microsoft Site Defaults for Subscriber Management to work correctly: * The default registrar pool. * Check ''Exchange UM for Voicemail'' if Exchange UM is used for voicemail. * ''Exchange UM Mailbox Policy'' needs to match the dial plan and the numbering plan. * Extension Length needs to match the numbering plan for the site. See topic on Data Sync for more details on importing into VOSS-4-UC. Use the procedures below as high-level workflow steps to perform one or more subscriber MACDs in VOSS-4-UC system. Subscriber Services Summary --------------------------- When adding, modifying or deleting services of a user, carry out the following procedure to get an overview of existing services allocated to Active Directory users synchronized into the system: 1. Log in as a MS provider administrator. Choose the site at which you want to manage the services assigned to users. 2. Choose **Subscriber Management > Subscribers**. 3. The following fields in the subscriber list view show the services allocated to the user: * The field "msRTCSIP-UserEnabled" indicates whether the user is enabled for Skype for Business. * The field "mSRTCSIP-Line" is the Skype for Business LineURI. Users with Audio/Video Disabled may not have a LineURI specified. * The field "msRTC-SIP-DeploymentLocator" will be set to "SRV:" for on-premise users and "sipfed.online.lync.com" for Skype Online users. * mailNickName indicates whether the user has a mailbox. * msExchUMEnabledFlags is set to 831 when Unified messaging is enabled. 4. In order to perform MACD operations of a user, select the appropriate user from the list view. Modifying AD User Properties ---------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the User tab, edit the Active Directory User fields as required. 5. On the Service Allocation tab, uncheck the Enabled checkbox to disable the user in Active Directory. 6. On the Identification tab, edit the User Principal Name of the user. 7. On the Address Details, Organizational Details, Contact Details and Credential Info tabs, edit the required attributes of the Active Directory user. 8. Click **Save** to edit the user's details in Active Directory. Disabling the user ------------------ 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Service Allocation tab, uncheck the Enabled checkbox to disable the user in Active Directory. 5. Click **Save** to disable the user. Adding Skype for Business to a User ----------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Skype for Business tab, click **+** and complete fields to add a new Skype for Business User. 5. Consider the following when adding the Skype for Business User: * Check the Enabled Checkbox to select whether the user should be created in an enabled state. Uncheck Enabled to create the user in a disabled state. * The SIP address defaults to "sip:" concatenated with the user's SAM account name + @ + the user's SIP domain. * Specify the Registrar Pool from the dropdown of available CsPools. * Specify the required Telephony Property. Note that the user is only prompted to enter LineURI, VoicePolicy or LineServerURI if this is required for the selected Telephony property. * If appropriate, select the Line URI of the user (see section on selecting Line URI). * Specify the required Dial Plan and Policies of the user. 6. Click OK to add Skype for Business to the user. Selecting the Line URI ---------------------- The LineURI dropdown shows DIDs (numbers in the VOSS-4-UC Number Inventory starting with a "+") and extensions at the level of the hierarchy of the user. Consider the following when specifying the user's Line URI: * When user selects an Extension Number, the LineURI will be set to tel:+<EXT>;ext=<EXT> * When he user selects a DID, the LineURI will be set to tel:<DID>;ext=<Last 'Extension Length' digits of the DID>. NOTE: Extension Length is configured in the MS defaults of each site. * When the user does not change anything or enters the LineURI according to the Microsoft Lync / Skype for Business format (i.e. starting with 'T' or 't'), no further processing of the LineURI will take place. This allows for control of: * The user's DID (e.g. tel:+27215252020;ext=2020) as the user's E164 phone number or, * The Operator Number (also called PSTN published number) as the user's E164 phone number. Examples: * A user with a LineURI of tel:+27215252020;ext=2020 has been assigned a DID of +27215252020 and an Extension Number 2020. * A user with a LineURI of tel:+27215252000;ext=2020 has been assigned Extension Number 2020 while the switchboard operator's number +27215252000 will be presented as the user's caller ID when the user makes PSTN phone calls. * A user with a LineURI of tel:+27215252025 has been assigned DID of +27215252025. Modifying Skype for Business User attributes -------------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Skype for Business tab, modify the required attributes of the Skype for Business User. Considering the following: * Check the Enabled Checkbox to select whether the user should be created in an enabled state. Uncheck Enabled to create the user in a disabled state. * Specify the SIP address as required. * Specify the Registrar Pool from the drop down of available CsPools. * Specify the required Telephony Property. Note that the user is only prompted to enter LineURI, VoicePolicy or LineServerURI if this is required for the selected Telephony property. * If appropriate, select the Line URI of the user (see section on selecting Line URI). * Specify the required dial plan and Policies of the user. 5. Click **Save** to modify the subscriber details. Deleting Skype for Business User Services ----------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Skype for Business tab, for the On-Prem User, click **-** and confirm that you want to delete the Skype for Business services of the user. Adding an Exchange Mailbox to a user ------------------------------------ 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, click **+** and complete fields to add an Exchange Mailbox for the user. Considering the following: * Specify the Alias of the User's mailbox and any other fields that are exposed as part of the field display policy. 5. Optionally click **+** to enable the Mailbox for Unified Messaging. Pay attention to the following: * Select the UM Mailbox Policy applicable. * The SIP Resource Identifier is automatically set to the SamAccountName and the SIP domain of the user. * Specify the Extension(s) of the user by clicking on the + button one or more times. * Specify any other fields exposed by the field display policy. 6. Click **OK** to add a Mailbox and optionally enable Unified Messaging for the user. Modifying an Exchange Mailbox / Unified Messaging ------------------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, modify the required attributes of the Mailbox / Unified Messaging settings. 5. Click **Save** to modify the subscriber details. Disabling a user's Exchange Mailbox ----------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers** 3. Select the appropriate user from the list view. 4. On the Exchange tab click **-** to disable the user's mailbox. 5. Click **Yes** to confirm disabling the user's mailbox. **NOTE:** Unified Messaging, if it exists, will be disabled. Enabling a user for Unified Messaging ------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, click **+** next to ''On Prem Um Mailbox'' and complete fields to enable the user for Unified Messaging. Considering the following: * Select the UM Mailbox Policy applicable. * The SIP Resource Identifier is automatically set to the SamAccountName and the SIP domain of the user. * Specify the Extension(s) of the user by clicking on the + button one or more times. * Specify any other fields exposed by the field display policy. 5. Click OK to enable the mailbox for Unified Messaging. Modifying a User's Unified Messaging attributes ----------------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, modify the 'On Prem Um Mailbox' attributes of the user as required. 5. Click **Save** to modify the subscriber details. Disable Unified Messaging service of a user ------------------------------------------- 1. On the Exchange tab next to 'On Prem Um Mailbox', click **-** and confirm that you want to delete Unified Messaging services of the user. Deleting the Subscriber ----------------------- Use this procedure to delete one or more subscribers. 1. Log in as MS provider administrator. 2. Choose the site from which you want to delete the subscribers. 3. Choose **Subscriber Management > Subscribers**. 4. Choose the subscribers to delete by clicking on the check boxes in the leftmost column, then click **Delete**. 5. From the popup window, click **Yes** to confirm the deletion. 6. The Active Directory User will be disabled (not deleted), the Mailbox will be disabled, UM will be disabled and Skype for Business will be disabled. Modify Subscriber Services (across devices) ------------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. Click on the subscriber that you want to update. 5. Modify subscriber information as required. See Add Subscribers for information on the fields to edit. 6. Click **Save** when you have finished modifying the subscriber information. 7. Updates are made to the user in Active Directory, Skype for Business (if applicable) and Exchange (if applicable). Deleting Skype for Business Online User Services ------------------------------------------------ 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Skype for Business tab, for the Online User, click **-** and confirm that you want to delete the Skype for Business Online services of the user. **NOTE**: The Workflow will move the user to Skype for Business On-Prem server and Disable Skype for Business Service Plans in all Licenses assigned to the user (and where necessary remove licenses that have no service plans enabled). Adding an Exchange Online Mailbox to a user ------------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, click **+** and complete fields to add an Exchange Mailbox for the user considering the following: * Specify the Alias of the User's mailbox and any other fields that are exposed as part of the field display policy. 5. Optionally click **+** to enable the Mailbox for Unified Messaging. Pay attention to the following: * Select the UM Mailbox Policy applicable. * The SIP Resource Identifier is automatically set to the SamAccountName and the SIP domain of the user. * Specify the Extension(s) of the user by clicking on the **+** button one or more times. * Specify any other fields exposed by the field display policy. 6. Click **OK** to add a Mailbox and optionally enable Unified Messaging for the user. **NOTE**: The Workflow will created On-Prem Mailbox on the server and move the mailbox to online. Once the move has been completed the user will be licensed. Modifying an Exchange Online Mailbox / Unified Messaging -------------------------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, modify the required attributes of the Mailbox / Unified Messaging settings. 5. Click **Save** to modify the subscriber details. Disabling a user's Exchange Online Mailbox ------------------------------------------ 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, click **-** next to ''Online UM Mailbox'' to disable the user's UM Mailbox. 5. Click **Yes** to confirm disabling the user's mailbox. **NOTE**: The Workflow will move the user to Mailbox On-Prem server and Disable Mailbox Plans in all Licenses assigned to the user (and where necessary, remove licenses that have no service plans enabled). Unified Messaging, if it exists, will be disabled. Enabling a user for Online Unified Messaging -------------------------------------------- 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, click **+** next to ''Online UM Mailbox'' and complete fields to enable the user for Unified Messaging. Considering the following: * Select the UM Mailbox Policy applicable. * The SIP Resource Identifier is automatically set to the SamAccountName and the SIP domain of the user. * Specify the Extension(s) of the user by clicking on the **+** button one or more times. * Specify any other fields exposed by the field display policy. 5. Click **OK** to enable the mailbox for Unified Messaging. Modifying a User's Online Unified Messaging attributes ------------------------------------------------------ 1. Log in as a MS provider administrator. Choose the site. 2. Choose **Subscriber Management > Subscribers**. 3. Select the appropriate user from the list view. 4. On the Exchange tab, modify the 'Online Um Mailbox' attributes of the user as required. 5. Click **Save** to modify the subscriber details. Disable Unified Messaging service of a Online user -------------------------------------------------- 1. On the Exchange tab next to 'Online Um Mailbox', click **-** and confirm that you want to delete Unified Messaging services of the user.

Model ref.: relation/MsoSubscriber

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

Variables are enclosed in square brackets.

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

Get the Add form

Task Call URL Parameters Response
Get the GUI Add form. GET /api/relation/MsoSubscriber/add/
  • hierarchy=[hierarchy]
  • format=json
 The GUI Add form of relation/MsoSubscriber 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.

Create

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

  • Response is a transaction pkid for the create action.

  • Use the GET call to 
    tool/Transaction/[trans pkid]
    to inspect the created resource and its instance pkid.

    • Bulk Delete

    Task Call URL Parameters Payload
    Bulk delete [pkid1],[pkid2]... DELETE /api/relation/MsoSubscriber/ hierarchy=[hierarchy] {"hrefs":["/api/relation/MsoSubscriber/[pkid1]", "/api/relation/MsoSubscriber/[pkid2]", ...]}
    • For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: relation/MsoSubscriber 
      GET http://[host-proxy]/api/relation/MsoSubscriber/?hierarchy=[hierarchy]&format=json

    Bulk Modify

    Task Call URL Parameters Response
    Bulk Modify GET /api/relation/MsoSubscriber/bulk_update/?schema=&schema_rules=true
    • hierarchy=[hierarchy]
    • format=json
    • pkids=pkid1,pkid2,...
      In JSON format:
    • POST call to update the instances of relation/MsoSubscriber
    • relation/MsoSubscriber schema to create POST payload.
    Task Call URL Parameters Payload
    Bulk Modify POST /api/relation/MsoSubscriber/bulk_update/
    • hierarchy=[hierarchy]
    • format=json
    		 For example:
    {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/relation/MsoSubscriber/[pkid1]", "/api/v0/relation/MsoSubscriber/[pkid2]",...]}}
    • To get a list of model instance pkids that are available to Bulk Modify, use the GET call:
      GET http://[host-proxy]/api/relation/MsoSubscriber/?hierarchy=[hierarchy]&format=json
    • The POST payload is in JSON format (refer to the Payload example) and contains:
      • data in name-value update pairs according to the returned schema
      • meta (empty - for a valid payload)
      • request_meta with the hrefs list of instances to update

    Move

    Task Call URL Parameters Payload
    Move the instance with [pkid] to [target_hierarchy] POST /api/tool/DataMove/?model_type=relation/MsoSubscriber
    • hierarchy=[hierarchy]
    • context_hierarchy=[target_hierarchy]
    • format=json
    • (nowait=true)
    		 {"hrefs": ["/api/relation/MsoSubscriber/[pkid]"]}
    Bulk Move POST /api/tool/DataMove/?model_type=relation/MsoSubscriber
    • hierarchy==[hierarchy]
    • context_hierarchy=[target_hierarchy]
    • format=json
    • (nowait=true)
    		 {"hrefs": ["/api/relation/MsoSubscriber/[pkid1]", "/api/relation/MsoSubscriber/[pkid2]",...]}

    • Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
    • For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
      GET http://[host-proxy]/api/relation/MsoSubscriber/?hierarchy=[hierarchy]&format=json&schema_rules=true

    Bulk Export

    Task Call URL Parameters Payload
    Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of relation/MsoSubscriber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. POST /api/relation/MsoSubscriber/export/
    • hierarchy=[hierarchy]
    • version=[version]
    • schema=
    • schema_rules=
    • template_name=[configtemplate]
    • export_format=[raw_xlsx|xlsx|json]
    		 { "hrefs":["/api/relation/MsoSubscriber/[pkid1]", "/api/relation/MsoSubscriber/[pkid2]",...]}}

    For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

            Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

    For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

            Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

            Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    The XLSX format can be used to bulk load instances of relation/MsoSubscriber and the JSON format can be used to import instances of relation/MsoSubscriber.

    • To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for relation/MsoSubscriber: 
    •  GET http://[host-proxy]/api/relation/MsoSubscriber/?hierarchy=[hierarchy]

    Configuration Template

    Task Call URL Parameters Response
    Configuration Template GET /api/relation/MsoSubscriber/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]

    Field Display Policy

    Task Call URL Parameters Response
    Field Display Policy GET /api/relation/MsoSubscriber/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]

    Migration Template

    Task Call URL Parameters Response
    Migration Template GET /api/relation/MsoSubscriber/migration/
    • hierarchy=[hierarchy]
    • format=json
    		  

    List

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

    (The list will return 0 to 3 relation/MsoSubscriber instances)

    Help

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

    Instance API Reference

    Modify

    Task Call URL Parameters Payload
    Modify PUT /api/relation/MsoSubscriber/[pkid]/ hierarchy=[hierarchy] (For payload specification)

    For Bulk modification, refer to the Bulk Modify section.

    Delete

    Task Call URL Parameters Response
    Delete DELETE /api/relation/MsoSubscriber/[pkid]/ hierarchy=[hierarchy]

    Clone

    Task Call URL Parameters Response
    Clone instance with [pkid]. The schema rules are applied. GET /api/relation/MsoSubscriber/[pkid]/clone/?schema=&schema_rules=true
    • hierarchy=[hierarchy]
    		 A JSON payload with:
    • A POST action URL.
    • The unchanged model [pkid] payload to be modified to create a new instance.
    • For the instance pkids that can cloned, refer to the List GET call for relation/MsoSubscriber
    • GET http://[host-proxy]/api/relation/MsoSubscriber/?hierarchy=[hierarchy]&format=json
    • Use the POST action in the response with a modification of the response payload to create the clone.

    Move

    Task Call URL Parameters Payload
    Move POST /api/tool/DataMove/[pkid]/?model_type=relation/MsoSubscriber hierarchy=[hierarchy] If payload required:

    Export

    Task Call URL Parameters Response
    Get a selected [export_format] of the schema and a single instance with [pkid] of relation/MsoSubscriber; optionally with tag_version at [version] and Configuration Template as [configtemplate]. GET /api/relation/MsoSubscriber/[pkid]/export/
    • hierarchy=[hierarchy]
    • version=[version]
    • schema=
    • schema_rules=
    • template_name=[configtemplate]
    • export_format=[raw_xlsx|xlsx|json]
    		 The response is an attachment. Refer to the list below.

    For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

            Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

            Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

    For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

            Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

    The XLSX format can be used to bulk load instances of relation/MsoSubscriber and the JSON format can be used to import instances of relation/MsoSubscriber.

    For Bulk Export, refer to the Bulk Export section.

    Tag

    Task Call URL Parameters Payload
    Tag PATCH /api/relation/MsoSubscriber/[pkid]/+tag/ hierarchy=[hierarchy] If payload required:

    Get

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

    Help

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

    Add Exchange Online Um Mailbox

    Task Call URL Parameters Payload
    Add Exchange Online Um Mailbox POST /api/relation/MsoSubscriber/[pkid]/+AddExchangeOnlineUMMailbox/ hierarchy=[hierarchy] If payload required:

    Add Hybrid Mailbox

    Task Call URL Parameters Payload
    Add Hybrid Mailbox POST /api/relation/MsoSubscriber/[pkid]/+AddHybridMailbox/ hierarchy=[hierarchy] If payload required:

    Add Hybrid Um Mailbox

    Task Call URL Parameters Payload
    Add Hybrid Um Mailbox POST /api/relation/MsoSubscriber/[pkid]/+AddHybridUMMailbox/ hierarchy=[hierarchy] If payload required:

    Add S4B Hybrid User

    Task Call URL Parameters Payload
    Add S4B Hybrid User POST /api/relation/MsoSubscriber/[pkid]/+AddS4BHybridUser/ hierarchy=[hierarchy] If payload required:

    Del Exchange Online Mailbox

    Task Call URL Parameters Payload
    Del Exchange Online Mailbox POST /api/relation/MsoSubscriber/[pkid]/+DelExchangeOnlineMailbox/ hierarchy=[hierarchy] If payload required:

    Del Exchange Online Um Mailbox

    Task Call URL Parameters Payload
    Del Exchange Online Um Mailbox POST /api/relation/MsoSubscriber/[pkid]/+DelExchangeOnlineUMMailbox/ hierarchy=[hierarchy] If payload required:

    Del Hybrid Mailbox

    Task Call URL Parameters Payload
    Del Hybrid Mailbox POST /api/relation/MsoSubscriber/[pkid]/+DelHybridMailbox/ hierarchy=[hierarchy] If payload required:

    Del Hybrid Um Mailbox

    Task Call URL Parameters Payload
    Del Hybrid Um Mailbox POST /api/relation/MsoSubscriber/[pkid]/+DelHybridUMMailbox/ hierarchy=[hierarchy] If payload required:

    Del S4B Hybrid User

    Task Call URL Parameters Payload
    Del S4B Hybrid User POST /api/relation/MsoSubscriber/[pkid]/+DelS4BHybridUser/ hierarchy=[hierarchy] If payload required:

    Del S4B Online User

    Task Call URL Parameters Payload
    Del S4B Online User POST /api/relation/MsoSubscriber/[pkid]/+DelS4BOnlineUser/ hierarchy=[hierarchy] If payload required: