Sugar Developer Guide

Version 5.1

Chapter 2 Application Framework : Web Services : SugarSoap Login

SugarSoap Login

First you will need to login to the SugarCRM system through the SOAP interface.

•

Call: login

•

Arguments:

o

complex-type:user_auth – contains the user credentials used to log in.

o

string:application_name – this is a unique application name(example: SugarCRM)

•

Results:

o

complex-type: set_entry_result - in this case the id of set_entry_result is the SugarSoap API’s session_id.

•

Note: This session id value is needed in all future SOAP calls. So you will want to store this in a session or application level variable.

New complex types introduced in this section.

•

user_auth is a struct containing three parameters:

o

string:user_name – this is the SugarSoap user name

o

string:password – this is an md5 of the SugarSoap user password

o

string:version – this is the version of SOAP you are expecting(at this point use 1.0)

•

set_entry_result is a struct containing two parameters.

o

string:id - this is the id for the result

o

complex-type:error (error_value) this is the error if any

•

error_value is a struct containing three parameters:

o

string:number - this is the error number. An error number of 0 indicates no errors were encountered

o

string:name – this is the error name

o

string:description – this is the error description