Glossary for ResultCodes
Problem reported by Alrik Olson - June 7, 2017 at 2:09 PM
Being Fixed
The current SmarterMail API docs do not describe what the different ResultCodes (int) represent. When I am dealing with the SOAP API, I have no way of knowing what, say, "-6" means when I get a response from the API.
 
Is there any plan to document what the different ResultCodes mean?

3 Replies

Reply to Thread
0
Andrea Rogers Replied
Employee Post
Hi Alrik,
 
The current documentation for the API is a work in progress as we finalize those web service calls. When it's complete, it'll include the ResultCode definitions. You can check out an example of one section that's been completed here: 
 

Andrea Rogers
Communications Specialist
SmarterTools Inc.
(877) 357-6278

www.smartertools.com

0
Alrik Olson Replied
Is there no reference anywhere for the legacy API's "ResultCode" and what they mean?

I can do my best to infer from the error messages the API provides, but the only documentation on "ResultCode" consists of "A result code, which differs by function."
0
Andrea Rogers Replied
Employee Post
I've heard back that the final documentation of the API should include these result codes definitions. That said, you shouldn't necessarily need to look at those directly, as the reason why a call failed would be included in the SOAP message string that's returned. For example, the call that's returned would say: "Invalid permissions." or "Failed to get the subscriber list". 

Andrea Rogers
Communications Specialist
SmarterTools Inc.
(877) 357-6278

www.smartertools.com

Reply to Thread