Can rest api return xml

hpema108 · April 16, 2017, 7:22pm

Hi,

Is there a way to return and xml string that is not encapsulated in a message json object when cashing the rest api in frappe.

I’m trying to integrate with a telephony system which requires xml as a input after calling a url which I want to host as frappe app. My only challenge is that when I’m returning the xml it gets converted as json message object.

Anyway around this?

Regards
Hemant

makarand_b · April 17, 2017, 2:16am

@hpema108,

currently it is not possible, you can create a custom api’s to change the response from json to xml

hpema108 · April 17, 2017, 12:24pm

Hi Makarand,

I did create a custom method in my app, is this what you mean? How else do I create a custom api in frappe? Cause my custom method still returns json.

Regards

saidsl · April 17, 2017, 12:49pm

@hpema108

This Javascript based method might help:

http://goessner.net/download/prj/jsonxml/

hpema108 · April 18, 2017, 8:05am

Hi @saidsl

This service or custom method I wrote is being called by the telecoms company, I dont have access to there applications to use the javascript. I am building the api to return contact information from my customer database that they require to route a call to the mobile. So trying to build a sort of voip service for my erpnext instance.

If there is not other option right now then I will need to maybe do this outside of erpnext for now.

Thanks for the assist.

regards
Hemant

revant_one · April 18, 2017, 8:28am

The default response is json build_response('json')

github.com

frappe/frappe/blob/develop/frappe/api.py#L129


      
          			if not doc.has_permission("read"):
          				frappe.throw(_("Not permitted"), frappe.PermissionError)
          			frappe.local.response.update({"data": doc.run_method(method, **frappe.local.form_dict)})
          
          
		elif frappe.local.request.method == "POST":
          			if not doc.has_permission("write"):
          				frappe.throw(_("Not permitted"), frappe.PermissionError)
          
          
			frappe.local.response.update({"data": doc.run_method(method, **frappe.local.form_dict)})
          			frappe.db.commit()
          
          
	def get_doc(self):
          		doc = frappe.get_doc(self.doctype, self.name)
          		if not doc.has_permission("read"):
          			raise frappe.PermissionError
          		frappe.local.response.update({"data": doc})
          
          
	def update_doc(self):
          		data = get_request_form_data()
          
          
		doc = frappe.get_doc(self.doctype, self.name, for_update=True)

build_response currently allows json, csv, download, etc.

github.com

frappe/frappe/blob/develop/frappe/utils/response.py#L34


      
          from frappe.utils import cint, format_timedelta
          
          
if TYPE_CHECKING:
          	from frappe.core.doctype.file.file import File
          
          

          
def report_error(status_code):
          	"""Build error. Show traceback in developer mode"""
          	allow_traceback = (
          		cint(frappe.db.get_system_setting("allow_error_traceback")) if frappe.db else True
          	)
          	if (
          		allow_traceback
          		and (status_code != 404 or frappe.conf.logging)
          		and not frappe.local.flags.disable_traceback
          	):
          		traceback = frappe.utils.get_traceback()
          		if traceback:
          			frappe.errprint(traceback)
          			frappe.local.response.exception = traceback.splitlines()[-1]

xml can be added.
By default frappe can keep on serving JSON.
If a header is specified with request, the response can be xml

hpema108 · April 29, 2017, 8:25am

Have not tested this yet but @rmehta made some changed to the develop branch I think…

regards
Hemant