Menu

groupRegister

Description: API to register a group of devices associated to a group ID to an E-FOTA license.

Prerequisite: License must be active.

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

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/groupRegister

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

Example

Here's a sample request for registering a group of IDs and licenses to E-FOTA:

<B2bGroupRegisterVO> <mdmId>d1e2f3g4h5</mdmId> <customerId>EEEE4444-FF55-AA66-BB77-CCCCCC888888</customerId> <groupId>EMMGID12312323</groupId> <license>EFOTA1-fff555-ggg666-hh77</license> </B2bGroupRegisterVO>

Response

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

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_1003
  FUD_1004
Processing Error FUD_3017
  FUD_3018
  FUD_3019
  FUD_3020
  FUD_3021
  FUD_3022
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>