Bridge

<back to all web services

VesselSearch

Vessels
The following routes are available for this service:
GET/Vessels/Search
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VesselSearch:
    search: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class VesselViewModel:
    id: int = 0
    imo_number: Optional[int] = None
    mmsi: Optional[str] = None
    name: Optional[str] = None

Python VesselSearch DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Vessels/Search HTTP/1.1 
Host: internal.thebunkerbridge.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<VesselViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bridge.Core.ViewModels">
  <IMONumber>0</IMONumber>
  <Id>0</Id>
  <MMSI>String</MMSI>
  <Name>String</Name>
</VesselViewModel>