Response formats

Modified on: 2015-05-06 14:04:14 UTC

The "resp_format" (Response Format) parameter in an API call allows you to specify on a per-query basis which response format you prefer. This field is optional, and if you do not include it, the default from your account will be used.

Note: If you're developing an application or service that may be used by multiple TrueCNAM account holders, you should choose which format (and type) you want to use, include it in every query in your application/service, and not allow the default value of an account to be chosen.

The valid values for this parameter are: 

A. "csv" - Comma-Separated Value format. This is essentially plain-text, with each field separated by a comma. It is the shortest in terms of data you will receive and is easily parsable, but isn't as readable by humans as you need to know where each value is in the separated string. If you need to receive a CSV format or are comfortable with CSV, then choose this, otherwise we suggest you use JSON instead.

B. "json" - JavaScript Object Notation format. If you have a choice, we recommend you use JSON as it is easily parsable, is widely supported, and is easy to read when debugging.

C. "xml" - Extensible Markup Language format. If you use XML already, choose this format. If not, consider JSON instead.

Here's an example of a CNAM query which includes the "resp_format" field specifying json as the format:

Next, see API Best Practices.

Did you find it helpful? Yes No

Can you please tell us how we can improve this article?