Solid Phase Query

Once the user specifies the inflow species and their corresponding oxidation states, all solid phases can be accessed through the solid query method. These solid phases can then be included or excluded in the Chemistry Builder inflow file as needed.

Request Payload

 {   
	"params": {
	"thermodynamicFramework": "Aqueous (H+ ion)",
	"privateDatabanks": [
		"COR", 
		"CER"
	],
	"inflows": [
		{
			"name": "H2O"
		},
		{
			"name": "NACL"
		},
		{
			"name": "FECL3"
		}],
	  "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": true 
					},
					{
						"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
					}
				]
			}
		]
	}
    }
 }

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)
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.