TOP

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  

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> 

Page Top