Troubleshooting Knox E-FOTA

The Knox E-FOTA API uses the conventional HTTP response code to indicate the success or failure of a request. A `2XX` response code indicates success, a `4XX` response code indicates an error given the inputs of the request, and a `5XX` response code indicates a failure with the Knox E-FOTA platform.

In addition, errors will contain a JSON response body with more information about the error.

HTTP/1.1 200 OK

Content-Type: application/json

    {
        "result" : "SUCCESS",
        "objectId" : "SDAKJ23DKCMSDAKENXSSAEQ",
        "requestedId": "111000291332456"
    }

Async result : POST /api/v1/transaction

HTTP/1.1 200 OK

Content-Type: application/json

    { 
        "count":3,
        "success":2,
        "fail":1,
        "resultList":[ 
            { 
                "result":"FAIL",
                "requestedId":"123456789012347",
                "error":{ 
                    "code":"4000000",
                    "message":"RESOURCE_INVALID_PARAM",
                    "reason":"RESOURCE_INVALID_PARAM"
                }
            }
        ]
    }

HTTP/1.1 401 Unauthorized

Content-Type: application/json

    { 
       "result":"FAIL",
       "error":{ 
          "code":4010000,
          "message":"AUTHORIZATION_FAIL",
          "reason":"Invalid Api Key"
       }
    }

Parameter errors

