Result Codes

The UltronSMART Cloud API uses two categories of result codes to indicate the status of different operations:

  1. SkuResult - Product/SKU data operations
  2. CmdResult - Device command operations

SkuResult Codes

Used for product catalog, SKU database, and metadata operations.

CodeNameDescription
0SuccessOperation completed successfully
50PartialSuccessOperation partially completed
101DeniedAccess denied
102DisabledFeature or service disabled
103NotSupportedOperation not supported
104IntentFailedIntent processing failed
105NotSupportedDeviceDevice not supported
201InvalidInvalid input data
202InvalidIdInvalid ID format
203InvalidSNInvalid serial number
204InvalidNameInvalid name format
205InvalidKeyInvalid key format
206InvalidVersionInvalid version
207InvalidLangInvalid language code
208InvalidCmdInvalid command
209InvalidModelInvalid model
210InvalidConfigInvalid configuration
211InvalidConnTypeInvalid connection type
212InvalidMACInvalid MAC address
213InvalidSensorTypeInvalid sensor type
214InvalidOuiInvalid OUI
215InvalidTitleInvalid title
216InvalidBodyInvalid body content
217InvalidSerialInvalid serial format
218InvalidTimezoneInvalid timezone
219InvalidPSKInvalid PSK
220InvalidSSIDInvalid SSID
221InvalidRangeInvalid range
222InvalidUidInvalid user ID
223ImageNotSupportedImage format not supported
224InvalidMatterQRCodeInvalid Matter QR code
225InvalidMatterDeviceInvalid Matter device
226UncertifiedMatterDeviceUncertified Matter device
227InvalidPhoneNumberInvalid phone number
228InvalidContactEmailInvalid contact email
229InvalidNullValueInvalid null value
277GroupTicketNotSupportedQRCodeGroup ticket QR code not supported
278SubscriptionLastBillingCyleSubscription last billing cycle
301NotFoundResource not found
302AlreadyExistedResource already exists
303NonEmptyResource is not empty
318ActiveSubscriptionExistsActive subscription already exists
321TimeoutOperation timeout
322OutOfProductQuantityOut of product quantity
323SubscriptionInactiveSubscription inactive
324ZohoInternalErrorZoho internal error
325ZohoMultipleUserErrorZoho multiple user error
500ServerErrorServer error
501DataErrorData error
502WriteErrorWrite operation error

CmdResult Codes

Used for device command execution and control operations.

CodeNameDescription
0SuccessCommand executed successfully
100DeviceNotFoundDevice not found
101DeviceNotBoundDevice not bound to user
102DeviceNotActivatedDevice not activated
103AccessDeniedAccess denied
104NotSupportedCommand not supported
105InvalidParamsInvalid parameters
106DeviceOfflineDevice is offline
107NotAsyncCmdNot an async command
108AsyncEnqueueFailedAsync command enqueue failed
110TaskInvalidTask invalid
111TaskEnqueueFailedTask enqueue failed
112QuotaExceededQuota exceeded
113QuotaExceededActionDisabledQuota exceeded, action disabled
200GroupNotFoundGroup not found
201GroupDeniedGroup access denied
202GroupFailedGroup operation failed
210GroupMergeFailedGroup merge failed
211GroupMergeSceneFailedGroup merge scene failed
212GroupMergeAutomationFailedGroup merge automation failed
280SignInNotFoundSign in not found
281SignInDeniedSign in denied
300ServerErrorServer error
400TwoFactorAckChallengeTwo-factor acknowledgment challenge
401TwoFactorPinChallengeTwo-factor PIN challenge
402PinIncorrectPIN incorrect
403FailedPinNeededFailed, PIN needed
404AsyncTwoFactorAsync two-factor

Usage Examples

Check the result code in API responses to determine operation status:

Success Response:

{
  "result": 0,
  "data": { ... }
}
{
  "error": 0,
  "data": { ... }
}
{
  "data": { ... } // error or result field is omitted when = 0(SUCEESS)
}

Error Response:

{
  "error": <Non-Zero-Value>,
  "data": { ... }
}
{
  "result": <Non-Zero-Value>
  "data": { ... }
}