Privacy Service¶

Display end user’s Privacy service¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/privacy/¶

Retrieve the configuration of the Privacy service of the end user.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/privacy/ HTTP/1.1
Host: example.com

{}

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
  "directoryPrivacy": true,
  "ivrExtensionDialingPrivacy": true,
  "ivrNameDialingPrivacy": true,
  "phoneStatusPrivacy": false,
  "permittedMonitorUsers': [
    {
      "userId": "ApioDummyUserTest@sip.netaxis.be",
      "firstName": "Apio",
      "lastName": "Dummy",
      "phoneNumber": "",
      "extension": "4053",
      "department": {"tenantId": "ApioSpTest", "groupId": "ApioGrpTest", "departmentName": "test_department_initial", "fullPathName": "test_department_parent_1 \\ test_department_initial"},
      "emailAddress": "",
      "impId": ""
    },
    {
      "userId": "ApioUserTest3@netaxis.be",
      "firstName": "Test3",
      "lastName": "Test3",
      "phoneNumber": "",
      "extension": "",
      "emailAddress": "",
      "impId": ""
    }
  ]
}

Response JSON Object:

directoryPrivacy (boolean) – When set, when somebody does a directory listing, the end user’s name and number do not appear. When unset, the end user’s information appears as usual.
ivrExtensionDialingPrivacy (boolean) – When set, the end user is unreachable through IVR extension dialing.
ivrNameDialingPrivacy (boolean) – When set, the end user is unreachable through IVR name dialing.
phoneStatusPrivacy (boolean) – When set, the end user is excluded from Phone Status monitoring. This prevents the users in the same group or enterprise from seeing his phone status.
permittedMonitorUsers (array) – List of users who are allowed to monitor the end user even of the privacy is enabled.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the end user

Modify end user’s Privacy service¶

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/privacy/¶

Update the configuration of the Privacy service of the end user.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/foo/groups/foogroup/users/foouser/services/privacy/ HTTP/1.1
Host: example.com

{
  "directoryPrivacy": true,
  "ivrExtensionDialingPrivacy": false,
  "ivrNameDialingPrivacy": false,
  "phoneStatusPrivacy": true,
  "permittedMonitorUsers': ["userId": "ApioDummyUserTest@sip.netaxis.be"]
}

Request JSON Object:

directoryPrivacy (boolean) – When set, when somebody does a directory listing, the end user’s name and number do not appear. When unset, the end user’s information appears as usual.
ivrExtensionDialingPrivacy (boolean) – When set, the end user is unreachable through IVR extension dialing.
ivrNameDialingPrivacy (boolean) – When set, the end user is unreachable through IVR name dialing.
phoneStatusPrivacy (boolean) – When set, the end user is excluded from Phone Status monitoring. This prevents the users in the same group or enterprise from seeing his phone status.
permittedMonitorUsers (array) – Full new list of users (userIds) who are allowed to monitor the end user even of the privacy is enabled.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
  "directoryPrivacy": true,
  "ivrExtensionDialingPrivacy": false,
  "ivrNameDialingPrivacy": false,
  "phoneStatusPrivacy": true,
  "permittedMonitorUsers': [
    {
      "userId": "ApioDummyUserTest@sip.netaxis.be",
      "firstName": "Apio",
      "lastName": "Dummy",
      "phoneNumber": "",
      "extension": "4053",
      "department": {"tenantId": "ApioSpTest", "groupId": "ApioGrpTest", "departmentName": "test_department_initial", "fullPathName": "test_department_parent_1 \\ test_department_initial"},
      "emailAddress": "",
      "impId": ""
    }
  ]
}

Response JSON Object:

directoryPrivacy (boolean) – When set, when somebody does a directory listing, the end user’s name and number do not appear. When unset, the end user’s information appears as usual.
ivrExtensionDialingPrivacy (boolean) – When set, the end user is unreachable through IVR extension dialing.
ivrNameDialingPrivacy (boolean) – When set, the end user is unreachable through IVR name dialing.
phoneStatusPrivacy (boolean) – When set, the end user is excluded from Phone Status monitoring. This prevents the users in the same group or enterprise from seeing his phone status.
permittedMonitorUsers (array) – List of users who are allowed to monitor the end user even of the privacy is enabled.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the end user

Display privacy’s available users¶

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/privacy/available_users/¶

Retrieve the list of available users to be used for the Privacy service of the user.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/privacy/available_users/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
}

Request JSON Object:

