POST api/sync/BoatYardJobs

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

Request Information

URI Parameters

None.

Body Parameters

SyncWorksOrderItemsRequestModel
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.

includeCompleteActions

Include complete Actions in the results.

boolean

None.

includeIncompleteActions

Include incomplete Actions in the results.

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "syncDateTime": "2019-10-19T00:00:00",
  "marinaCode": "HM",
  "confirmedOnly": true,
  "includeCompleteActions": true,
  "includeIncompleteActions": false
}

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="includeCompleteActions"

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

WorksOrderItemListModel
NameDescriptionTypeAdditional information
items

List of works order items.

Collection of WorksOrderItemModel

None.

Response Formats

application/json, text/json

Sample:
{
  "items": [
    {
      "worksOrderId": 1,
      "worksOrderItemId": 2,
      "actionId": 3,
      "marinaCode": "sample string 4",
      "boatNo": 5,
      "startDate": "2026-03-30T16:13:47.6463358+01:00",
      "endDate": "2026-03-30T16:13:47.6463358+01:00",
      "serviceCode": "sample string 6",
      "description": "sample string 7",
      "orderConfirmed": true,
      "itemCompleted": true,
      "actionCompleted": true,
      "orderCancelled": true
    },
    {
      "worksOrderId": 1,
      "worksOrderItemId": 2,
      "actionId": 3,
      "marinaCode": "sample string 4",
      "boatNo": 5,
      "startDate": "2026-03-30T16:13:47.6463358+01:00",
      "endDate": "2026-03-30T16:13:47.6463358+01:00",
      "serviceCode": "sample string 6",
      "description": "sample string 7",
      "orderConfirmed": true,
      "itemCompleted": true,
      "actionCompleted": true,
      "orderCancelled": true
    }
  ]
}

multipart/form-data

Sample:

Sample not available.