REST

Top  Previous  Next

Crash Magic supports a REST (REpresentational State Transfer) interface to provide access to the full RemoteAccess API.

The REST endpoint is <server>/REST/3.9S (i.e. www.GovernmentTools.com/REST/3.9S

 

Version 3.9S

This version of the REST interface is a port of the existing SOAP interface.  As a result, it utilizes URL parameters rather than paths to make function calls.

All REST calls return an ErrorMsg value indicating the success of the call. A non-blank value indicates an error.

All REST calls return the name of the function called as well as the server name.

The RF parameter indicates the desired return format (HTML, XML, JSON)

 

Example request with JSON response

Request:

http://demo.governmenttools.com/crashMagicOnline_ISAPI.dll/REST/Login?UserGroup=AZ@Mesa&UserLogin=Pete&rf=JSON

Response:

{

 "Handle":"",

 "Error":"EcmRA_Base: Login\n EcmRA_Base: InternalDecryptPassword\n EcmRA_Base: Encrypted password is blank\n ",

 "Function":"Login",

 "Server":"Crash Magic Online"

}

Example request with XML response

Request:

http://demo.governmenttools.com/crashMagicOnline_ISAPI.dll/REST/Login?UserGroup=AZ@Mesa&UserLogin=Pete&rf=JSON

Response:

<pdroot>        

 <Response>

         <Handle/>

         <Error>EcmRA_Base: Login EcmRA_Base: InternalDecryptPassword EcmRA_Base: Encrypted password is blank </Error>

         <Function>Login</Function>

         <Server>Crash Magic Online</Server>

 </Response>

</pdroot>