API Reference
Response Codes
returnCode and errorCode values returned by IM in SOAP responses
returnCode Values
0SuccessThe work order was received, validated, and successfully stored in IM. The service inventory has been updated.
1ErrorThe operation failed. Check errorCode and errorDesc for the specific failure reason. OM should log the full response and trigger its retrial mechanism.
Common errorCode Values
| errorCode | Meaning | Action |
|---|---|---|
| 0 | No error — operation succeeded | None |
| -1001 | Missing required field in request | Check request payload for missing mandatory fields |
| -1002 | Authentication failure (invalid credentials) | Verify authusername / authpassword match IM configuration |
| -1003 | Duplicate flowId — request already processed | Idempotent — safe to ignore if OM sent a retry |
| -1004 | Invalid opertype value | Use Install / Modify / Delete / Query only |
| -1005 | Service type not supported | Verify coverType is ADSL, VDSL, or FTTH |
| -9999 | Internal IM system error | Contact IM support team. OM should trigger retrial. |
📝
Error codes are indicative
The specific errorCode values above are based on common IM patterns. Always refer to the errorDesc field in the response for the definitive human-readable error message.
Retrial Mechanism
IM supports a configurable retrial mechanism for each integration point. When IM returns an error, OM should use this mechanism before escalating:
- •Retrial count and interval are configured per-interface in IM's background config files
- •Huawei provides the configuration guide after development and before deployment
- •Duplicate flowId errors (−1003) are idempotent — safe to skip retrial
- •Internal errors (−9999) should trigger retrial with exponential backoff