Query Output Results
This page offers an overview of the output file generated by a query method. A typical output from the query method includes "data" and "result" sections if no errors occur during execution. The "data" and "result" sections contain the following information:
{
"data": {
"metaData": {
"executionTime": {
"unit": "ms",
"value": 344.0
}
},
"result": {
// Either one of the type will be shown below
// Type 1: species query
"species": [
{
// species information
}
]
// Type 2: Databank query
"publicDataBankInfo": [
{
}
],
"privateDataBankInfo": [
{
}
]
// Type 3: redox query
"redox": {
// redox selection
}
// Type 4: kinetics query
"species": [
// species name
// species phases
],
"equilibriumReactions": [
// equilibruim reactions
]
}
},
"message": "Chemistry generated successfully",
"status": "SUCCESS"
} The "metaData" field
This section contains metadata, which provides runtime system information. Currently, the version number of the running software is included in the "metaData".
The "result" field
This section presents all the contents produced by query methods.
This method will return both the public and private databank information to users.
"publicDataBankInfo": [
{
"code": "MSE",
"fullName": "MSE (H3O+ ion)",
"framework": "H3OION",
"description": "",
"versions": {
"major": 11,
"minor": 0,
"revision": 1
}
}
],
"privateDataBankInfo": [
{
"code": "AMI",
"fullName": "AMINEHCL Databank",
"framework": "H3OION",
"description": "",
"versions": {
"major": 9,
"minor": 2,
"revision": 1
}
},
{
"code": "XSC",
"fullName": "Surface Complexation Double Layer Model (MSE)",
"framework": "H3OION",
"description": "",
"versions": {
"major": 11,
"minor": 0,
"revision": 1
}
}
]
publicDataBankInfo
✔️
Array of JSON Object
privateDataBankInfo
✔️
Array of JSON Object
Both public and private databanks contain information in an identical format.
Last updated
Was this helpful?