POST api/sync/Notes

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

Request Information

URI Parameters

None.

Body Parameters

SyncNotesRequestModel
NameDescriptionTypeAdditional information
syncDateTime

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

 string

None.
marinaCode

The marina to search for notes at.

 string

None.
customerNotes

Include customer notes in the results.

 boolean

None.
boatNotes

Include customer notes in the results.

 boolean

None.
contactNotes

Include boat notes in the results.

 boolean

None.
berthNotes

Include contact notes in the results.

 boolean

None.
bookingNotes

Include booking notes in the results.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "syncDateTime": "2019-10-19T00:00:00",
  "marinaCode": "HM",
  "customerNotes": true,
  "boatNotes": true,
  "contactNotes": true,
  "berthNotes": true,
  "bookingNotes": 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="customerNotes"

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

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

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

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

True
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

NotesListModel
NameDescriptionTypeAdditional information
notes

List of notes

 Collection of NoteModel

None.

Response Formats

application/json, text/json

Sample: 
{
  "notes": [
    {
      "noteId": 1,
      "author": "sample string 2",
      "createDate": "sample string 3",
      "note": "sample string 4",
      "marinaCode": "sample string 5"
    },
    {
      "noteId": 1,
      "author": "sample string 2",
      "createDate": "sample string 3",
      "note": "sample string 4",
      "marinaCode": "sample string 5"
    }
  ]
}

multipart/form-data

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

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

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

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="notes[0].note"

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="notes[1].noteId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="notes[1].author"

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

sample string 3
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="notes[1].note"

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

sample string 5
--MultipartDataMediaFormatterBoundary1q2w3e--