Menu

serverInit

Description: API pushes a force firmware update for E-FOTA devices in a specified time period.

URL:https://eu-api.samsungknox.com/b2bfota/v1/serverInit

HTTP Method:POST

SSL Required: Yes

Since: E-FOTA version 1

Request

POST https://eu-api.samsungknox.com/b2bfota/v1/serverInit

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-Type application/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.
groupId

A device group identified by the enterprise IT admin. The IT admin might want to identify separate groups for different firmware updates. For example, there might be a test group of devices for the initial firmware deployment. Or, there can be a group for each Samsung device model being used in an organization.

Data type: string

Format:

  • For example, "EMMGID12312323" a group name assigned by the enterprise IT admin on the MDM console..
  • All characters permitted, all lower case letters are treated as upper case letters.
  • 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 you want to get the firmware info for.

Data type: string

Format:

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

carrierCode

The consumer software customization code for the device carrier.

Data type: string

Format:

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

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

Data type: string

Format:

  • For example, "G930FXXU1DQB3/G930FOXA1DQB1/G930FXXU1DQB1"
  • All characters permitted.
  • Max 100 byte string.

deliveryStartDate

The date set by the IT admin to start pushing the update to the devices.

Data type: string

Format:

  • Format: yyyymmd, for example, "20160601"
  • Permissible characters: "0123456789"
  • Max 20 byte string.

deliveryEndDate

The date set by the IT admin to finish pushing the update to the device group. Note that this can be set up to a maximum of 7 days from the start date.

Format:

  • Format: yyyymmd, for example, "20160608"
  • Permissible characters: "0123456789"
  • Max 20 byte string.

dailyStartHour

The time set by the IT admin to start the update push each day during the update period defined by the start and end dates.

Data type: string

Format:

  • Format: A two digit number, for example, 01 for 1:00 am.
  • Permissible characters: "0123456789"
  • Max 4 byte integer.
dailyEndHour

The time set by the IT admin to end the update push each day during the update period.

Data type: string

Format:

  • Format: A two digit number, for example, 04 for 4:00 am hour.
  • Permissible characters: "0123456789"
  • Max 20 byte integer.

Example

Here is a sample request to force a firmware update associated with a group of devices:

<B2bServerInitVO> <mdmId>d1e2f3g4h5</mdmId> <customerId>EEEE4444-FF55-AA66-BB77-CCCCCC888888</customerId> <groupId>Test Device Group</groupId> <license>EFOTA1-fff555-ggg666-hh77</license> <deviceModelName>GT-S8500A</deviceModelName> <carrierCode>QA4</carrierCode> <targetFirmwareVersion>G930FXXU1DQB3/G930FOXA1DQB1/G930FXXU1DQB1</targetFirmwareVersion> <deliveryStartDate>20160601</deliveryStartDate> <deliveryEndDate>20160608</deliveryEndDate> <dailyStartHour>01</dailyStartHour> <dailyEndHour>04</dailyEndHour> </B2bServerInitVO>

Response

If the API call is successful, the E-FOTA server returns HTTP/1.1 200 OK.

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_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> <resource>com.samsung.efota.b2b.service.B2BDeviceServiceResourceImpl</resource> </error>