API Server Command Results

The Uptivity API Server can be utilized by any program that can communicate over HTTP. Result messages are displayed in a simple and descriptive XML format. For more information, see API Overview.

All messages reply with a minimum of a root tag called RESULT. This tag contains the REQUESTID that was sent, as well as a RESULTTYPE, RESULTCODE and a RESULTMSG.

<RESULT>

<REQUESTID>1</REQUESTID>

<RESULTTYPE>API_OK</RESULTTYPE>

<RESULTCODE>20</RESULTCODE>

<RESULTMSG>API_OK</RESULTMSG>

</RESULT>

If the result is an error condition, the RESULTTYPE will be ERROR, the RESULTCODE will contain a code for the error, and the RESULTMSG may contain more detail about the error.

<RESULT>

<REQUESTID>1</REQUESTID>

<RESULTTYPE>ERROR</RESULTTYPE>

<RESULTCODE>17</RESULTCODE>

<RESULTMSG> API_ERROR_NO_DEFAULT_RECORDING_PATH</RESULTMSG>

</RESULT>

If the result is a non-error condition, the RESULT node will also contain a sub node containing data specific to the request that was made.

Result Codes/Result Types

See Also