POST api/sync/BoatYardPackages

Returns boatyard packages that have been created/amended after a given date.

Request Information

URI Parameters

None.

Body Parameters

SyncBoatYardPackagesRequestModel
NameDescriptionTypeAdditional information
syncDateTime

Only records created or changed after this time should be included.

 string

None.
marinaCode

The marina to search in

 string

None.
confirmedOnly

If set, only confirmed works orders will be included

 boolean

None.
includeCompleted

Include complete packages in the results.

 boolean

None.
includeIncompleted

Include incomplete packages in the results.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "syncDateTime": "sample string 1",
  "marinaCode": "sample string 2",
  "confirmedOnly": true,
  "includeCompleted": true,
  "includeIncompleted": true
}

multipart/form-data

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

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

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

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

BoatYardPackageListModel
NameDescriptionTypeAdditional information
packages

List of boat yard packages.

 Collection of BoatYardPackageModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "packages": [
    {
      "worksOrderId": 1,
      "marinaCode": "sample string 2",
      "boatNo": 3,
      "startDate": "sample string 4",
      "launchDate": "sample string 5",
      "description": "sample string 6",
      "orderConfirmed": true,
      "isCompleted": true
    },
    {
      "worksOrderId": 1,
      "marinaCode": "sample string 2",
      "boatNo": 3,
      "startDate": "sample string 4",
      "launchDate": "sample string 5",
      "description": "sample string 6",
      "orderConfirmed": true,
      "isCompleted": true
    }
  ]
}

multipart/form-data

Sample:

Sample not available.