Get a List of Contact Notes By Parent Contact
Retrieve a list of contact notes that have the supplied contact as a parent of the notes contact.
Query String Parameters
Name | Type | Description | Required |
---|---|---|---|
Action | String | ContactNotesByParent | Required |
ContactId | int | The unique identifier of the contact which can be retrieved using Contact List. | Optional = See Tip |
ContactReference | String(50) | The internal reference of the contact. | Optional - See Tip |
DateFrom | DateTime | Filter by Creation Date, Format: yyyy-MM-dd HH:mm:ss | Optional |
DateTo | DateTime | Filter by Creation Date, Format: yyyy-MM-dd HH:mm:ss | Optional |
tip
The Contact Reference or Id can be supplied. If both parameters are provided, the Contact Id will take precedence.
If no dates are supplied, the contact notes for the last thirty days are returned.
If the DateFrom parameter only is supplied, the notes for 30 days from the DateFrom are returned.
If the DateTo parameter only is supplied, the notes for the 30 days previous to the DateTo are returned.
Response Codes
Example
- Request
- Response
Request URL
https://webservice.bigchange.com/v01/services.ashx?action=ContactNotesByParent&ContactId=309633
Response Data
{ "Code": 0, "Result": { "ContactId": 123456, "ContactReference": "ABC123", "From": "2019-03-14 13:00:00", "To": "2019-06-14 13:30:00", "ContactNotes": [ { "NoteId": 3131961, "NoteReference": "test", "NoteSubject": "test subject", "NoteText": "thanks again" }, { "NoteId": 2835785, "NoteReference": "SAL-111111", "NoteSubject": "Expected date updated", "NoteText": "21/03/2019 => 06/03/2019" }, { "NoteId": 2835710, "NoteReference": "SAL-222222", "NoteSubject": "Financial document created", "NoteText": "Created" } ] } }