# Load Port Information

Inspection jobs with discharge activity require original load port information to be provided as part of the quantity result set.

An authorized party can use the following endpoints to retrieve and submit load port information.

# Data Model

# Load Port Information

Field Type Description
workspace reference ​ Workspace ID
parent reference ​ Id of the job document for this quantity test results
billOfLadingDate datetime The date of the bill of lading
portOfLoading Catalog reference Original port of loading
measurements Array<Document measurement> Document measurements for required data points with required units of measure

# Measurement

Field Type Description
code string Measurement code from client's integrated system
name string Measurement name. E.g. GSV, TCV, etc.
uom Catalog reference Unit of measure
value float Measured value

# API

# List all the load port information documents

GET /workspaces/{workspace_id}/jobs/{job_id}/load-port-information

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
job_id Job id reference

# Query parameters

​ Parameter Description Format Default
limit Maximum number of records to return integer
offset The number of records to skip integer 0
sort List of comma-separated ordering criteria field:asc|desc

# Create a load port information document

POST /workspaces/{workspace_id}/jobs/{job_id}/load-port-information

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
job_id Job id reference

# Request body

See data model

# Request example:

hide code
{
  "billOfLadingDate": "2019-06-28T14:00:00.000Z",
  "portOfLoading": {
      "xref": "4567",
      "name": "Finnart"
  },
  "measurements": [{
    "code": "gsv-at-15-degrees-c",
    "name": "GSV",
    "value": 123.456,
    "uom": {
        "xref": "m3",
        "name": "m3"
    }
  }]
}

# Response example:

hide code
{
  "id": "a0a20ae2-b1fb-4e0f-ae13-710c9598d7ad",
  "body": {
    "billOfLadingDate": "2019-06-28T14:00:00.000Z",
    "portOfLoading": "ce580152-0a6b-4071-9f56-ad0a4d5f1c47",
    "measurements": [{
      "code": "gsv-at-15-degrees-c",
      "name": "GSV",
      "value": 123.456,
      "uom": "d49ba3fc-5442-4d0e-9cd3-045b67211058"
    }]
  }
}

Creation of a load port information document adds missing records to the catalogs. Mapped catalogs include: locations, uom, tests, timelogEvents.

# Get a single load port information document

GET /workspaces/{workspace_id}/jobs/{job_id}/load-port-information/{id}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
job_id Job id reference
id Document id reference

# Response example:

hide code
{
  "billOfLadingDate": "2019-06-28T14:00:00.000Z",
  "portOfLoading": "ce580152-0a6b-4071-9f56-ad0a4d5f1c47",
  "measurements": [{
    "code": "gsv-at-15-degrees-c",
    "name": "GSV",
    "value": 123.456,
    "uom": "d49ba3fc-5442-4d0e-9cd3-045b67211058"
  }]
}

# Update a load port information document

PATCH /workspaces/{workspace_id}/jobs/{job_id}/load-port-information/{id}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
job_id Job id reference
id Document id reference

# Request body

See data model

# Request example:

hide code
{
  "portOfLoading": {
    "xref": "new-port-xref",
    "name": "New Port"
  }
}

# Response example:

hide code
{
  "billOfLadingDate": "2019-06-28T14:00:00.000Z",
  "portOfLoading": "a0a20ae2-b1fb-4e0f-ae13-710c9598d7ad",
  "measurements": [{
    "code": "gsv-at-15-degrees-c",
    "name": "GSV",
    "value": 123.456,
    "uom": "d49ba3fc-5442-4d0e-9cd3-045b67211058"
  }]
}

# Delete a load port information document

DELETE /workspaces/{workspace_id}/jobs/{job_id}/load-port-information/{id}

# URL parameters

Parameter Description Format
workspace_id Integration workspace id reference
job_id Job id reference
id Document id reference

# Response example:

hide code
{
  "billOfLadingDate": "2019-06-28T14:00:00.000Z",
  "portOfLoading": "a0a20ae2-b1fb-4e0f-ae13-710c9598d7ad",
  "measurements": [{
    "code": "gsv-at-15-degrees-c",
    "name": "GSV",
    "value": 123.456,
    "uom": "d49ba3fc-5442-4d0e-9cd3-045b67211058"
  }]
}
Last Updated: 7/20/2021, 9:58:21 PM