Phases

Description

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

Parameters

• View – The numeric primary ID key of the view required (See Views). Pass a valid Phase view.
• Company – The company number(s) which contain the list required. If passing multiple company numbers, they should be delimited with a carriage return.
• Thermo – The thermometer index (See Thermos). The default value for Thermo should be from the relevant view (See Views), this parameter will override the one stored with the view. If this parameter is omitted or zero is passed, the thermometer values returned will be based on the one from the supplied view.
• Client-Code – The organization primary key to return all the phases for 1 organization
• ClientContactID – The contact primary key to return all the phases for 1 contact
• Job-Number – The job number to return all phases for 1 job/opportunity
• Job-And-Phase – The phase record primary key to return just 1 record
• Search –String to use to search for records

Return Values

Response – XML or JSON containing the list of phases.

<Phases TotalRows=nnn TotalPages=nnn MorePages=True/False>
	<Phase uuid={`{UUID of record}`}>
		<Job-and-Phase>		Primary key.  Includes job number and phase number separated by a dot (1/00009887.001)
<Job-Number>		Job number (1/00009887)
 		<Phase> 			Phase number (001)
<DisplayOrder>		Phases should be sorted for display by DisplayOrder, followed by Phase
<Client-Code>		Alpha foreign key to Organizations table e.g. 1/P9887 or 1/ACME
<Client-Name>		Organization name
<Phone>			Organization’s telephone number
<Contact-Internal-Ref>	Numeric foreign key to Contacts table
		<ForwardsFullName>	Contact full name
		<CellPhone>		Contact mobile number
<Direct-Telephone>	Contact DDI phone number
<Email>			Contact email address
<Phase-Descripti>		Phase description
<HandlerInitials>		Phase handler initials
<HandlerName>		Phase handler name
<ThermoValue> 		Thermometer value based on either Thermo parameter or View default
<ThermoProgress>		A number from 1 to 13 to indicate thermometer progress (usually 10% thru 130%)
				(The Synergist UI also shows a marker at the 100% mark)
<Date-in>			YYYY-MM-DDT00:00:00Z
<Time-In>		0000-00-00THH:MM:SS 
<Date-Required>		YYYY-MM-DDT00:00:00Z
<Time-Required>		0000-00-00THH:MM:SS
<PhaseStatusDesc>		Status of phase.  Opps are “Quote”, Jobs can be “Live”,“In-house”,“On-hold” or “Special”