Bridges and Locks Documentation: Endpoints, Data Models, and Rate Limits

Bridges and Locks API

Version: v1

Base URLs

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

Endpoints

findBridgesState

GET /bridges/state

Get all available bridges with their current state.

Responses

Status	Description	Content type
`200`	A valid response	application/json
`400`	Bad Request	application/json
`403`	Forbidden (Too many requests)	—

findLocksState

GET /locks/state

Get all available locks with their current state.

Responses

Status	Description	Content type
`200`	A valid response	application/json
`400`	Bad Request	application/json
`403`	Forbidden (Too many requests)	—

Data models

BridgeCurrentStateResponseDTO

JSON

{
  "type": "object",
  "properties": {
    "bridge_id": {
      "type": "string",
      "description": "Bridge Id."
    },
    "description": {
      "type": "string",
      "description": "Name of the bridge."
    },
    "latitude_wgs84": {
      "type": "number",
      "format": "double"
    },
    "state": {
      "type": "string",
      "description": "The status in which the bridge is currently in (GOING_UP, GOING_DOWN, UP, DOWN, UNKNOWN, NO_DATA). NO_DATA means that we currently have no data of the lock door's status. UNKNOWN means that we have status data but we do not have the right data to display the status of the lock door."
    },
    "operational_state_since_in_utc": {
      "type": "string",
      "description": "The time in utc from when the operational status changed.",
      "format": "date-time"
    },
    "operational_state": {
      "type": "string",
      "description": "The operational status of the bridge (WORKING, MALFUNCTIONING, OUT_OF_ORDER, NO_DATA). NO_DATA means that we currently have no data of the lock door's status."
    },
    "state_since_in_utc": {
      "type": "string",
      "description": "The time in utc from when the status changed.",
      "format": "date-time"
    },
    "longitude_wgs84": {
      "type": "number",
      "format": "double"
    }
  }
}

LockDoorStateResponseDTO

JSON

{
  "type": "object",
  "properties": {
    "latitude_wgs84": {
      "type": "number",
      "format": "double"
    },
    "state": {
      "type": "string",
      "description": "The status in which the lock door is currently in (OPENING, CLOSING, OPEN, CLOSED, UNKNOWN, NO_DATA). NO_DATA means that we currently have no data of the lock door's status. UNKNOWN means that we have status data but we do not have the right data to display the status of the lock door."
    },
    "operational_state_since_in_utc": {
      "type": "string",
      "description": "The time in utc from when the operational status changed.",
      "format": "date-time"
    },
    "operational_state": {
      "type": "string",
      "description": "The operational status of the lock door (WORKING, MALFUNCTIONING, OUT_OF_ORDER, NO_DATA). NO_DATA means that we currently have no data of the lock door's status."
    },
    "state_since_in_utc": {
      "type": "string",
      "description": "The time in utc from when the status changed.",
      "format": "date-time"
    },
    "lock_door_id": {
      "type": "string",
      "description": "Lock door Id."
    },
    "longitude_wgs84": {
      "type": "number",
      "format": "double"
    }
  }
}

LockCurrentStateResponseDTO

JSON

{
  "type": "object",
  "properties": {
    "description": {
      "type": "string",
      "description": "Lock name."
    },
    "latitude_wgs84": {
      "type": "number",
      "format": "double"
    },
    "lock_doors": {
      "type": "array",
      "description": "Lock doors.",
      "items": {
        "$ref": "#/components/schemas/LockDoorStateResponseDTO"
      }
    },
    "longitude_wgs84": {
      "type": "number",
      "format": "double"
    },
    "lock_id": {
      "type": "string",
      "description": "Lock Id."
    }
  }
}

PortOfAntwerpProblem

JSON

{
  "type": "object",
  "properties": {
    "stacktrace": {
      "type": "string"
    },
    "message": {
      "type": "string"
    }
  }
}