Platform Error Responses

When hitting the Device APIs there are a number of built in error codes that may be thrown back to a device in an acknowledgement depending on the functionality the device is attempting to execute. The table below provides details on the names of each platform error and a brief description about what causes the error to be thrown.

Platform Errors

Error Name	Description	Example
platform_event_validation_error	General Platform Event error. Returned when the message payload is incorrect and does not pass validation.	Invalid model format has been sent in the payload.
http_response_error	Non-transient error in HTTP service.	Error while creating object model in Information Model.
not_authorized	Returned when operation for a given model is not authorized.	This currently can happen when created/updated/deleted/synced model is not owned by a valid owner (i.e. ownerId and path do not match the ones present in IoTHub).
timeout_exceeded	Used to indicate that action processing did not complete within requested amount of time.	User requested the D2C action to be processed by DCS in 10 seconds maximum, but the operation takes longer to complete. DCS will send back the ack with this error code to indicate this fact.
operation_not_supported	Returned for not supported Platform requests.	Not implemented features.
internal_platform_error	Internal Platform Error is returned when unexpected/unknown errors occur.	Unexpected error.
response_too_large	Response too large is returned when the response from the TDR is too large to process by DCS	TDR returned response that is 10 MB but DCS is capable of processing 5 MB TDR response
decompression_error	Request message cannot be decompressed by Ability Platform	Invalid compression algorithm has been used or the implementation of compression is invalid
batch_execute_operation_error	Appears when one of the individual 'batch.execute' actions fails to process	One of the batch actions failed to process. The following actions were skipped