Mobile Registration REST Operations for Oracle Radio
Complete device registration and renew a registered installation's online state.
Use the supported authentication flow for the intended enabled Radio user. These operations require that user's current bearer access token. A registration code, advertising ID, or device ID doesn't replace it.
The paths below start at the managed instance origin. When using the returned serviceEndpoint, append only the portion after /api/. See the REST overview for endpoint, authentication, and request guidance.
Complete Registration
Operation: completeDeviceRegistration.
POST /api/v1/radio/device-registrations/completionsComplete the grant as its intended Radio user. A ONE_TIME grant is consumed after success. A REUSABLE grant stays active until expiry or revocation and creates a new device record for each completion, even with the same advertising ID.
| Parameter | Location | Requirement |
|---|---|---|
code | JSON body | Required nonempty registration code from the issued descriptor. Keep it out of logs, source files, and support records. |
advertisingId | JSON body | Required opaque string of 1–255 characters. An all-zero value is valid. |
appVersion | JSON body | Optional string, up to 64 characters. |
osVersion | JSON body | Optional string, up to 64 characters. |
Replace the bracketed values with your values before sending this JSON request. Supply Content-Type: application/json.
{
"code": "<registration-code>",
"advertisingId": "<opaque-advertising-id>"
}Success: 201 with a device object. Store its radioDeviceId as protected installation state. A targeted re-registration retains the existing device ID.
Discard the code from the application after completion. Keep the returned device ID and protected OAuth state. A reusable grant is retained separately by its administrator; it is not a token-renewal credential.
409 means the grant is expired or revoked, or a one-time grant was consumed. Obtain a new grant instead of repeatedly submitting it. For 404 NotAuthorizedOrNotFound, check the signed-in user and intended registration with an authorized administrator. If completion might have succeeded but the response was lost, have the administrator inspect inventory before starting another registration.
Send a Heartbeat
Operation: heartbeatRadioDevice.
POST /api/v1/radio/me/devices/{deviceId}/heartbeatRenew the installation's online state while the authenticated application is active.
| Parameter | Location | Requirement |
|---|---|---|
deviceId | Path | Required radioDeviceId from a device response; 1–32 characters. Encode it as one URL path segment. |
Success: 200 with the updated device object, including its current activity state. No request body is required.
Use the registered installation's ID and inspect the returned online and onlineUntil values. A heartbeat doesn't renew the OAuth access token. On authentication failure, use the supported token-renewal flow; on a missing device, review re-enrollment.
Next Steps
Use the returned device ID when establishing the mobile WebSocket session. Follow the enrollment scenario for OAuth, registration, and connection order.
For failed requests, see errors, troubleshooting, and the FAQ. A 404 NotAuthorizedOrNotFound response doesn't distinguish missing resources from authorization failures.