Description
Converts a JSON (JavaScript Object Notation) string data representation into CFML data, such as a CFML structure or array.
Returns
The data value in ColdFusion format: a structure, array, query, or simple value.
Category
Syntax
DeserializeJSON(JSONVar[, strictMapping, useCustomSerializer, preserveCaseForStructKey])
See also
IsJSON, SerializeJSON, cfajaxproxy , Using Ajax Data and Development Features in the Developing ColdFusion Applications, http://www.json.org
History
- ColdFusion 11: Added the parameter useCustomSerializer.
- ColdFusion 8: Added this function.
Parameters
Parameter |
Description |
|---|---|
JSONVar |
A valid JSON string expression. |
strictMapping |
A Boolean value that specifies whether to convert the JSON strictly, as follows:
|
| useCustomSerializer | true/false. Whether to use the customSerializer or not. The default value is true. The custom serializer will always be used for deserialization. If false, the JSON deserialization will use the default ColdFusion behavior. |
Usage
This function is useful any time a ColdFusion page receives data as JSON strings. It is useful in ColdFusion applications that use Ajax to represent data on the client browser, and lets you consume JSON format data from the client-side Ajax JavaScript. You can also use it on pages that get data from services that supply data as JavaScript function calls with JSON parameters. The DeserializeJSON function converts each JSON data type directly into the equivalent ColdFusion data type, as follows:
- If the strictMapping parameter is true (the default), all JSON objects become CFML structures.
- If the strictMapping parameter is false, ColdFusion determines if JSON objects represent queries and, if so, converts them to ColdFusion query object. All other JSON objects become ColdFusion structures. The DeserializeJSON function recognizes a JSON structure as a query and converts it properly if the structure uses either of the two query representation formats described in the SerializeJSON reference.
- JSON Arrays, Strings, and Numbers become ColdFusion arrays, strings, and numbers.
- Since ColdFfusion 10, JSON null values become undefined.
- JSON string representations of a dates and times remain strings, but ColdFusion date/time handling code can recognize them as representing dates and times.
Note: Bracket and dot notation also work. The index value changes depending on the order of the item.
Example
The following example parses JSON data and converts the JSON data into a ColdFusion structure.
<cfscript>
record=deserializeJSON(
'{
"firstname": "John",
"lastname": "Smith",
"age": "36",
"address":{
"number":"12345",
"street":"my_street",
"city":"any city"
}
}'
);
writeOutput(record.firstname & " ");
writeOutput(record.lastname & " ");
writeOutput(record.address.number & " ");
writeOutput(record.address.street & " ");
</cfscript>
Expected output:
John Smith 12345 my_street
