---
title: "Note Webservice"
slug: "note-webservice"
updated: 2024-04-08T16:14:48Z
published: 2024-04-08T16:14:48Z
canonical: "docs.winedirect.com/note-webservice"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.winedirect.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Note Webservice

### WSDL:

[https://webservices.vin65.com/V300/NoteService.cfc?wsdl](https://webservices.vin65.com/V300/NoteService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/NoteService.cfc?wsdl](https://webservices.aus.vin65.com/V300/NoteService.cfc?wsdl)

### Methods:

**SearchNotes()** Search across notes (including order notes and customer notes).

**GetNote()** Get a single note.

**AddUpdateNote()** Add or update a note.

# SearchNotes()

### Part Of: Note Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/NoteService.cfc?wsdl](https://webservices.vin65.com/V300/NoteService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/NoteService.cfc?wsdl](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>
```

# GetNote()

### Part Of: Note Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/NoteService.cfc?wsdl](https://webservices.vin65.com/V300/NoteService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/NoteService.cfc?wsdl](https://webservices.aus.vin65.com/V300/NoteService.cfc?wsdl)

### Description:

Use the GetNote() function to get a single note for either a customer or an order. Required fields are indicated by a '*'

### Parameters:

| Attribute | Data Type | Default | Description |
| --- | --- | --- | --- |
| NoteID* | UUID |  | UUID of the Vin65 Note |

### Sample Request:

```
<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v300="http://V300">
<soapenv:Header/>
   <soapenv:Body>
      <v300:GetNote soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
         <Request xsi:type="get:Request" xmlns:get="http://getNote.note.V300">
            <Security xsi:type="req:Security" xmlns:req="http://request.base.V300">
               <Password xsi:type="xsd:string">//Your Password//</Password>
               <Username xsi:type="xsd:string">//Your Username//</Username>
            </Security>
            <NoteID xsi:type="xsd:string">43e15e63-2264-112b-b157-70b1cc864227</NoteID>
         </Request>
      </v300:GetNote>
   </soapenv:Body>
</soapenv: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" xm lns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <GetNoteResponse>
    <GetNoteReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <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>
      <RecordCount>1</RecordCount>
    </GetNoteReturn>
  </GetNoteResponse>
</soapenv:Body>
</soapenv:Envelope>
```

# AddUpdateNote()

### Part Of: Note Webservice 3.0

### WSDL:

[https://webservices.vin65.com/V300/NoteService.cfc?wsdl](https://webservices.vin65.com/V300/NoteService.cfc?wsdl)

#### Australian URL:

[https://webservices.aus.vin65.com/V300/NoteService.cfc?wsdl](https://webservices.aus.vin65.com/V300/NoteService.cfc?wsdl)

### Description:

Use the AddUpdateNote() function to either add a new note or update a current note. Required fields are indicated by a '*'

### Parameters:

| Attribute | Data Type | Default | Description |
| --- | --- | --- | --- |
| WebsiteID* | UUID |  | Only required for Enterprise Webservices UUID of the Vin65 Website |
| NoteID | UUID |  | UUID of the Vin65 Note |
| Type* | Enumerated ("Flag", "Note") |  |  |
| Subject* | String 50 |  |  |
| NoteDate* | DateTime |  |  |
| Note | String |  |  |
| RelatedTo* | Enumerated ("Contact", "Order") |  |  |
| KeyCodeID* | UUID |  | UUID of either the Contact or Order in Vin65 |
| DateAdded | DateTime |  | Controlled by Vin65 System |
| DateModified | DateTime |  | Controlled by Vin65 System |

### Sample Request:

```
<soap:Envelope xmlns:soap="https://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="https://www.w3.org/2001/XMLSchema">
<soap:Body>
  <AddUpdateNote>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <Note>
        <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
        <NoteID>43e15e63-2264-112b-b157-70b1cc864227</NoteID>
        <Type>Note</Type>
        <Subject>This is a samlple subject</Subject>
        <Note>This is a sample note</Note>
        <NoteDate>2011-09-12T12:21:43</NoteDate> 
        <RelatedTo>Contact</RelatedTo>
        <KeyCodeID>754a4faa-9eff-9fd7-5fb3-06656b2c47c6</KeyCodeID>
      </Note>
      <Mode>Strict</Mode>
    </Request>
</AddUpdateNote>
</soap:Body>
</soap:Envelope>
```

### Sample Response:

```
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="https://sche mas.xmlsoap.org/soap/envelope/" xmlns:xsd="https://www.w3.org/2001/XMLSchema" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <AddUpdateNoteResponse>
    <AddUpdateNoteReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <NoteID>43e15e63-2264-112b-b157-70b1cc864227</NoteID>
      <RecordCount>1</RecordCount>
    </AddUpdateNoteReturn>
  </AddUpdateNoteResponse>
</soapenv:Body>
</soapenv:Envelope>
```