Menu

forceUpdateSummary

Description: API returns a force update summary that includes a count of the devices that has currently downloaded, failed to download or are currently processing a target firmware update. 

Note that the API call is only available for 3 months after the force update ID is generated.

Prerequisite: setB2bGroupRegister(), setAllowedFOTAVersion(), setB2BForceUpdate, and license must be active.

URL: https://eu-api.samsungknox.com/b2bfota/v2/forceUpdateSummary

HTTP Method:POST

SSL Required: Yes

Since: Android N, E-FOTA version 2 (release date: 2018-12-14)

Request

https://eu-api.samsungknox.com/b2bfota/v2/forceUpdateSummary

Header

  • Authorization Bearer—An OAuth 2.0 token, which authenticates your identity in REST API calls. The token is a hyphen-separated 32-character hexadecimal string, for example, aaaa1111-bb22-cc33-dd44-eeeeee555555. For more info, see Generate OAuth tokens.
  • Content-Typeapplication/xml

Body

The elements in the body are:

Parameters Description

mdmId

The MDM ID identifies your company among other partners in our KPP program.

Data type: string

Format:

  • 10-character alphanumeric string, for example, "d1e2f3g4h5".
  • All characters permitted, and all lower case letters are treated as upper case letters.
  • Max 50 byte string.
NOTE— Some early E-FOTA partners have an mdmId that is a 42-character alphanumeric string. You can get your MDM ID when you request an E-FOTA license or contact us.
customerId

Identifies an enterprise customer that will use the E-FOTA service. You can get a test customer ID when you request an E-FOTA license.

Data type: string

Format:

  • Hyphen-separated 32-character hexadecimal string, for example, "EEEE4444-FF55-AA66-BB77-CCCCCC888888".

  • All characters are permitted.
  • Max 50 byte string.
license

This identifies the E-FOTA license purchase order and tracks customer usage of the E-FOTA service for billing purposes. During development, you use an E-FOTA trial license (valid for 30 days, maximum 100 devices).

Data type: string

Format:

  • For example, "EFOTA1-fff555-ggg666-hh77".
  • All characters permitted.
  • Max 100 byte string.

forceUpdateId

The ID associated with the force update. Can be used for up to 3 months after the push update. See forceUpdateDetail and forceUpdateSummary

Data type: string

Format:

  • For example, "JEA12345678".
  • Permissible characters: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-"
  • Max 30 byte string.

Example

Here's a sample request for license information:

<B2bForceUpdateSummaryVO> <mdmId>MDMName</mdmId> <customerId>XYZ</customerId> <license>11111-11111-11111-11111-11111</license> <forceUpdateId>12310180309-JEA12345678</forceUpdateId> </B2bForceUpdateSummaryVO>

Response

If the API call is successful, the E-FOTA server returns HTTP/1.1 200 OK with these XML elements in the body:

Return Description
targetFirmwareVersion

The target firmware version pushed onto the device.

Data type: string

Format:

  • For example, "GTS1234XXZZ1"
  • Permissible characters: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-/._"
  • Max 100 byte string.
processingCount

The number of devices that are currently downloading the force update.

Data type: string

Format:

  • For example, "15"
  • Permissible characters: "1234567890"
  • Max 4 byte integers.
successCount

The number of devices that have successfully downloaded the force update.

Data type: string

Format:

  • For example, "91"
  • Permissible characters: "1234567890"
  • Max 4 byte integers.
failedCount

The number of devices that have failed to download the force update.

Data type: string

Format:

  • For example, "2"
  • Permissible characters: "1234567890"
  • Max 4 byte integers.

Here is a sample XML response with the requested license information:

<B2bForceUpdateSummaryVO> <targetFirmwareVersion>G739FXXU0APE2/G739FOXA0NPE2/G739FXXU0APE2</targetFirmwareVersion> <processingCount>5</processingCount> <successCount>91</successCount> <failedCount>2</failedCount> </B2bForceUpdateSummaryVO>

Error response

If the REST API call is unsuccessful, the E-FOTA server could return the following error codes:

Error Type Error code
Parameter Error FUD_1001
  FUD_1002
  FUD_1004
  FUD_1024
Processing Error FUD_3016
  FUD_3017
  FUD_3018
  FUD_3020
  FUD_3021
  FUD_3022
  FUD_3038
Service Error FUD_9001
  FUD_9003

To review more error codes, visit the troubleshooting section of the guide.

Here is a sample error response:

<error> <code>FUD_1001</code> <message/> <resource>com.samsung.efota.mdm.service.v2.MDMDeviceServiceResourceImpl</resource> </error>