soap/SoapDeprecated.php

Constants

 
                sugarEntry
                = true

Functions

account_by_search(
           $name,  $where
              =
              '',  $msi_id
              =
              '0'
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$where
$msi_id

add_contacts_matching_email_address(
          array $output_list, string $email_address, \Contact $seed_contact, \ID $msi_id
          )
        
        :
          void

Internal: When building a response to the plug-in for Microsoft Outlook, find all contacts that match the email address that was provided.

Parameters

Name	Type	Description
$output_list	array	by ref $output_list -- The list of matching beans. New contacts that match the email address are appended to the $output_list
$email_address	string	-- an email address to search for
$seed_contact	\Contact	-- A template SugarBean. This is a blank Contact
$msi_id	\ID	-- Index Count

add_leads_matching_email_address(
          Array $output_list, String $email_address, \Bean $seed_lead, int $msi_id
          )
        
        :
          void

Internal: Add Leads that match the specified email address to the result array

Parameters

Name	Type	Description
$output_list	Array	-- List of matching detail records
$email_address	String	-- Email address
$seed_lead	\Bean	-- Seed Lead Bean
$msi_id	int	-- output array offset.

bug_by_search(
           $name,  $where
              =
              '',  $msi_id
              =
              '0'
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$where
$msi_id

case_by_search(
           $name,  $where
              =
              '',  $msi_id
              =
              '0'
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$where
$msi_id

contact_by_email(
          string $user_name, string $password, string $email_address
          )
        
        :
          \contact

Return a list of contact and lead detail records based on a single email address or a list of email addresses separated by '; '.

This function does not require a session be created first.

Parameters

Name	Type	Description
$user_name	string	-- User name to authenticate with
$password	string	-- MD5 of the user password
$email_address	string	-- Single email address or '; ' separated list of email addresses (e.x "test@example.com; test2@example.com"

Returns

Type	Description
\contact	detail array along with associated objects.

contact_by_search(
          string $name, string $where
              =
              '', int $msi_id
              =
              '0'
          )
        
        :
          array

Internal: Search for contacts based on the specified name and where clause.

Currently only the name is used.

Parameters

Name	Type	Description
$name	string	-- Name to search for.
$where	string	-- Where clause defaults to ''
$msi_id	int	-- Response array index

Returns

Type	Description
array	-- Resturns a list of contacts that have the provided name.

create_account(
           $user_name,  $password,  $name,  $phone,  $website
          )
        
        :
          void

Parameters

Name	Type	Description
$user_name
$password
$name
$phone
$website

create_case(
           $user_name,  $password,  $name
          )
        
        :
          void

Parameters

Name	Type	Description
$user_name
$password
$name

create_contact(
           $user_name,  $password,  $first_name,  $last_name,  $email_address
          )
        
        :
          void

Parameters

Name	Type	Description
$user_name
$password
$first_name
$last_name
$email_address

create_lead(
           $user_name,  $password,  $first_name,  $last_name,  $email_address
          )
        
        :
          void

Parameters

Name	Type	Description
$user_name
$password
$first_name
$last_name
$email_address

create_opportunity(
           $user_name,  $password,  $name,  $amount
          )
        
        :
          void

Parameters

Name	Type	Description
$user_name
$password
$name
$amount

create_session(
          string $user_name, string $password
          )
        
        :
          \"Success"\"Failed"

Create a new session. This method is required before calling any other functions.

Parameters

Name	Type	Description
$user_name	string	-- the user name for the session
$password	string	-- MD5 of user password

Returns

Type	Description
\"Success"\"Failed"	if the session is createdif the session creation failed.

end_session(
          string $user_name
          )
        
        :
          \"Success"\"Failed"

End a session. This method will end the SOAP session.

Parameters

Name	Type	Description
$user_name	string	-- the user name for the session

Returns

Type	Description
\"Success"\"Failed"	if the session is destroyedif the session destruction failed.

get_account_array(
           $account, int $msi_id
          )
        
        :
          \An

Internal: convert a bean into an array

Parameters

Name	Type	Description
$account
$msi_id	int	-- Russult array index

Returns

Type	Description
\An	associated array containing the detail fields.

get_bean_array(
           $value, int $msi_id,  $type
          )
        
        :
          \An

Internal: convert a bean into an array

Parameters

Name	Type	Description
$value
$msi_id	int	-- Russult array index
$type

Returns

Type	Description
\An	associated array containing the detail fields.

get_case_array(
           $value, int $msi_id
          )
        
        :
          \An

Internal: convert a bean into an array

Parameters

Name	Type	Description
$value
$msi_id	int	-- Russult array index

Returns

Type	Description
\An	associated array containing the detail fields.

get_contact_array(
           $contact, int $msi_id
              =
              '0'
          )
        
        :
          \An

Internal: convert a bean into an array

Parameters

Name	Type	Description
$contact
$msi_id	int	-- Russult array index

Returns

Type	Description
\An	associated array containing the detail fields.

get_contact_relationships(
          string $user_name, string $password, string $id
          )
        
        :
          \contact

Return a list of modules related to the specifed contact record

This function does not require a session be created first.

Parameters

Name	Type	Description
$user_name	string	-- User name to authenticate with
$password	string	-- MD5 of the user password
$id	string	-- the id of the record

Returns

Type	Description
\contact	detail array along with associated objects.

get_lead_array(
           $lead, int $msi_id
              =
              '0'
          )
        
        :
          \An

Internal: convert a bean into an array

Parameters

Name	Type	Description
$lead
$msi_id	int	-- Russult array index

Returns

Type	Description
\An	associated array containing the detail fields.

get_opportunity_array(
           $value, int $msi_id
              =
              '0'
          )
        
        :
          \An

Internal: convert a bean into an array

Parameters

Name	Type	Description
$value
$msi_id	int	-- Russult array index

Returns

Type	Description
\An	associated array containing the detail fields.

get_user_list_array(
          \User $user
          )
        
        :
          \An

Internal: Convert a user into an array

Parameters

Name	Type	Description
$user	\User	-- The user to convert

Returns

Type	Description
\An	associated array containing the detail fields.

lead_by_search(
           $name,  $where
              =
              '',  $msi_id
              =
              '0'
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$where
$msi_id

opportunity_by_search(
           $name,  $where
              =
              '',  $msi_id
              =
              '0'
          )
        
        :
          void

Parameters

Name	Type	Description
$name
$where
$msi_id

search(
           $user_name,  $password,  $name
          )
        
        :
          void

Parameters

Name	Type	Description
$user_name
$password
$name

track_email(
          string $user_name, string $password, \id $parent_id, \unknown_type $contact_ids, string $date_sent, string $email_subject, string $email_body
          )
        
        :
          \"Invalid\-1

Record and email message and associated it with the specified parent bean and contact ids.

This function does not require a session be created first.

Parameters

Name	Type	Description
$user_name	string	-- Name of the user to authenticate
$password	string	-- MD5 hash of the user password for authentication
$parent_id	\id	-- [optional] The parent record to link the email to.
$contact_ids	\unknown_type
$date_sent	string	-- Date/time the email was sent in Visual Basic Date format. (e.g. '7/22/2004 9:36:31 AM')
$email_subject	string	-- The subject of the email
$email_body	string	-- The body of the email

Returns

Type	Description
\"Invalid\-1	username and/or password"If the authenticated user does not have ACL access to save Email.

user_list(
          string $user, \password $password
          )
        
        :
          \User

Get a full user list.

This function does not require a session be created first.

Parameters

Name	Type	Description
$user	string	-- user name for validation
$password	\password	-- MD5 hash of the user password for validation

Returns

Type	Description
\User	Array -- An array of user detail records

validate_user(
          string $user_name, string $password
          )
        
        :
          truefalse

Validate the user session based on user name and password hash.

Parameters

Name	Type	Description
$user_name	string	-- The user name to create a session for
$password	string	-- The MD5 sum of the user's password

Returns

Type	Description
truefalse	-- If the session is created-- If the session is not created