API Documentation discrepancies



Hi Support,




Looking through the API reference, I have noticed some discrepancies. One of these is specific to a certain call (https://carecanada.freshservice.com/helpdesk/tickets.json) and the other is more generall (all excerpts taken from http://api.freshservice.com/):




https://carecanada.freshservice.com/helpdesk/tickets.json:


Your documentation claims that the output looks like this: 


{
"helpdesk_ticket":{
"cc_email":{
"cc_emails":[


....




When in fact it looks like this:


[


      {"cc_email":{


            "cc_emails":


.....




I did some digging, and this output is actually the output one would expect using the FreshDesk V2.0 API, but I was under the impression that FreshService and FreshDesk were separate products. Please explain.




General:


"Freshservice APIs have been implemented as plain XML or JSON over HTTP and use the following REST Commands:" 




This is entirely false. Trying to use XML returns:


"<hash>


 <message>Currently XML is not available! , Please try JSON</message>




</hash>"





When will XML be supported?



This topic has been closed for comments

4 replies


A month and no response? Any feedback about this?



Hey Adam,

Sorry for delayed response.

When you append .JSON to a ticket URL, the response looks like the one below.

{"helpdesk_ticket":{"cc_email":{"cc_emails":[],"fwd_emails":["rajagopal \u003Crajagopal.b@freshdesk.com\u003E"],"reply_cc":[],"tkt_cc":[]},"created_at":"2016-06-28T09:00:12-

Please find the screenshot below.




Regarding the XML support, we had both JSON and XML support, later the XML support was removed due to some security reasons.

Also, The API V2.0 is not supported in Freshservice as of now.

Hope this helps, feel free to write back to support@freshservice.com for further support.


Regards,


Jayesh





Yes, I figured out that those were all the case. But I had to figure it out because your documentation had incorrect information in it., rendering it essentially useless as a tool.


Userlevel 4
Badge +5

Hi Adam,




We have updated the API documentation. Thanks for bringing this to our notice.




Thanks,


Rajagopal