Activities

  <td>

  </td>

  <td>
    [IN]

     Parameters described in Overview
  </td>
</tr>

<tr>
  <td>
    View
  </td>

  <td>
    Integer
  </td>

  <td>
    [IN]

     View to use to filter activities
  </td>
</tr>

<tr>
  <td>
    Company
  </td>

  <td>
    String
  </td>

  <td>
    [IN]

     The company number(s)
  </td>
</tr>

<tr>
  <td>
    Client-Code
  </td>

  <td>
    String
  </td>

  <td>
    [IN]

     (Optional) Organization primary key
  </td>
</tr>

<tr>
  <td>
    ClientContactID
  </td>

  <td>
    Integer
  </td>

  <td>
    [IN]

     (Optional) Contact primary key
  </td>
</tr>

<tr>
  <td>
    Job-Number
  </td>

  <td>
    String
  </td>

  <td>
    [IN]

     (Optional) Job number or JobPhase number
  </td>
</tr>

<tr>
  <td>
    NotesID
  </td>

  <td>
    Integer
  </td>

  <td>
    [IN]

     (Optional) Activity primary key
  </td>
</tr>

<tr>
  <td>
    Search
  </td>

  <td>
    String
  </td>

  <td>
    [IN]

     (Optional) Search string to use
  </td>
</tr>

<tr>
  <td>
    Action
  </td>

  <td>
    String
  </td>

  <td>
    [IN]

     (Optional) COMPLETE or UNCOMPLETE
  </td>
</tr>

<tr>
  <td>
    Response
  </td>

  <td>
    XML or JSON
  </td>

  <td>
    [OUT]

     XML or JSON containing activities the user has access to.
  </td>
</tr>

Description

The Activities call retrieves a list of activities within the specified view and company the user has access to.

Parameters

• View – The numeric primary ID key of the view required (See Views)
• Company – The company number(s) which contain the list required. If passing multiple company numbers, they should be delimited with a carriage return.
• Client-Code – The organization primary key to return all the activities for 1 organization
• ClientContactID – The contact primary key to return all the activities for 1 contact
• Job-Number – The job number or jobphase number to return all activities for 1 job or phase
• NotesID – The activity record primary key to return just 1 record
• Search –String to use to search for records. This is a compound & fuzzy (phonetic) search.
• Action – Pass either COMPLETE or UNCOMPLETE to complete or uncomplete activities

Return Values

Response – XML or JSON containing the list of activities.

The structure of the response is:

<Activities TotalRows=nnn TotalPages=nnn MorePages=True/False>
	<Activity uuid={`{UUID of record}`}>
		<NotesID>		Numeric Primary key
		<Client-Code>		Alpha foreign key to Organizations table e.g. 1/P9887 or 1/ACME
		<Client-Name>		Organization name
		<Phone>			Organization’s telephone number
		<ClientContactID>		Numeric foreign key to Contacts table
		<ForwardsFullName>	Contact full name
		<CellPhone>		Contact mobile number
<Direct-Telephone>	Contact DDI phone number
<Email>			Contact email address
		<Note-Type-Code>		Activity type code
		<Note-Type>		Activity type description
		<Job-Number>		Alpha foreign key to Jobs/Opps table e.g. 1/00009876
		<Job-and-Phase>		Alpha foreign key to Phases table e.g. 1/00009876.001
		<Next-Action>		Activity Subject
		<Description>		Activity Description
		<Creation-Date>		YYYY-MM-DDT00:00:00Z
		<Creation-Time>		0000-00-00THH:MM:SS
		<CreatedByName>		Name of person who created the activity
		<Date-Due>		YYYY-MM-DDT00:00:00Z
		<Time-Due>		YYYY-MM-DDT00:00:00Z
		<Complete>		True/False
		<Completed-Date>		YYYY-MM-DDT00:00:00Z
		<Completed-Time>		0000-00-00THH:MM:SS
		<CompletedByName>	Name of person who completed the activity
		<ActionByName>		Name of current owner of the activity