Ping

If this call fails, API credentials are questionable.

Request

Ping Request
apiLoginIDstringRequired>=7 characters<=8 characters
apiKeystringRequired=8 characters

Response

OK
ResponseTypeinteger or null

Response Types include <ul>

  • 0 = Error. Likely invalid API Credentials
  • 1 = Warning. Something is wrong.
  • 2 = Informational. Something could be better
  • <li>3 = SUCCESS! You did it!

    Messageslist of strings or null
    Optional array of messages related to the response.