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

Push Device Registration (GET)

Retrieves an existing device registration of push

Description

Device registrations for a push service that are retrieved for a specific deviceId.

Method

GET

Path

/apps/applicationId/devices/deviceId

Example

https://example.com:443/imfpush/v1/apps/myapp/devices/12345-6789

Path Parameters

deviceId

The device identifier

applicationId

The name or identifier of the application

Header Parameters

Some header parameters are optional.

Accept-Language

(Optional) The preferred language to use for error messages. Default:en-US

Authorization

The token with the scope "devices.read" and "push.application.<applicationId>" obtained using the confidential client in the format Bearer token.. This parameter has to be mandatorily set.

Produces

application/json

Response

The details of the device registration that is retrieved.

JSON Example

{
  "createdMode" : "API",
  "createdTime" : "2015-05-20T11:42:11Z",
  "deviceId" : "12345-6789",
  "lastUpdatedTime" : "2015-05-20T11:42:11Z",
  "phoneNumber" : "123456789",
  "platform" : "A",
  "token" : "12345-6789",
  "userId" : "admin",
}

Response Properties

The response has the following properties:

createdMode

The mode of creation.

createdTime

The date and time when the push device registration was created on the server in ISO 8601 format.

deviceId

The unique id of the device.

lastUpdatedTime

The date and time when the push device registration was last updated on the server in ISO 8601 format.

phoneNumber

Phone number to be used for SMS based notification.

platform

The device platform.

token

The unique push token of the device.

userId

The userId of the device.

Errors

401

Unauthorized - The caller is either not authenticated or not authorized to make this request.

404

A device registration with the specified deviceId is not found.

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 push service