Menu

licenseInfo

Description: API returns information about the E-FOTA license.

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

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

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 as follows:

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.

Example

Here's a sample request for license information:

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

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

activePeriod

Identifies the date range for which the license was active.

Data type:string

Format:

  • For example, "2018-03-08~2018-09-21".
  • Permissible characters: "1234567890-~"
  • Max 30 byte string.
licenseStatus

The current status of the E-FOTA license. Provides one of the following status:

  • Normal—License was activated successfully.
  • Not Active—License is not yet activated.
  • Cancelled—Licence was cancelled by the enterprise customer.
  • Terminated—Licence has expired.

Data type: string

Format:

  • All characters permitted.
  • Max 20 byte string.
licenseType

The E-FOTA license you got from the E-FOTA server when you requested your REST API key.

Format:

  • License type is one of the following:
    1. "SA"—E-FOTA stand alone license (original E-FOTA license)
    2. "EE"—E-FOTA license for Enterprise Edition devices.
  • All characters permitted.
  • Max 4 byte string.
purchasedQuantity

Provides the number of purchased licenses. Note that the response will be "N/A" if the license is an EE license.

Data type: string

Format:

  • For example, "700".
  • All characters permitted.
  • Max 10 byte integers.
remainingQuantity

Provides a count of available/unused licenses remaining. Note that the response will be "N/A" if the license is an EE license.

Data type: string

Format:

  • For example, "150".
  • All characters permitted.
  • Max 10 byte integers.
blockedDeviceCount

Provides a count of devices blocked from enrolling to E-FOTA.

Data type:string

Format:

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

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

<B2bLicenseInfoVO> <activePeriod>2018-03-08~2018-09-21</activePeriod> <licenseStatus>Not Active</licenseStatus> <licenseType>SA</licenseType> <purchasedQuantity>700</purchasedQuantity> <remainingQuantity>770</remainingQuantity> <blockedDeviceCount>20</blockedDeviceCount> </B2bLicenseInfoVO>

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
Processing Error FUD_3018
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>