Access Device End Points

Retrieve Access Device End Points list

This API retrieves all the access device end points that are present in a Group.

The devices can be from any levels, but the (service) users using the devices are in the Group.

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/device_end_points/

Retrieve the access device end points list.

Authorization rights: minimum Group Admin.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/device_end_points/ HTTP/1.1
Host: example.com
Request JSON Object:

  • responseSizeLimit (integer) – See responseSizeLimit 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.

  • 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.

  • insensitivePhoneNumberStarts (string) – See insensitivePhoneNumberStarts from Search criteria.

  • insensitivePhoneNumberContains (string) – See insensitivePhoneNumberContains from Search criteria.

  • insensitivePhoneNumberEquals (string) – See insensitivePhoneNumberEquals from Search criteria.

  • insensitiveExtensionStarts (string) – See insensitiveExtensionStarts from Search criteria.

  • insensitiveExtensionContains (string) – See insensitiveExtensionContains from Search criteria.

  • insensitiveExtensionEquals (string) – See insensitiveExtensionEquals from Search criteria.

  • sensitiveUserDepartmentEquals (string) – See sensitiveUserDepartmentEquals from Search criteria.

Example response:

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

{
    "endPoints": [
      {
        "linePort": "LP_ApioUserTest2@sip.netaxis.be",
        "lastName": "Test2",
        "firstName": "Test2",
        "phoneNumber": "",
        "extension":  "7007",
        "userId": "ApioUserTest2@sip.netaxis.be",
        "deviceType": "Generic SIP Phone",
        "deviceName": "APIO Test Device",
        "netAddress": "",
        "macAddress": "221100CCBBAA",
        "emailAddress": ""
      },
      {
        "linePort": "LP_SCA_ApioUserTest1@sip.netaxis.be",
        "lastName": "Test1",
        "firstName": "Test1",
        "phoneNumber": "+3225126778",
        "extension":  "7003",
        "userId": "ApioUserTest1@sip.netaxis.be",
        "deviceType": "Generic SIP Phone",
        "deviceName": "APIO Test Device",
        "netAddress": "",
        "macAddress": "221100CCBBAA",
        "department": {
          "tenantId": "ApioSpTest",
          "groupId": "ApioGrpTest",
          "departmentName": "test_department_initial",
          "fullPathName": "test_department_parent_1 \\ test_department_initial"
        },
        "emailAddress": ""
      },
      {
        "linePort": "LP_ApioUserTest1@sip.netaxis.be",
        "lastName": "Test1",
        "firstName": "Test1",
        "phoneNumber": "+3225126778",
        "extension":  "7003",
        "userId": "ApioUserTest1@sip.netaxis.be",
        "deviceType": "Generic SIP Phone",
        "deviceName": "APIO Test Device",
        "netAddress": "",
        "macAddress": "221100CCBBAA",
        "department": {
          "tenantId": "ApioSpTest",
          "groupId": "ApioGrpTest",
          "departmentName": "test_department_initial",
          "fullPathName": "test_department_parent_1 \\ test_department_initial"
        },
        "emailAddress": ""
      }
    ]
  }
Response JSON Object:

  • endPoints (array) – a list of access device end points as defined below.

Status Codes:

Access Device Ebd Point attributes

Name

Type

Method

Description

GET

linePort

String

A

The device line port.

lastName

String

A

The user’s last name.

firstName

String

A

The user’s first name.

phoneNumber

String

A

The user’s phone number. (See Phone Number).

userId

String

A

The user’s unique ID.

deviceType

String

A

See deviceType.from Access Device attributes.

deviceName

String

A

See deviceName.from Access Device attributes.

extension

String

A

The user’s extension.

department

String

C

The department the user belongs to. An object as defined as Group department key attributes.

emailAddress

String

A

The user’s email address.

netAddress

String

A

The device’s net address

macAddress

String

A

The device’s mac address