Open Data User Documentation

Bathymtric Survey Documentation: Endpoints, Data Models, and Rate Limits

Bathymtric Survey Data Api

Version: v1

Base URLs

  • <https://api-bathymetricsurvey.nxtport.com/v1> — PRD Environment

Endpoints

GET /measurements
Parameters

Name

In

Type

Required

Description

infrastructureCode

query

string

no

The Infrastructure code (returned by /infrastructures)

date

query

string (date-time)

no

The reference date for changed files

Responses

Status

Description

Content type

200

Success

text/plain, application/json, text/json

Get a list of infrastructure codes and their description.

GET /infrastructures
Responses

Status

Description

Content type

200

Success

text/plain, application/json, text/json

Data models

MeasurementResponseContract

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "nullable": true
    },
    "path": {
      "type": "string",
      "format": "uri",
      "nullable": true
    }
  },
  "additionalProperties": false
}

MeasurementsResponseContract

JSON
{
  "type": "object",
  "properties": {
    "measurementDocumentPaths": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/MeasurementResponseContract"
      },
      "nullable": true
    }
  },
  "additionalProperties": false
}

InfrastructureResponseContract

JSON
{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "nullable": true
    },
    "description": {
      "type": "string",
      "nullable": true
    }
  },
  "additionalProperties": false
}