POST api/sync/BerthList

Gets berth list from all marinas

Request Information

URI Parameters

None.

Body Parameters

ListBerthsModel
NameDescriptionTypeAdditional information
syncDateTime

SyncDateTime variable

 string

None.
unoccupiedBerthsOnly

When set to true only returns berths not currently occupied

 boolean

None.
marinaCode

Allows list to be filtered by specified marina

 string

None.
availableFrom

Allows list to be filtered by berths available between given dates

 string

None.
availableTo

Allows list to be filtered by berths available between given dates

 string

None.
includeStatus

Includes current berth status - occupied or not

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "syncDateTime": "2015-10-13T10:23:00",
  "unoccupiedBerthsOnly": false,
  "marinaCode": "HM",
  "availableFrom": null,
  "availableTo": null,
  "includeStatus": null
}

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="syncDateTime"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="unoccupiedBerthsOnly"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="marinaCode"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="availableFrom"

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="availableTo"

sample string 4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="includeStatus"

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

BerthCollectionBindingModel
NameDescriptionTypeAdditional information
berths

List of Berth

 Collection of BerthBindingModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "berths": [
    {
      "berthNo": "A01",
      "marinaCode": "HMS",
      "length": 3.0,
      "width": 4.0,
      "depth": 5.0,
      "occupied": false,
      "occupiedStatus": null,
      "boatNo": null,
      "departureDueDate": null
    },
    {
      "berthNo": "A01",
      "marinaCode": "HMS",
      "length": 3.0,
      "width": 4.0,
      "depth": 5.0,
      "occupied": false,
      "occupiedStatus": null,
      "boatNo": null,
      "departureDueDate": null
    }
  ]
}

multipart/form-data

Sample: 
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].berthNo"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].marinaCode"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].length"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].width"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].depth"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].occupied"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].occupiedStatus"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].boatNo"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[0].departureDueDate"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].berthNo"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].marinaCode"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].length"

3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].width"

4
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].depth"

5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].occupied"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].occupiedStatus"

sample string 7
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].boatNo"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="berths[1].departureDueDate"

sample string 8
--MultipartDataMediaFormatterBoundary1q2w3e--