GET api/v2/MarinaOps/Reservations/{ReservationId}

Retrieve a Reservation.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
ReservationId

The Reservation Id to retrieve.

 string

Required

Body Parameters

None.

Response Information

Resource Description

Reservation
NameDescriptionTypeAdditional information
Id

Optional: The existing Reservation Id to Update.

 string

None.
CustomerId

Optional: If available, the CustomerId to create a Reservation for.

 string

None.
FirstName

Required: Customers First Name

 string

None.
LastName

Required: Customers Last Name

 string

None.
HomePhone

Optional: At least one phone number is required.

 string

None.
WorkPhone

Optional: At least one phone number is required.

 string

None.
CellPhone

Optional: At least one phone number is required.

 string

None.
EmailAddress

Required: Customers Email Address

 string

None.
Address1

Optional: Customers Address

 string

None.
Address2

Optional: Customers Address

 string

None.
Address3

Optional: Customers Address

 string

None.
City

Optional: Customers City

 string

None.
State

Optional: Customers State

 string

None.
Zip

Optional: Customers Postal Code

 string

None.
Country

Optional: Customers Address

 string

None.
BoatId

Optional: If available, the BoatId for the Customers Boat.

 string

None.
BoatName

Required: Name of the Boat

 string

None.
BoatRegistration

Optional: The Boats Registration number.

 string

None.
BoatLength

Required: The overall length of the Boat.

 string

None.
BoatDraft

Optional: The Boats draft.

 string

None.
BoatBeam

Optional: The Boats beam.

 string

None.
ArrivalDate

Required: The expected arrival date.

 string

None.
DepartureDate

Required: The expected departure date.

 string

None.
SlipId

The Slip Id being requested.

 string

None.
LocationCode

Optional: For Multi-Location Marinas. The Location code where this reservation is being created.

 string

None.
Confirmed

Optional: Flag to mark reservation as confirmed.

 boolean

None.
Amps_1

Optional: Required Amps 1

 integer

None.
Amps_2

Optional: Required Amps 2

 integer

None.
GeneralComments

Optional: General comments

 string

None.
BillCodes

Optional: A list of billcodes to create charges.

 Collection of string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1",
  "CustomerId": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "HomePhone": "sample string 5",
  "WorkPhone": "sample string 6",
  "CellPhone": "sample string 7",
  "EmailAddress": "sample string 8",
  "Address1": "sample string 9",
  "Address2": "sample string 10",
  "Address3": "sample string 11",
  "City": "sample string 12",
  "State": "sample string 13",
  "Zip": "sample string 14",
  "Country": "sample string 15",
  "BoatId": "sample string 16",
  "BoatName": "sample string 17",
  "BoatRegistration": "sample string 18",
  "BoatLength": "sample string 19",
  "BoatDraft": "sample string 20",
  "BoatBeam": "sample string 21",
  "ArrivalDate": "sample string 22",
  "DepartureDate": "sample string 23",
  "SlipId": "sample string 24",
  "LocationCode": "sample string 25",
  "Confirmed": true,
  "Amps_1": 1,
  "Amps_2": 1,
  "GeneralComments": "sample string 26",
  "BillCodes": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample: 
<Reservation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/com.dockmaster.lib.models">
  <Address1>sample string 9</Address1>
  <Address2>sample string 10</Address2>
  <Address3>sample string 11</Address3>
  <Amps_1>1</Amps_1>
  <Amps_2>1</Amps_2>
  <ArrivalDate>sample string 22</ArrivalDate>
  <BillCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </BillCodes>
  <BoatBeam>sample string 21</BoatBeam>
  <BoatDraft>sample string 20</BoatDraft>
  <BoatId>sample string 16</BoatId>
  <BoatLength>sample string 19</BoatLength>
  <BoatName>sample string 17</BoatName>
  <BoatRegistration>sample string 18</BoatRegistration>
  <CellPhone>sample string 7</CellPhone>
  <City>sample string 12</City>
  <Confirmed>true</Confirmed>
  <Country>sample string 15</Country>
  <CustomerId>sample string 2</CustomerId>
  <DepartureDate>sample string 23</DepartureDate>
  <EmailAddress>sample string 8</EmailAddress>
  <FirstName>sample string 3</FirstName>
  <GeneralComments>sample string 26</GeneralComments>
  <HomePhone>sample string 5</HomePhone>
  <Id>sample string 1</Id>
  <LastName>sample string 4</LastName>
  <LocationCode>sample string 25</LocationCode>
  <SlipId>sample string 24</SlipId>
  <State>sample string 13</State>
  <WorkPhone>sample string 6</WorkPhone>
  <Zip>sample string 14</Zip>
</Reservation>