Menu

forceUpdate

Description: API pushes a force update to a list of E-FOTA devices.

Prerequisite:setB2bGroupRegister(), setAllowedFOTAVersion(), and an active license.

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

HTTP Method:POST

SSL Required: Yes

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

Request

POST https://eu-api.samsungknox.com/b2bfota/v2/forceUpdate

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.
deviceModelName

The model number of the device for which you want to get the firmware info.

Data type: string

Format:

  • SM-xxxx format, for example, "GT-S8500A"
  • Permissible characters: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-"
  • Max 20 byte string.
salesCode

The consumer software customization code for the device carrier. Previously called carrierCode in E-FOTA version 1.

Data type: string

Format:

  • Format example: "ABC"
  • Permissible characters: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789".
  • Max 20 byte string.
targetFirmwareVersion

The target firmware version to push to the device. Note that to force update to the latest version available, set to Latest.

Data type: string

Format:

  • For example, "G739FXXU0APE3/G739FOXA0NPE3/G739FXXU0APE3"
  • All characters permitted.
  • Max 100 byte string.

networkType

The IT admin can set the network type for when the device will accept the push update. Note that if set to "WIFIONLY" and the device is on a cellular network, the device will ignore the push force update until device connects to Wi-Fi

Data type: string

Format:

  • For example, "WIFIONLY" , or "ANY".
  • Permissible characters: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
  • Max 10 byte string.
deviceList

Device list of up to 100 devices for each API call. Contains serialNumber.

Data type: complexType

serialNumber

An 11 digit Samsung device serial number.

Data type: string

Format:

  • For example, "R12A34B4CD1".
  • Permissible characters: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789" and all lower case characters are treated as upper case.
  • Max 40 byte string.

Example

Here is a sample request:

<B2bForceUpdateVO> <mdmId>d1e2f3g4h5</mdmId> <customerId>EEEE4444-FF55-AA66-BB77-CCCCCC888888</customerId> <license>EFOTA1-fff555-ggg666-hh77</license> <deviceModelName>GT-S8500AA</deviceModelName> <salesCode>QA4</salesCode> <targetFirmwareVersion>G739FXXU0APE3/G739FOXA0NPE3/G739FXXU0APE3</targetFirmwareVersion> <networkType>ANY</networkType> <deviceList> <serialNumber>C08900518981610</serialNumber> <serialNumber>C78987898789878</serialNumber> <serialNumber>C11111111111111</serialNumber> </deviceList> </B2bForceUpdateVO>

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

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.

Here's an XML sample response:

<B2bForceUpdateVO> <forceUpdateId>12310180309-JEA12345678</forceUpdateId> </B2bForceUpdateVO>

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_1005
  FUD_1006
  FUD_1007
  FUD_1008
  FUD_1013
  FUD_1018
  FUD_1019
  FUD_1022
Processing Error FUD_3013
  FUD_3014
  FUD_3015
  FUD_3016
  FUD_3017
  FUD_3018
  FUD_3020
  FUD_3022
  FUD_3021
  FUD_3030
  FUD_3031
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>