2️⃣ GET - System DN Search

my_api.get.system_dn_search()

Searches for number from System level. This will return where the number is located on the system. It will show the Service Provider/ Enterprise, Group ID, and User ID the number is assigned to.

Parameters

  • dn (int): Target number excluding country code e.g. 123456789

Returns

  • List: List of dictionaries containing details of each number that fit the search criteria.

How To Use:

from odins_spear import api

my_api= api.Api(base_url="https://base_url/api/vx", username="john.smith", password="ODIN_INSTANCE_1")
my_api.authenticate()

my_api.get.system_dn_search(
    123456789
)

Example Returned Data (Formatted)

[
  {
    "phoneNumbers": "+1-123456789",
    "department": null,
    "activated": true,
    "userId": "userID",
    "lastName": "Smith",
    "firstName": "John",
    "extension": "6666",
    "emailAddress": null,
    "userType": "Normal",
    "countryCode": 1,
    "nationalPrefix": null,
    "serviceProviderId": "serviceProviderID",
    "groupId": "gorupID",
    "userIdShort": "123456789",
    "domain": "domain.com",
    "dns": {
      "min": "+1-123456789",
      "max": "",
      "activated": true
    }
  }
]

Last updated