For up-to-date product documentation, see the IBM MobileFirst Foundation Developer Center.

Retrieve Device Registration (GET)

Retrieves an existing device registration to the push service.

Roles

Users in the following roles are authorized to perform this operation:

• mfpadmin
• mfpdeployer
• mfpmonitor
• mfpoperator

Method

GET

Path

/management-apis/2.0/runtimes/runtime-name/notifications/applications/application-name/devices/device-id

Example

https://www.example.com/mfpadmin/management-apis/2.0/runtimes/myruntime/notifications/applications/myapplication/devices/12345-6789?locale=de_DE

Path Parameters

runtime-name

The name of the runtime. This is the context root of the runtime web application, without the leading slash.

application-name

The name of the application.

device-id

The device id.

Query Parameters

Query parameters are optional.

locale

The locale used for error messages.

Produces

application/json, application/xml, text/xml

Response

Retrieves an existing device registration of push.

JSON Example

{
  "createdMode" : "API",
  "createdTime" : "2016-03-15T16:30:19Z",
  "deviceId" : "JeremyiOSPhone",
  "href" : "http://localhost:9080/imfpush/v1/apps/com.test.one/devices/JeremyiOSPhone",
  "lastUpdatedTime" : "2016-03-18T16:30:19Z",
  "platform" : "A",
  "productVersion" : "8.0",
  "token" : "c6a41224 23333917 9fde1532",
  "userId" : "Jeremy",
}

XML Example

<?xml version="1.0" encoding="UTF-8"?>
<push-device
  createdMode="API"
  createdTime="2016-03-15T16:30:19Z"
  deviceId="JeremyiOSPhone"
  href="http://localhost:9080/imfpush/v1/apps/com.test.one/devices/JeremyiOSPhone"
  lastUpdatedTime="2016-03-18T16:30:19Z"
  platform="A"
  productVersion="8.0"
  token="c6a41224 23333917 9fde1532"
  userId="Jeremy"/>

Response Properties

The response has the following properties:

createdMode

The mode of device creation

createdTime

The time at which the device registration occurred

deviceId

The unique identifier of the device

href

The link to the device identifier

lastUpdatedTime

Last update time

platform

The device platform

productVersion

The exact product version.

token

The unique push token of the device

userId

The user identifier of the device.

Errors

400

The request was not understood by the push server.

403

The user is not authorized to call this service.

404

The corresponding runtime or application is not found or not running.

406

Unsupported Accept type - The content type specified in Accept header is not application/json.

500

An internal error occurred.

Parent topic: REST API for the MobileFirst Server administration service