Error code	Cause of Error	HTTP Status Code	Troubleshoot
FUD_1001	The mandatory `mdmId` parameter is missing or exceeds the length limit (Max 50 bytes string).	400 Bad Request	Enter the `mdmId` parameter you received from SLM. Ensure that this parameter is under 50 bytes.
FUD_1002	The mandatory `customerId` parameter is missing or exceeds the length limit (Max 50 bytes string)	400 Bad Request	Enter the`customerId` parameter you received from the SLM. Ensure that this parameter is under 50 bytes.
FUD_1003	The mandatory `groupId` parameter is missing or exceeds the length limit (Max 50 bytes string)	400 Bad Request	Enter the `groupId` parameter, which should be unique to one licence and can be generated by the IT admin. Ensure that this parameter is under 50 bytes.
FUD_1004	The mandatory `license` parameter is missing or exceeds the length limit (Max 100 bytes string).	400 Bad Request	Enter the`license` parameter you received from SLM. Ensure that this parameter is under 100 bytes.
FUD_1005	The mandatory `deviceModelName` parameter is missing or exceeds the length limit (Max 20 bytes string).	400 Bad Request	Check that `deviceModelName` is entered and confirm that the correct name is entered on the console. Ensure that this parameter is under 20 bytes.
FUD_1006	An invalid character is found in the `deviceModelName` parameter.	400 Bad Request	Check that `deviceModelName` is entered and confirm that the correct name is entered on the console. Check that the strings entered for `deviceModelName` is valid: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"
FUD_1007	The mandatory `salesCode` parameter is missing or exceeds the length limit (Max 20 bytes string)	400 Bad Request	Check that `salesCode` is entered and confirm that the correct name is entered on the console. Ensure that this parameter is under 20 bytes. A common cause of this error is entering `carrierCode` instead of `salesCode` when using Knox E-FOTA v2 APIs
FUD_1008	An invalid character is found in the `salesCode` parameter.	400 Bad Request	Check that `salesCode` is entered and confirm that the correct name is entered on the console. Check that the strings entered for `salesCode` is valid: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789"
FUD_1009	The mandatory `currentFirmwareVersion` parameter is missing or exceeds the length limit (Max 100 bytes string).	400 Bad Request	Check that `currentFirmwareVersion` is entered and confirm that the correct name is entered on the console. Ensure that this parameter is under 100 bytes.
FUD_1010	An invalid character is found in the `currentFirmwareVersion` parameter.	400 Bad Request	Check that `currentFirmwareVersion` is entered and confirm that the correct name is entered on the console. Check that the strings entered for `currentFirmwareVersion` is valid: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-/._"
FUD_1011	The `languageCode` parameter exceeds the length limit (Max 20 bytes string)	400 Bad Request	Check that `languageCode` is entered and confirm that the correct name is entered on the console. Ensure that this parameter is under 20 bytes.
FUD_1012	An invalid character is found in the `languageCode` parameter.	400 Bad Request	Check that the strings entered for `languageCode` is valid: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-"
FUD_1013	The mandatory `targetFirmwareVersion` parameter is missing or exceeds the length limit (Max 100 bytes string).	400 Bad Request	Enter the`targetFirmwareVersion` parameter you received from the Knox E-FOTA server with `getB2bFirmwareList`.Ensure that this parameter is under 100 bytes.
FUD_1014	The `deliveryStartDate` parameter is missing or the date format is invalid.	400 Bad Request	Set a valid date format for this parameter: ((GMT)YYYYMMDD), for example (GMT)20171123.
FUD_1015	The `deliveryEndDate` parameter is missing or the date format is invalid	400 Bad Request	Set a valid date format for this parameter: ((GMT)YYYYMMDD), for example (GMT)20171123.
FUD_1016	The `dailyStartHour` parameter is missing or the time format is invalid.	400 Bad Request	Set a valid time format for this parameter: ((GMT)24HH), for example, (GMT)24HH.
FUD_1017	The `dailyEndHour` parameter is missing or the time format is invalid.	400 Bad Request	Set a valid time format for this parameter: ((GMT)24HH), for example, (GMT)24HH.
FUD_1018	The `serialNumber` parameter is missing or exceeds the length limit (Max 100 bytes string).	400 Bad Requests	Check that `serialNumber` is entered and confirm that the correct number is entered on the console. Note that the device count must be between 1 to 100.
FUD_1019	An invalid character is found in the `serialNumber` parameter.	400 Bad Request	Check that the strings entered for `serialNumber` is valid, for example R12A34B5CD. Valid characters include: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789" Note that "%$&*)(#@!" won't be accepted.
FUD_1020	The `firmwareId` parameter is missing or exceeds the length limit (Max 20 bytes string).	400 Bad Request	Check that `firmwareId` is entered and confirm that the correct ID is entered on the console. Ensure that this parameter is under 20 bytes.
FUD_1021	An invalid character is found in the `firmwareId` parameter.	400 Bad Request	Check that the strings entered for `firmwareId` is valid: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"
FUD_1022	The `networkType` parameter exceeds the length limit.	400 Bad Request	Check that `networkType` is entered. Ensure that this parameter is between 0-20 bytes.
FUD_1023	The `newLicense` parameter is missing or exceeds the length limit (Max 100 bytes string).	400 Bad Request	Check that `newLicense` is entered. Ensure that this parameter is under 100 bytes.

Processing errors

Error code	Cause of Error	HTTP Status Code	Troubleshoot
FUD_3001	The `deliveryEndDate` parameter is set before the `deliveryStartDate`.	400 Bad Request	Enter a date parameter for `deliveryEndDate` that occurs after `deliveryStartDate`.
FUD_3002	The `deliveryEndDate` parameter is set less than 3 days and more than 7 days after `deliveryStartDate`.	400 Bad Request	Enter a valid `deliveryEndDate` parameter within the permissible range of 3-7 days. Example, when `deliveryStartDate` is (GMT)20171101, then `deliveryEndDate` must be set from (GMT)20171104 to (GMT)20171108.
FUD_3003	The `dailyEndHour` is set to the same parameters as `dailyStartHour`.	400 Bad Request	Enter a valid parameter, there must be a time gap between 0 (midnight) to 24 (after midnight) and be within 12 hours after `dailyStartHour`. For example, if `dailyStartHour` is (GMT)01HH, then `dailyEndHour` can be set to any time except (GMT)01HH or any time after (GMT)14HH.
FUD_3004	The `dailyEndHour` is set to occure more than 12 hours after the `dailyStartHour`.	400 Bad Request	Enter a valid parameter, the parameter set must be within 12 hours after `dailyStartHour`. For example, if `dailyStartHour` is (GMT)01HH, then `dailyEndHour` can be set to any time except (GMT)01HH or any time after (GMT)14HH.
FUD_3005	The `deliveryStartDate`and `dailyStartHour` parameter is set before the current date and time.	400 Bad Request	Enter a valid parameter, the parameter set must occur after the current date and time. For example, if the current date is (GMT)20171101 and the current time is (GMT)10HH, then the `deliveryStartDate` can be set to after (GMT)20171101 and `dailyStartHour` can be set to after (GMT)10HH.
FUD_3011	The following combination of IDs aren't registered: MDM, customer, and group.	400 Bad Request	The combination of MDM, customer, and group IDs must be registered into the Knox E-FOTA server in order to proceed. Verify that the parameters entered for `mdmId`, `customerId`, and `groupId` are correctly entered.
FUD_3012	The following combination of IDs aren't registered: MDM and customer.	400 Bad Request	The combination of MDM and customer IDs must be registered into the Knox E-FOTA server in order to proceed. Verify that the parameters entered for `mdmId` and `customerId` are correctly entered.
FUD_3013	An anonymous request was sent to the Server-Init service, or an invalid `groupId` was detected.	400 Bad Request	Verify that `groupId` is valid and set properly. If `groupId` wasn't set for `serverInit` (Knox E-FOTA v1) or `forceUpdate` (Knox E-FOTA v2), the forced update service can't work since it doesn't support anonymous requests.
FUD_3014	The following parameter combinations are invalid: `deviceModelName`, `carrierCode` (Knox E-FOTA v1), or `salesCode` (Knox E-FOTA v2). The model name or carrier code is not registered or mismatched.	400 Bad Request	Verify that `deviceModeName`, `carrierCode` (Knox E-FOTA v1), or `salesCode` (Knox E-FOTA v2) is valid and entered properly. If `deviceModeName`, `carrierCode`, or `salesCode` wasn't registered in the Knox E-FOTA server, or if the values entered don't match, then your request will generate an error message.
FUD_3015	The values entered for `targetFirmwareVersion` is invalid.	400 Bad Request	Verify that the values for `targetFirmwareVersion` is valid and entered properly for the given model and carrier code. You must select an available target firmware version and among the results retrieved with `getB2bFirmwareList`.
FUD_3016	The license entered doesn't match the license registered with MDM and customer ID.	400 Bad Request	Enter a license that matches the one received from the SLM server. Note that the license must match the one registered with MDM and customer ID.
FUD_3017	The license entered has expired.	400 Bad Request	Verify that you've entered the correct license. Check that the license remains valid and has not expired.
FUD_3018	The values entered for `mdmId` and `customerId` doesn't match the one issued.	400 Bad Request	Check that the MDM ID and customer ID entered are the ones issued by SLM at the time the license was purchased.
FUD_3019	The following combination of IDs: MDM, customer ID and group ID is already registered to Knox E-FOTA with another license.	400 Bad Request	While `mdmId` and `customerId` can be the same, ensure that the values entered for `groupId` and `corpId` are different to indicate a different license is being used.
FUD_3020	The license entered has been cancelled.	400 Bad Request	Verify that you've entered the correct license. Check that the license remains valid and has not expired.
FUD_3021	The license entered has been terminated.	400 Bad Request	Verify that you've entered the correct license. Check that the license remains valid and has not expired.
FUD_3022	The license entered is invalid.	400 Bad Request	Verify that you've entered the correct license. Check that the license remains valid and has not expired.
FUD_3023	The requested model name and carrier code has already been registered.	400 Bad Request	Verify that the model name and carrier code hasn't already been registered.
FUD_3024	The firmware ID entered doesn't exist.	400 Bad Request	Verify that you've entered the correct firmware ID. Check that the ID remains valid .
FUD_3026	The firmware ID entered has already been processed.	400 Bad Request	Verify that you've entered the correct firmware ID. Check that the ID remains valid.
FUD_3027	The requested model is invalid and isn't found in the allowed model group.	400 Bad Request	Verify that the model you've entered is correct. Check that the strings entered for the requested model is valid: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_"
FUD_3028	The firmware requested doesn't exist.	400 Bad Request	The requested firmware doesn't exist in the E-FOTA system. Verify that the firmware name entered is valid. Check that the strings entered for firmware name is valid: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-/._"
FUD_3029	The value entered for the `currentFirmwareVersion` parameter is invalid.	400 Bad Request	The firmware version entered is invalid for the given model and sales code. Check that `currentFirmwareVersion` is entered and confirm that the correct name is entered on the console. Check that the strings entered for `currentFirmwareVersion` is valid: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-/._"
FUD_3030	The following parameter combinations are invalid: `deviceModelName`, `carrierCode` (Knox E-FOTA v1) , or `salesCode` (Knox E-FOTA v2).	400 Bad Request	Verify that model, carrier code (Knox E-FOTA v1), or sales code (Knox E-FOTA v2) are valid and entered properly. If the model or sales code wasn't registered in the Knox E-FOTA server, or if the values entered don't match, then your request will generate an error message.
FUD_3031	The serial number entered doesn't match the one registered in the license.	400 Bad Request	Enter a serial number that matches the one registered in the license. Note that the license must match the one registered with MDM and customer ID.
FUD_3032	The new license entered has expired.	400 Bad Request	Verify that you've entered the correct license. Check that the license remains valid and has not expired.
FUD_3033	The following combination of IDs: MDM, customer ID and group ID had not been issued.	30	While `mdmId` and `customerId` can be the same, ensure that the values entered for `groupId` and `corpId` are different to indicate a different license is being used.
FUD_3034	The new license entered has been cancelled.	400 Bad Request	Verify that you've entered the correct license. Check that the license remains valid and has not expired.
FUD_3035	The new license entered has been terminated.	400 Bad Request	Verify that you've entered the correct license. Check that the license remains valid and has not expired.
FUD_3036	The new license entered is invalid.	400 Bad Request	Verify that you've entered the correct license. Check that the license remains valid and has not expired.
FUD_3037	There is an insufficient amount of new licenses available.	400 Bad Request	The number of new licenses must match the number of old licenses already assigned to devices registered by their corp ID. Check the quantity of new licenses available.
FUD_3038	The mandatory parameter `forceUpdateId` is missing or the format entered is invalid.	400 Bad Request	The mandatory parameter forceUpdateId needs to be entered. You obtain this parameter after pushing a `forceUpdate`. Note that the force update ID is valid for 3 months after the force update.
FUD_3039	The license type of the new license doesn't match the previous license.	400 Bad Request	The new license type must be the same as the previous license type.

Service errors

Error code	Cause of Error	HTTP Status Code	Troubleshoot
FUD_9001	Database connection error.	500 Internal Service Error	An error occurred while attempting to connect to the database. Try again later. If the issue persists, log into your Samsung account to send a ticket through Samsung BTSP with the following information: IMEI, Model name, carrier code and a description of the issue for further assistance.
FUD_9003	Internal server error.	500 Internal Service Error	An internal server error occurred. Log into your Samsung account to send a ticket through Samsung BTSP with the following information: IMEI, Model name, carrier code and a description of the issue for further assistance.