Description

The Jobs call retrieves a list of opportunities and/or jobs 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 either a valid Opportunity or Job 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 opportunities or jobs for 1 organization
• ClientContactID – The contact primary key to return all the opportunities or jobs for 1 contact
• Job-Number – The job 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 opportunities or jobs.

The structure of the response is:

<Jobs TotalRows=nnn TotalPages=nnn MorePages=True/False>
  <Job uuid=`{UUID of record}`}>
    <Job-Number>    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
    <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
    <Job-Description>    Job/Opp description
    <HandlerInitials>    Job/Opp handler initials
    <HandlerName>    Job/Opp handler name
    <Thermo-Value>    Thermometer value based on either Thermo parameter or View default
    <Thermo-Progress>    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
    <JobStatusDesc>    Status of Opp or Job.  Opps are “Quote”, Jobs can be “Live”,“In-house”,“On-hold” or “Special”
    <Lead_ClosedDate>    YYYY-MM-DDT00:00:00Z  ‘Expected close’ 
    <OPLeadRating>    
    <OPcurrentStatus>    
    <SalesStatus>