TOP

SearchNotes()

Part Of: Note Webservice 3.0

WSDL:

https://webservices.vin65.com/V300/NoteService.cfc?wsdl

Australian URL:

https://webservices.aus.vin65.com/V300/NoteService.cfc?wsdl

Description:

Use the SearchNotes() function to get the notes for a single customer, order, or search across all of the notes by date/time, etc. Required fields are indicated by a '*'

Parameters:

Attribute Data Type Default Description
WebsiteIDs UUID List   Available for Enterprise Webservices
Comma seperated list of WebsiteIDs in Enterprise
Leave blank for all Websites
 NoteID UUID   UUID of the Vin65 Note 
 RelatedTo Enumerated
("Order", "Contact")		    
 KeyCodeID UUID    UUID of either the Order or Contact inside Vin65
DateModifiedFrom DateTime    
DateModifiedTo DateTime    
MaxRows Integer  100  
Page Integer 1   

Sample Request:

<soap:Envelope xmlns:soap="https://sch emas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <SearchNotes>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <NoteID></NoteID>
      <RelatedTo>Contact</RelatedTo>
      <KeyCodeID></KeyCodeID>
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchNotes>
</soap:Body>
</soap:Envelope>

Sample Response:

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <SearchNotesResponse>
    <SearchNotesReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Notes>
        <Note>
          <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
          <NoteID>43e15e63-2264-112b-b157-70b1cc864227</NoteID>
          <Type>Note</Type>
          <Subject>This is a sample subject</Subject>
          <Note>This is a sample note</Note>
          <NoteDate>2011-08-31T07:00:00</NoteDate>
          <RelatedTo>Contact</RelatedTo>
          <KeyCodeID>754a4faa-9eff-9fd7-5fb3-06656b2c47c6</KeyCodeID>
          <DateAdded>2011-08-31T15:10:17 .767Z</DateAdded>
          <DateModified>2011-08-31T15:10:17.767Z</DateModified>
        </Note>
        <Note>
          <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
          <NoteID>6a190d48-2264-112b-b16f-3e694cf48fbc</NoteID>
          <Type>Note</Type>
          <Subject>This is a sample subject</Subject>
          <Note>This is a sample note</Note>
          <NoteDate>2011-08-31T07:00:00</NoteDate>
          <RelatedTo>Contact</RelatedTo>
          <KeyCodeID>754a4faa-9eff-9fd7-5fb3-06656b2c47c6</KeyCodeID>
          <DateAdded>2011-08-31T15:10:17.767Z</DateAdded>
          <DateModified>2011-08-31T15:10:17.767Z</DateModified>
        </Note>
      </Notes>
      <RecordCount>2</RecordCount>
    </SearchNotesReturn>
  </SearchNotesResponse>
</soapenv:Body>
</soapenv:Envelope>

Page Top