sensitiveUserIdStarts (string) – See sensitiveUserIdStarts from Search criteria.
sensitiveUserIdContains (string) – See sensitiveUserIdContains from Search criteria.
sensitiveUserIdEquals (string) – See sensitiveUserIdEquals from Search criteria.
insensitiveUserIdStarts (string) – See insensitiveUserIdStarts from Search criteria.
insensitiveUserIdContains (string) – See insensitiveUserIdContains from Search criteria.
insensitiveUserIdEquals (string) – See insensitiveUserIdEquals from Search criteria.
sensitiveUserLastNameStarts (string) – See sensitiveUserLastNameStarts from Search criteria.
sensitiveUserLastNameContains (string) – See sensitiveUserLastNameContains from Search criteria.
sensitiveUserLastNameEquals (string) – See sensitiveUserLastNameEquals from Search criteria.
insensitiveUserLastNameStarts (string) – See insensitiveUserLastNameStarts from Search criteria.
insensitiveUserLastNameContains (string) – See insensitiveUserLastNameContains from Search criteria.
insensitiveUserLastNameEquals (string) – See insensitiveUserLastNameEquals from Search criteria.
sensitiveUserFirstNameStarts (string) – See sensitiveUserFirstNameStarts from Search criteria.
sensitiveUserFirstNameContains (string) – See sensitiveUserFirstNameContains from Search criteria.
sensitiveUserFirstNameEquals (string) – See sensitiveUserFirstNameEquals from Search criteria.
insensitiveUserFirstNameStarts (string) – See insensitiveUserFirstNameStarts from Search criteria.
insensitiveUserFirstNameContains (string) – See insensitiveUserFirstNameContains from Search criteria.
insensitiveUserFirstNameEquals (string) – See insensitiveUserFirstNameEquals from Search criteria.
sensitiveEmailAddressStarts (string) – See sensitiveEmailAddressStarts from Search criteria.
sensitiveEmailAddressContains (string) – See sensitiveEmailAddressContains from Search criteria.
sensitiveEmailAddressEquals (string) – See sensitiveEmailAddressEquals from Search criteria.
insensitiveEmailAddressStarts (string) – See insensitiveEmailAddressStarts from Search criteria.
insensitiveEmailAddressContains (string) – See insensitiveEmailAddressContains from Search criteria.
insensitiveEmailAddressEquals (string) – See insensitiveEmailAddressEquals from Search criteria.
insensitiveExtensionStarts (string) – See insensitiveExtensionStarts from Search criteria.
insensitiveExtensionContains (string) – See insensitiveExtensionContains from Search criteria.
insensitiveExtensionEquals (string) – See insensitiveExtensionEquals from Search criteria.
insensitiveDnStarts (string) – See insensitiveDnStarts from Search criteria.
insensitiveDnContains (string) – See insensitiveDnContains from Search criteria.
insensitiveDnEquals (string) – See insensitiveDnEquals from Search criteria.
sensitiveUserDepartmentEquals (object) – See sensitiveDepartmentEquals from Search criteria.
sensitiveUserGroupEquals (object) – See sensitiveUserGroupEquals from Search criteria.
responseSizeLimit (integer) – See responseSizeLimit from Search criteria.

Example response:

HTTP/1.1 200 OK
Content-Type: "application/json"

{
     "available_users": [
         {
             "userId": "ApioUserTest2@sip.netaxis.be",
             "firstName": "Test2",
             "lastName": "Test2",
             "extension": "",
             "phoneNumber": "",
             "department": {
                  "tenantId": "ApioSpTest",
                  "groupId": "ApioGrpTest",
                  "departmentName": "test_department_initial",
                  "fullPathName": "test_department_parent_1 \\ test_department_initial"
             },
             "emailAddress": "",
             "impId": ""
         }
     ]
}

Response JSON Object:

available_users (array) – a list of users, as defined below, that can be added to the permittedMonitorUsers list.

Status Codes:

200 OK – no error
404 Not Found – the service is not assigned to the user

User summary attributes¶

Name	Type	Method	Description
Name	Type	GET	Description
userId	String	A	The unique user Id
firstName	String	A	The user first name. (see First / Last name)
lastName	String	A	The user last name. (see First / Last name)
department	String	A	The department the user belongs to, an object as defined as Group department key attributes.
phoneNumber	String	A	The user’s phone number (if configured, empty or absent otherwise) (see Phone Number)
extension	String	A	The user extension. (see Extension)
emailAddress	String	A	The user email address
impId	String	A	The user IMP ID