Test
This section describes the test function.
GET /test
This method performs a test of the operation of the main components of the API (client and reports).
Request parameters:
- company [required]: Company name or ID.
Response:
- status: returns "0" on success and an error code otherwise.
- data: Returns the status of the client and reports components. The status can be true (working correctly) or false (failed).
- message: "Success" in case of success or a descriptive information of the error in any other case.
Example:
Request: {"type":"get", "url":"test", "data":"company=testco"} Reponse (success): {"status":"0", "data":{"client":true,"reports":true}, "message":"Success"} Reponse (error): {"status":"1000", "data":"<a href='http:\/\/mayen19\/edinnM2\/help\/en\/API_Test.html'>for additional information follow this link<\/a>", "message":"Some parameters are missing"} |