WSResultStatus - accountsIQ/API-Wiki GitHub Wiki
There are two different result class returned by the API calls: WSResultStatus and WSResult2OfXXXX where XXXX is the type of real result.
This class is returned by web service calls where a modifying action is executed such as Save, Update or Create; the value returned reflects the status of the operation.
When you use a method the you should check the Status field - if its not Success or Created (for new items) then you should examine the ErrorMesssage to see details of the failure.
The following table presents the different properties available on class.
Note
:
All properties are read-only.
Property | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ErrorCode | VisorExceptionCodes | Please refer to the VisorExceptionCodes list for a precise description of each code. | ||||||||||||
ErrorMessage | String | The message associated with any error that happened. | ||||||||||||
HasExpired | Boolean | If this flag is set, the token has expired. You need to re-login before attempting to call the web service again. | ||||||||||||
Status | OperationStatus |
The Status can be any of the of the following:
|
This class is returned by web service calls where a retrieving action is executed such as Load, GetList...
The following table presents the different properties available on class.
Note
:
All properties are read-only.
Property | Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
ErrorCode | VisorExceptionCodes | Please refer to the VisorExceptionCodes list for a precise description of each code. | ||||||||||||
ErrorMessage | String | The message associated with any error that happened. | ||||||||||||
HasExpired | Boolean | If this flag is set, the token has expired. You need to re-login before attempting to call the web service again. | ||||||||||||
Result | T | Contains the result of the operation. | ||||||||||||
Status | OperationStatus |
The Status can be any of the of the following:
|