Menu

serverInit

On this page

Force a firmware update during a specified time period.

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 XML elements in the body are:

  • mdmId — Identifies your company among other partners in our SEAP program. Format: 10-character alphanumeric string, for example, d1e2f3g4h5.
  • 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. Format: Hyphen-separated 32-character hexadecimal string, for example, EEEE4444-FF55-AA66-BB77-CCCCCC888888. You can get a test customerId when you request an E-FOTA license.
  • groupId — Identifies a device group used by the enterprise customer. An enterprise might want to use different 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. The format is as defined by the enterprise IT admin on the MDM console.
  • license — During development, this is the E-FOTA license you requested from the E-FOTA server. During commercial deployment, this license is purchased from the GSBN (Global Samsung Business Network). For example, EFOTA1-fff555-ggg666-hh77.
  • deviceModelName — The device you want firmware info about, in the format SM-xxxx, for example, GT-S8500A.
  • customerCode —The Consumer Software Customization code for the device carrier, for example, QA4.
  • targetFirmwareVersion — The target firmware version, for example, G930FXXU1DQB3/G930FOXA1DQB1/G930FXXU1DQB1.
  • deliveryStartDate — The date to start pushing the update to the devices in yyyymmdd format, for example, 20160601.
  • deliveryEndDate — The date to stop pushing the update, which can be a maximum of 7 days from the start date in yyyymmdd format, for example, 20160608.
  • dailyStartHour —The time to start the update push each day during the update period defined by the start and end dates, a two digit number, for example, 01 for 1:00 am.
  • dailyEndHour —The time to end the update push each day during the update period, a two digit number, for example, 04 for 4:00 am hour.

Response

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

Example

Here is some sample XML to force a firmware update:

<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> <customerCode>QA4</customerCode> <targetFirmwareVersion>G930FXXU1DQB3/G930FOXA1DQB1/G930FXXU1DQB1</targetFirmwareVersion> <deliveryStartDate>20160601</deliveryStartDate> <deliveryEndDate>20160608</deliveryEndDate> <dailyStartHour>01</dailyStartHour> <dailyEndHour>04</dailyEndHour> <B2bServerInitVO>