GET api/Vessels

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of Vessel

Name	Type	Additional information
ID	integer	None.
vesselName	string	Required String length: inclusive between 0 and 150
directionalPositioning	boolean	None.
vesselType	string	Required String length: inclusive between 0 and 150
zone	string	String length: inclusive between 0 and 20
dayRate	decimal number	None.
endUser	string	String length: inclusive between 0 and 100
projectName	string	String length: inclusive between 0 and 250
contractType	string	String length: inclusive between 0 and 20
tankCapacity	string	String length: inclusive between 0 and 20
companyID	integer	None.
company	Company	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "ID": 1,
    "vesselName": "sample string 1",
    "directionalPositioning": true,
    "vesselType": "sample string 3",
    "zone": "sample string 4",
    "dayRate": 1.1,
    "endUser": "sample string 5",
    "projectName": "sample string 6",
    "contractType": "sample string 7",
    "tankCapacity": "sample string 8",
    "companyID": 9,
    "company": {
      "ID": 1,
      "vendorID": "sample string 1",
      "companyName": "sample string 2",
      "contractStatus": "sample string 3"
    }
  },
  {
    "ID": 1,
    "vesselName": "sample string 1",
    "directionalPositioning": true,
    "vesselType": "sample string 3",
    "zone": "sample string 4",
    "dayRate": 1.1,
    "endUser": "sample string 5",
    "projectName": "sample string 6",
    "contractType": "sample string 7",
    "tankCapacity": "sample string 8",
    "companyID": 9,
    "company": {
      "ID": 1,
      "vendorID": "sample string 1",
      "companyName": "sample string 2",
      "contractStatus": "sample string 3"
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfVessel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NMAUtilityAPI.Entity">
  <Vessel>
    <ID>1</ID>
    <company>
      <ID>1</ID>
      <companyName>sample string 2</companyName>
      <contractStatus>sample string 3</contractStatus>
      <vendorID>sample string 1</vendorID>
    </company>
    <companyID>9</companyID>
    <contractType>sample string 7</contractType>
    <dayRate>1.1</dayRate>
    <directionalPositioning>true</directionalPositioning>
    <endUser>sample string 5</endUser>
    <projectName>sample string 6</projectName>
    <tankCapacity>sample string 8</tankCapacity>
    <vesselName>sample string 1</vesselName>
    <vesselType>sample string 3</vesselType>
    <zone>sample string 4</zone>
  </Vessel>
  <Vessel>
    <ID>1</ID>
    <company>
      <ID>1</ID>
      <companyName>sample string 2</companyName>
      <contractStatus>sample string 3</contractStatus>
      <vendorID>sample string 1</vendorID>
    </company>
    <companyID>9</companyID>
    <contractType>sample string 7</contractType>
    <dayRate>1.1</dayRate>
    <directionalPositioning>true</directionalPositioning>
    <endUser>sample string 5</endUser>
    <projectName>sample string 6</projectName>
    <tankCapacity>sample string 8</tankCapacity>
    <vesselName>sample string 1</vesselName>
    <vesselType>sample string 3</vesselType>
    <zone>sample string 4</zone>
  </Vessel>
</ArrayOfVessel>