Views

Description

The Views call retrieves a list of views of the requested type and company the user has access to. This will include user-specific views, company views and system views.

Parameters

• Type – The type of view list to return. Valid values are:
  • “Organizations”
  • “Contacts”
  • “Activities”
  • “Opportunities”
  • “Jobs”
  • “Phases”
• Company – The company number(s) which contain the view list required. If you omit this parameter or pass an empty string as the company number, all views will be returned. If passing multiple company numbers, they should be delimited with a carriage return.

Return Values

Response – XML/JSON. A list containing the views of the requested type that the user has access to.

The structure of the response is:

<Views  TotalRows=nnn TotalPages=nnn MorePages=True/False>
	<View uuid={UUID of record}>
		<SettingsID>		Numeric primary key
		<Company>		Company number – this is 0  for “System” views
		<Default>			True or False – Whether this record is the user’s default view
		<Display-Order>		Sort order field for views
		<UserID>			Numeric ID – this is 0 for “System” Views and “Company” views
		<Thermo_Index>		Which thermometer to display (only for Opportunity/Job/Phase views)
		<Desc>			Description of the view