Kinetics Query

When species, databanks, redox, and solid phases are correctly specified, equilibrium equations formulated based on the resulting species are available via the kinetics query method.

Request Payload

 {   
	"params": {
	"thermodynamicFramework": "Aqueous (H+ ion)",
	"privateDatabanks": [
		"COR"
	],
	"inflows": [
		{
			"name": "H2O"
		},
		{
			"name": "NACL"
		},
		{
			"name": "FECL3"
		}],
	"phases": [
        	"liquid1",
        	"vapor",
        	"solid", 
        	"liquid2"
      ],
	  "redox": {
		"enabled": true,
		"subSystems": [
			{
				"name": "Chlorine",
				"enabled": false,
				"valenceStates": [
					{
						"name": "Cl(-1)",
						"enabled": true
					},
					{
						"name": "Cl(+1)",
						"enabled": true
					},
					{
						"name": "Cl(+3)",
						"enabled": true
					},
					{
						"name": "Cl(+5)",
						"enabled": true
					},
					{
						"name": "Cl(+7)",
						"enabled": true
					},
					{
						"name": "Cl(+4)",
						"enabled": true
					}
				]
			},
			{
				"name": "Iron",
				"enabled": false,
				"valenceStates": [
					{
						"name": "Fe(0)",
						"enabled": false
					},
					{
						"name": "Fe(+2)",
						"enabled": true
					},
					{
						"name": "Fe(+3)",
						"enabled": false
					},
					{
						"name": "Fe(+6)",
						"enabled": false
					}
				]
			},
			{
				"name": "Sodium",
				"enabled": false,
				"valenceStates": [
					{
						"name": "Na(0)",
						"enabled": true
					},
					{
						"name": "Na(+1)",
						"enabled": true
					}
				]
			}
		]
	}, 
        "includedSolids": {
            "enabled": true,
            "solids": [
				"FECL3"
            ]
        }
	}
 }

params	required	type	description
thermodynamicFramework	✔️	String	The name of thermodynamic framework (e.g. Aqueous (H+ ion))
privateDatabanks	❌	Array of String	The array of private data bank codes (e.g. "COR" and "CER")
Inflows	✔️	Array of JSON Object	The array of JSON object containing a valid identity of inflow species (e.g. {"name": "CO2"} for carbon dioxide)
phases	✔️	Array of String	The array of String which specify phases to be included (e.g. ["liquid1", "vapor", "solid"])
redox	✔️	JSON Object	enable or disable valence states for a particular element in a species.

Response (status=SUCCESS)

If no run-time errors are encountered, the Query output with the requested contents will be available for users to view.