# Quantity test results
A job request may require a quantity measurement. A job requiring a quantity inspection indicates items to measure and the required units of measurements.
An authorized party can use the Document Endpoints with the following schema to retrieve and submit quantity measurement results.
# Document Type
navarik.inspection.quantityResult
# Data Model
# Quantity result
| Field | Type | Description |
|---|---|---|
workspace | reference, required | Workspace ID. |
parent | reference, required | ID of the worksheet document for this quantity test results. |
status | enum, required | Status of the quantity results. Possible values: confirmed, preliminary. |
xref | string | External ID to reference vendor's internal systems. |
direction | string, required | source or destination. Each job would have one quantity result document for each direction. For example, in the case of a discharge operation, the vessel quantity data would be submitted as the source and the shore as the destination. |
description | string | Description. |
activityBasisCode | string | BL or outturn volume basis. |
isActiveShoreTank | boolean | Active shore tank. |
measurements | Array<Quantity measurement> | Quantity measurements for different data points with requested units of measure |
densityApiMethodName | string | Density/API Method. |
densityMethod | string | Density Method. |
density15Degc | string | Density 15°C. |
apiGravity | string | API Gravity (Wet). |
waterMethodName | string | Water Vol % Method. |
waterPerc | string | Water. |
sedimentMethod | string | Sediment Method. |
sedimentPerc | string | Sediment. |
sedimentWaterPerc | string | S & W (Vol%). |
vcfTableCode | string | VEF Table. |
custodyTransferSampleMethodCode | string | Custody Transfer Sample Obtained By. |
equipmentOwnerArrivalCode | string | Equipment Used (on arrival). |
equipmentSerialNumberArrival | string | Equipment Serial No. (on arrival). |
equipmentOwnerDepartureCode | string | Equipment Used (on departure). |
equipmentSerialNumberDeparture | string | Equipment Serial No. (on departure). |
meanTemperature.value | string | Mean temp before activity. |
meanTemperature.uom | Catalog reference | Mean temperature unit of measure |
meanTemperature2.value | string | Mean temp after activity. |
meanTemperature2.uom | Catalog reference | Mean temperature unit of measure |
vef.type | string | VEF type. Possible values: load, discharge. |
vef.value | string | VEF value. |
isObqSamplesTaken | boolean | OBQ Samples Taken (only for Load). |
isSlopsSamplesTaken | boolean | Slops Samples Taken (only for Load). |
isSlopsLot | boolean | Slops LOT This Port (only for Load). |
isFreeWaterSampledArrival | boolean | Free Water Sampled (on arrival). |
isFreeWaterSampledDeparture | boolea | Free Water Sampled (on departure). |
# Measurement
| Field | Type | Description |
|---|---|---|
code | string | Measurement code from client's integrated system. |
name | string | Measurement name. E.g. GSV, TCV, etc. |
value | string | Measured value. |
uom | Catalog reference | Unit of measure. |
# Example:
# Load - Source
{
"vef": {
"type": "load",
"value": "1.0012"
},
"description": "Example description.",
"direction": "source",
"vcfTableCode": "6B",
"meanTemperature": {
"value": "70.4",
"uom": {
"xref": "1030",
"name": "Temp °F"
}
},
"activityBasisCode": "T",
"custodyTransferSampleMethodCode": "T",
"isActiveShoreTank": false,
"density15Degc": "0.7119",
"apiGravity": "67.2",
"densityApiMethodName": "",
"sedimentWaterPerc": "0",
"waterMethodName": "",
"measurements": [
{
"code": "BL_TCV",
"name": "tcv",
"value": "236817.76",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "9946346",
"uom": {
"xref": "102",
"name": "US Gallons @ 60°F"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "8282065",
"uom": {
"xref": "103",
"name": "Imperial Gallons @ 60°F"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "58962296",
"uom": {
"xref": "104",
"name": "Pounds"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "26322.453",
"uom": {
"xref": "105",
"name": "Long Tons"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "29481.148",
"uom": {
"xref": "106",
"name": "Short Tons"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "26744.847",
"uom": {
"xref": "107",
"name": "Metric Tons (Air)"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "26785.99",
"uom": {
"xref": "108",
"name": "Metric Tons (Vac)"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "37623.926",
"uom": {
"xref": "1010",
"name": "M3 @ 15°C"
}
},
{
"code": "BL_TCV",
"name": "tcv",
"value": "37870.284",
"uom": {
"xref": "1011",
"name": "M3 @ 20°C"
}
},
{
"code": "BL_GSV",
"name": "gsv",
"value": "236817.76",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
},
{
"code": "BL_NSV",
"name": "nsv",
"value": "236817.76",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
}
],
"xref": "1234567",
"status": "confirmed",
"meanTemperature2": {
"value": null,
"uom": {
"name": "",
"xref": ""
}
}
}
# Load (Destination)
{
"vef": {
"type": "load",
"value": "1.0012"
},
"description": "Example description.",
"direction": "destination",
"vcfTableCode": "6B",
"meanTemperature": {
"value": "60",
"uom": {
"xref": "1030",
"name": "Temp °F"
}
},
"equipmentOwnerArrivalCode": "INSPECTOR",
"equipmentSerialNumberArrival": "",
"isObqSamplesTaken": false,
"isSlopsSamplesTaken": false,
"isSlopsLot": false,
"isFreeWaterSampledArrival": false,
"meanTemperature2": {
"value": "70.6",
"uom": {
"xref": "1030",
"name": "Temp °F"
}
},
"density15Degc": "0.7119",
"apiGravity": "67.2",
"densityApiMethodName": "",
"equipmentOwnerDepartureCode": "INSPECTOR",
"equipmentSerialNumberDeparture": "",
"waterPerc": null,
"sedimentPerc": null,
"isFreeWaterSampledDeparture": false,
"measurements": [
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "102",
"name": "US Gallons @ 60°F"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "103",
"name": "Imperial Gallons @ 60°F"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "104",
"name": "Pounds"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "105",
"name": "Long Tons"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "106",
"name": "Short Tons"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "107",
"name": "Metric Tons (Air)"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "108",
"name": "Metric Tons (Vac)"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "1010",
"name": "M3 @ 15°C"
}
},
{
"code": "OBQ_TCV",
"name": "obq_tcv",
"value": "0",
"uom": {
"xref": "1011",
"name": "M3 @ 20°C"
}
},
{
"code": "LOT_OBQ_SLOPS_LIQUID",
"name": "obq_liq",
"value": "0",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
},
{
"code": "LOT_OBQ_SLOPS_NON_LIQUID",
"name": "obq_non-liq",
"value": "0",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
},
{
"code": "OBQ_FREE_WATER",
"name": "obq_free_water",
"value": "0",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
},
{
"code": "TCV_AFTER_LOADING",
"name": "ull_tcv",
"value": "237283.54",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
},
{
"code": "GSV_AFTER_LOADING",
"name": "ull_gsv",
"value": "237283.54",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
},
{
"code": "GSV_LIQUID",
"name": "ull_gsv",
"value": "237283.54",
"uom": {
"xref": "101",
"name": "Barrels @ 60°F"
}
}
],
"xref": "1234567",
"status": "confirmed"
}