Hi Deema,

there is a video which look usefull for your case: Use case: CoinMarketCap API Integration - DataMiner Dojo

• What parameters do I need to capture from the API response?
  • You need at least one param for the response and another one for the Response Status Code
• How should I structure error logging and handling?
  • This depends on how you response data is structured a what do you need out of it
• What’s the best way to handle this in a QAction or a trigger?
  • When you receive the response this can trigger a QAction, inside the QAction you Get the parameters where Status Code and Response are stored into variables
  • Then you could work like if (statuscode != 200) to handle error response separately from normal responses
  • If you have e.g. JSON data in your response you could desiralize it with Newtonsoft.Json
  • Then you could store parts of the response you need in parameters of your choice
    • you could store it into a code and a message param, also could split the message into multiple params
    • yoiu could store it in a table to store every errored request (dont forget a cleaning mechanism to not have a endless growing table)
  • dont forget to clean status code and response parameters after response, as the QAction will not triggered again if you have exactly the same response+status code, e.g.:
    • protocol.CheckTrigger(123); in your response (123 is an example which id yur trigger has
    • trigger id 123 type action and content is the id of the action
    • action 123 with <On id="59;60" (your parameter ids to clear)>parameter</On><Type>clear</Type>
• Should I create a dedicated error-handling QAction?
  • You should work at least with try/catch blocks to write QAction errors in the element log file, the rest depends on your needs

Hi Deema,

1. How should I define this error structure in my protocol?
   • What parameters do I need to capture from the API response?
     • the code to check if it is a valid http call and the content/error message
   • How should I structure error logging and handling?
     • you could display the error message via the protocol.log (if using a qaction) alternatively could set an exception value to the parameter that the api response is updating
2. How should I implement this in my protocol (from parameter to trigger to QAction)?
   • What’s the best way to handle this in a QAction or a trigger?
     • if you are already going to process the response in a QAction, you could check the HTTP code there. Since we do not know what is the HTTP code, you could test it by trying to send an invalid request to the device to check the HTTP code that it gives.

       Alternatively you could also to process the response only if your HTTP code is '200'

       if you are not going to process the response in a qaction, you could have an after trigger with a condition to check if you got an error and do any follow up action like setting an exception value to a parameter

   • Should I create a dedicated error-handling QAction?
     • • you could create a generic error handling in the precompile QA to share code which would allow you to reduce duplicate code to process exceptions for other http calls

I hope these answers help