Skip to content

Private Radios⚓︎

Path⚓︎

/v1/private-radios

The private radio resource returns the eNodeB information for the site. A site can have multiple eNodeBs.

 

Resource Attributes⚓︎

The attributes for the private radios resource are detailed below:

Attribute Type Required? Description
enodebId String YES The unique identifier of the eNodeB.
status String YES The current status of the eNodeB. Can be Enabled or Disabled.
extensions Object NO A container for any additional properties or metadata.

Example⚓︎

{
  "enodebId": "10101-101",
  "status": "Enabled",
  "extensions": {}
}

Note⚓︎

  • The enodebId is not used as the resource ID in API requests.
  • The resourceID is found using the GET command.

For example, a GET response might show the following:

  • enodebId: 00000-99121
    • resourceID: 185123749
{
    "enodebId": "00000-99121",
    "status": "Enabled",
    "extensions": {},
    "_links": {
        "self": {
            "href": "https://api.expeto.io/v1/private-radios/185123749"
        },
        "private-radio": {
            "href": "https://api.expeto.io/v1/private-radios/185123749{?projection}",
            "templated": true
        },
        "feature": {
            "href": "https://api.expeto.io/v1/private-radios/185123749/feature"
        },
        "latestCdr": {
            "href": "https://api.expeto.io/v1/private-radios/185123749/latestCdr"
        }
    }
}

 

Endpoints⚓︎

Request Examples⚓︎

Find all eNodeBs associated with a site:⚓︎

{baseUrl}/v1/private-radios/search/findBySite?site=<siteID>

Where <siteID> is a number representing the site. You can discover the site ID using the /site endpoint.

Find a specific eNodeB using a known resourceID:⚓︎

{baseUrl}/v1/private-radios/<resourceID>

Find the IP Address of the eNodeB:⚓︎

  1. Select a private-radios instance.
  2. Click GET for the private-radio link. The <resourceID> is discovered and populated in the request URL.
  3. For the projection parameter, type deep.

The following request:

{baseUrl}/v1/private-radios/<resourceID>?projection=deep

Might elicit the following response:

{
  "lastSeen": "2021-02-19T20:58:36.041547Z",
  "connected": true,
  "name": "ipaccess31",
  "status": "Enabled",
  "ipAddress": "192.111.222.333",
  "enodebId": "123264-45"
}