.. _subscriber_data_export:

Subscriber Data Export
----------------------


Filename: ``<YYYY-MM-DD_HHMM>_subscriber.json.gz``

Layout:

.. tabularcolumns:: |p{4cm}|p{8cm}|p{2cm}|p{1.5cm}|


+---------------------+----------------------------+-----------+---------+
| ELEMENT             | DESCRIPTION                | DATA TYPE | VERSION |
+=====================+============================+===========+=========+
| provider_name       | Name of the Provider       | string    | v2      |
+---------------------+----------------------------+-----------+---------+
| reseller_name       | Name of the Reseller       | string    | v2      |
+---------------------+----------------------------+-----------+---------+
| customer_name       | name of the customer       | string    | v1      |
+---------------------+----------------------------+-----------+---------+
| division_name       | Intermediate Node (e.g     | string    | v1      |
|                     | Division or other node)    |           |         |
+---------------------+----------------------------+-----------+---------+
| location_name       | Site Name                  | string    | v1      |
+---------------------+----------------------------+-----------+---------+
|                     | The full hierarchy path    |           |         |
| hierarchy           | for the item being         | string    | v1      |
|                     | exported                   |           |         |
+---------------------+----------------------------+-----------+---------+
| username            | username of the user       | string    | v1      |
+---------------------+----------------------------+-----------+---------+
| first_name          | First name of the user     | string    | v1      |
+---------------------+----------------------------+-----------+---------+
| last_name           | last name of the user      | string    | v1      |
+---------------------+----------------------------+-----------+---------+
| email               | email address of the user  | string    | v1      |
+---------------------+----------------------------+-----------+---------+
|                     | the profile assigned to    |           |         |
| entitlement_profile | the user that defines the  | string    | v1      |
|                     | features they are enabled  |           |         |
|                     | to have configured         |           |         |
+---------------------+----------------------------+-----------+---------+
|                     | The role assigned to the   |           |         |
| role                | user - defines privileges  | string    | v1      |
|                     | in the portal              |           |         |
+---------------------+----------------------------+-----------+---------+
|                     | The security profile       |           |         |
|                     | assigned to the user -     |           |         |
| credential_policy   | defined credential and     | string    | v1      |
|                     | other security rules for   |           |         |
|                     | portal access              |           |         |
+---------------------+----------------------------+-----------+---------+
| snr                 | Does the user have the SNR | boolean   | v1      |
|                     | service configured         |           |         |
+---------------------+----------------------------+-----------+---------+
| voicemail           | Does the user have a       | boolean   | v1      |
|                     | voicemail box configured   |           |         |
+---------------------+----------------------------+-----------+---------+
| title               | Subscriber's title         | string    | v2      |
+---------------------+----------------------------+-----------+---------+
| department          | Subscriber's department    | string    | v2      |
+---------------------+----------------------------+-----------+---------+
|                     | Subscriber's telephone     |           |         |
| telephone_number    | number as configured in    | string    | v2      |
|                     | the CUCM user record       |           |         |
+---------------------+----------------------------+-----------+---------+



Example

(* marked fields are new in version 2)

::
  
   [                                                            
      {                                                         
      *   "provider_name": "CS-P",                              
      *   "reseller_name": "CS-NB",                             
          "customer_name": "AAAGlobal",                         
          "division_name": "",                                  
          "location_name": "AAA-Boston",                        
          "hierarchy": "sys.hcs.CS-P.CS-NB.AAAGlobal.AAA-Boston",
          "username": "ba_user4",                               
          "first_name": "Dean",                                 
          "last_name": "Daniels",                               
          "voicemail": false,                                   
          "entitlement_profile": "AAAGlobal-Foundation-EP",     
          "snr": false,                                         
          "credential_policy": "HcsCredentialPolicy",           
          "role": "AAA-BostonSelfService",                      
          "email": "email@theinternet.com",                     
      *   "title": "Dr.",                                       
      *   "department": "R&D",                                  
      *   "telephone_number": "0215252020"                      
       }                                                        
   ]