Task Webservice

08 Apr 2024
2 Minutes to read

Print
Share
Dark
Light
PDF

Task Webservice

Updated on 08 Apr 2024
2 Minutes to read

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

WSDL:

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

Australian URL:

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

Methods:

SearchTasks()
Search across notes (including order tasks, customer tasks, and product tasks).

GetTask()
Get a single task.

AddUpdateTask()
Add or update a task.

SearchTasks()

Part Of: Task Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the SearchTasks() function to get the tasks for a single customer, order, or search across all of the tasks 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
TaskID	UUID		UUID of the Vin65 Task
AssignToID	UUID		UUID of the Vin65 User the Task is Assigned To
DueDateFrom	Date
DueDateTo	Date
RelatedTo	Enumerated ("Order","Contact", "Product")
KeyCodeID	UUID		UUID of either the Order, Contact, or Product the Task is attached to.
IsComplete	Boolean
DateModifiedFrom	DateTime
DateModifiedTo	DateTime
MaxRows	Integer	100
Page	Integer	1

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>
  <SearchTasks>
    <Request> 
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <WebsiteIDs></WebsiteIDs>
      <TaskID></TaskID>
      <AssignToID></AssignToID>
      <DueDateFrom>2011-01-01T00:00:00</DueDateFrom>
      <DueDateTo>2011-04-01T00:00:00</DueDateTo>
      <RelatedTo></RelatedTo>
      <KeyCodeID></KeyCodeID>
      <IsComplete></IsComplete>
      <DateModifiedFrom>2011-01-01T12:21:43</DateModifiedFrom>
      <DateModifiedTo>2011-09-12T12:21:43</DateModifiedTo>
      <MaxRows>100</MaxRows>
      <Page>1</Page>
    </Request>
  </SearchTasks>
</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>
  <SearchTasksResponse>
    <SearchTasksReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful> 
      <Tasks>
        <Task>
          <TaskID>6a190d48-2264-112b-b16f-3e694cf48fbc</TaskID>
          <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
          <AssignToID>0d16e928-7b7e-4786-b7dd-22f364863ce4</AssignToID>
          <DueDate>2011-02-18T00:00:00</DueDate>
          <Subject>This is a sample subject</Subject>
          <Comments>This is a sample task</Comments>
          <RelatedTo>Contact</RelatedTo>
          <KeyCodeID>33ad141d-99d8-82ce-f297-76e93ca8f5d9</KeyCodeID>
          <SendEmailNotification">true</SendEmailNotification>
          <EmailTo>john@vin65.com</EmailTo>
          <IsComplete>true</IsComplete>
          <DateAdded>2010-07-20T17:59:27.517Z</DateAdded>
          <DateModified>2011-04-05T16:00:18.527Z</DateModified>
        </Task>
        <Task>
          <TaskID>43e15e63-2264-112b-b157-70b1cc864227</TaskID>
          <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
          <AssignToID>0d16e928-7b7e-4786-b7dd-22f364863ce4</AssignToID>
          <DueDate>2011-02-18T00:00:00</DueDate>
          <Subject>This is a sample subject</Subject>
          <Comments>This is a sample task</Comments>
          <RelatedTo>Contact</RelatedTo>
          <KeyCodeID>33ad141d-99d8-82ce-f297-76e93ca8f5d9</KeyCodeID>
          <SendEmailNotification">true</SendEmailNotification>
          <EmailTo>john@vin65.com</EmailTo>
          <IsComplete>true</IsComplete>
          <DateAdded>2010-07-20T17:59:27.517Z</DateAdded>
          <DateModified>2011-04-05T16:00:18.527Z</DateModified>
         </Task>
      </Tasks>
      <RecordCount>2</RecordCount>
    </SearchTasksReturn>
  </SearchTasksResponse>
</soapenv:Body>
</soapenv:Envelope>

GetTask()

Part Of: Task Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

Use the GetTask() function to get a single task for either a customer, order or product. Required fields are indicated by a '*'

Parameters:

Attribute	Data Type	Default	Description
TaskID*	UUID		UUID of the Vin65 Task

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>
  <GetTask>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</P assword>
      </Security>
      <TaskID>6a190d48-2264-112b-b16f-3e694cf48fbc</TaskID>
    </Request>
  </GetTask>
</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>
  <GetTaskResponse> 
    <GetTaskReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <Task>
        <TaskID>6a190d48-2264-112b-b16f-3e694cf48fbc</TaskID>
        <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
        <AssignToID>0d16e928-7b7e-4786-b7dd-22f364863ce4</AssignToID>
        <DueDate>2011-02-18T00:00:00</DueDate>
        <Subject>This is a sample subject</Subject>
        <Comments>This is a sample task</Comments>
        <RelatedTo>Contact</RelatedTo>
        <KeyCodeID>33ad141d-99d8-82ce-f297-76e93ca8f5d9</KeyCodeID>
        <SendEmailNotification">true</SendEmailNotification>
        <EmailTo>john@vin65.com</EmailTo>
        <IsComplete>true</IsComplete>
        <DateAdded>2010-07-20T17:59:27.517Z</DateAdded>
        <DateModified>2011-04-05T16:00:18.527Z</DateModified>
       </Task>
      <RecordCount>1</RecordCount>
    </GetTaskReturn>
  </GetTaskResponse>
</soapenv:Body>
</soapenv:Envelope>

AddUpdateTask()

Part Of: Task Webservice 3.0

WSDL:

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

Australian URL:

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

Description:

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

Parameters:

Attribute	Data Type	Default	Description
WebsiteID*	UUID		Only required for Enterprise Webservices UUID of the Vin65 Website
TaskID	UUID		UUID of the Vin65 Note
AssignToID*	UUID
Subject*	String 255
DueDate*	Date
Comments	String
RelatedTo*	Enumerated ("Contact", "Order", "Product")
KeyCodeID*	UUID		UUID of either the Contact, Order or Product in Vin65
SendEmailNotification	Boolean	False
EmailTo*	String 255		Required if SendEmailNotification is True
IsComplete	Boolean	False
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>
  <AddUpdateTask>
    <Request>
      <Security>
        <Username>//Your Username//</Username>
        <Password>//Your Password//</Password>
      </Security>
      <Task>
        <WebsiteID>71e67a5c-2264-112b-b1f4-a6d602ad8bb4</WebsiteID>
        <TaskID>43e15e63-2264-112b-b157-70b1cc864227</TaskID>
        <AssignToID>5EA8FE81-CAF1-906E-9C5F-E6A6FCAECFE2</AssignToID>
        <Subject>This is a sample subject</Subject>
        <DueDate>2011-09-12T00:00:00</DueDate>
        <Comments>This is a sample note</Comments>
        <RelatedTo>Contact</RelatedTo>
        <KeyCodeID>33ad141d-99d8-82ce-f297-76 e93ca8f5d9</KeyCodeID>
        <SendEmailNotification>true</SendEmailNotification>
        <EmailTo>john@vin65.com</EmailTo>
        <IsComplete>true</IsComplete>
      </Task>
      <Mode>Strict</Mode>
    </Request>
</AddUpdateTask>
</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/XMLSche ma" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance">
<soapenv:Body>
  <AddUpdateTaskResponse>
    <AddUpdateTaskReturn>
      <Errors></Errors>
      <IsSuccessful>true</IsSuccessful>
      <TaskID>43e15e63-2264-112b-b157-70b1cc864227</TaskID>
      <RecordCount>1</RecordCount>
    </AddUpdateTaskReturn>
  </AddUpdateTaskResponse>
</soapenv:Body>
</soapenv:Envelope>

Was this article helpful?

What's Next

Master Contact Service