API Documentation does not state possible return values

Completed

Comments

4 comments

  • Avatar
    James Fleming

    This has been biting me, too: there's only so much you can infer from a single example of what might be returned.

    Where the return message might include integers and two or more booleans, it would be very helpful to know what they actually indicate. If we knew that, we could write code that's much smarter about handling them.

    0
    Comment actions Permalink
  • Avatar
    James Fleming

    Oops. I found most of that information at the top of the page: http://api.device42.com/#response-amp-status-messages.

    For completeness, it'd still be nice to know what the non-zero return codes mean.

    0
    Comment actions Permalink
  • Avatar
    Raj Jalan

    Hi James,

    Thanks for finding and clarifying that :). Regarding codes, it is really for troubleshooting for us(Device42 support team). No real meaning for your call.

    Regards,

    Raj

    0
    Comment actions Permalink
  • Avatar
    James Fleming

    ...or is that the list of codes at the bottom?

    http://api.device42.com/#error-codes looks like it. Perhaps a tweak to the phrasing in the Status Messages section at the top, to make the meaning and connection clearer?

    Maybe something along the lines of "Code 0 = success, which equates to 'HTTP/1.1 200 OK'. All other responses..."

    0
    Comment actions Permalink

Please sign in to leave a comment.