LornaJane

SugarCRM SOAP Data Types

Thursday, April 24. 2008

Since SugarCRM only works with PHP5 in non-WSDL mode, I had to create all my calls from scratch. The SugarCRM documentation is somewhat minimal, as I may have mentioned, and I found I was mostly reading the WSDL to figure out how to format my SOAP calls. I've put together a post with working examples but I've also assembled a list of the data types needed. Click through to read more.
note_attachmentnote_attachment
id xsd:string
filename xsd:string
file xsd:string

return_note_attachment
note_attachment tns:note_attachment
error tns:error_value

user_auth
user_name xsd:string
password xsd:string
version xsd:string

field
name xsd:string
type xsd:string
label xsd:string
required xsd:int
options tns:name_value_list
default_value xsd:string

field_list
SOAP-ENC:arrayType tns:field[]

name_value
name xsd:string
value xsd:string

name_value_list
SOAP-ENC:arrayType tns:name_value[]

name_value_lists
SOAP-ENC:arrayType tns:name_value_list[]

select_fields
SOAP-ENC:arrayType xsd:string[]

module_fields
module_name xsd:string
module_fields tns:field_list
error tns_error_value

module_list
modules tns:select_fields
error tns:error_value

error_value
number xsd:string
name xsd:string
description xsd:string

entry_value
id xsd:string
module_name xsd:string
name_value_list tns:name_value_list

entry_list
SOAP-ENC:arrayType tns:entry_value[]

get_mailmerge_document_result
html xsd:string
name_value_list tns:name_value_list
error tns:error_value

get_entry_list_result
result_count xsd:int
next_offset xsd:int
field_list tns:field_list
entry_list tns:entry_list
error tns:error_value

get_entry_result
field_list tns:field_list
entry_list tns:entry_list
error tns:error_value

set_entry_result
id xsd:string
error tns:error_value

set_entries_result
ids tns:select_fields
error tns:error_value

id_mod
id xsd:string
date_modified xsd:string
deleted xsd:int

ids_mods
SOAP_ENC:arrayType tns:id_mod[]

get_relationships_result
ids tns:ids_mods
error tns:error_value

set_relationship_value
module1 xsd:string
module1_id xsd:string
module2 xsd:string
module2_id xsd:string

set_relationship_list
SOAP-ENV:arrayType tns:set_relationship_value[]

set_relationship_list_result
created xsd:int
failed xsd:int
error tns:error_value

document_revision
id xsd:string
document_name xsd:string
revision xsd:string
filename xsd:string
file xsd:string

get_entry_list_result_encoded
result_count xsd:int
next_offset xsd:int
total_count xsd:int
field_list tns:select_fields
entry_list xsd:string
error tns:error_value

get_sync_result_encoded
result xsd:string
error tns:error_value

get_quick_sync_result_encoded
result xsd:string
result_count xsd:int
next_offset xsd:int
total_count xsd:int
error tns:error_value

return_document_revision
document_revision tns:document_revision
error tns:error_value

name_value_operator
name xsd:string
value xsd:string
operator xsd:string
value_array tns:select_fields

name_value_operator_list
SOAP-ENC:arrayType tns:name_value_operator[]

newsletter
name xsd:string
prospect_list_id xsd:string
campaign_id xsd:string
description xsd:string
frequency xsd:string

newsletter_list
SOAP-ENC:arrayType tns:newsletter[]

get_subscription_lists_result
unsubscribed tns:newsletter_list
subscribed tns:newsletter_list
error tns:error_value

str_array
SOAP-ENC:arrayType xsd:string[]

name_value_lists_error
name_value_lists tns:name_value_lists
error tns:error_value

get_entries_count_result
result_count xsd:int
error tns:error_value

set_entries_detail_result
name_value_lists tns:name_value_lists
error tns:error_value

contact_detail
email_address xsd:string
name1 xsd:string
name2 xsd:string
association xsd:string
id xsd:string
msi_id xsd:string
type xsd:string

contact_detail_array
SOAP-ENC:arrayType
tns:contact_detail[]

user_detail
email_address xsd:string
user_name xsd:string
first_name xsd:string
last_name xsd:string
department xsd:string
id xsd:string
title xsd:string

user_detail_array
SOAP-ENC:arrayType tns:user_detail[]
id xsd:string
filename xsd:string
file xsd:string

return_note_attachment
note_attachment tns:note_attachment
error tns:error_value

user_auth
user_name xsd:string
password xsd:string
version xsd:string

field
name xsd:string
type xsd:string
label xsd:string
required xsd:int
options tns:name_value_list
default_value xsd:string

field_list
SOAP-ENC:arrayType tns:field[]

name_value
name xsd:string
value xsd:string

name_value_list
SOAP-ENC:arrayType tns:name_value[]

name_value_lists
SOAP-ENC:arrayType tns:name_value_list[]

select_fields
SOAP-ENC:arrayType xsd:string[]

module_fields
module_name xsd:string
module_fields tns:field_list
error tns_error_value

module_list
modules tns:select_fields
error tns:error_value

error_value
number xsd:string
name xsd:string
description xsd:string

entry_value
id xsd:string
module_name xsd:string
name_value_list tns:name_value_list

entry_list
SOAP-ENC:arrayType tns:entry_value[]

get_mailmerge_document_result
html xsd:string
name_value_list tns:name_value_list
error tns:error_value

get_entry_list_result
result_count xsd:int
next_offset xsd:int
field_list tns:field_list
entry_list tns:entry_list
error tns:error_value

get_entry_result
field_list tns:field_list
entry_list tns:entry_list
error tns:error_value

set_entry_result
id xsd:string
error tns:error_value

set_entries_result
ids tns:select_fields
error tns:error_value

id_mod
id xsd:string
date_modified xsd:string
deleted xsd:int

ids_mods
SOAP_ENC:arrayType tns:id_mod[]

get_relationships_result
ids tns:ids_mods
error tns:error_value

set_relationship_value
module1 xsd:string
module1_id xsd:string
module2 xsd:string
module2_id xsd:string

set_relationship_list
SOAP-ENV:arrayType tns:set_relationship_value[]

set_relationship_list_result
created xsd:int
failed xsd:int
error tns:error_value

document_revision
id xsd:string
document_name xsd:string
revision xsd:string
filename xsd:string
file xsd:string

get_entry_list_result_encoded
result_count xsd:int
next_offset xsd:int
total_count xsd:int
field_list tns:select_fields
entry_list xsd:string
error tns:error_value

get_sync_result_encoded
result xsd:string
error tns:error_value

get_quick_sync_result_encoded
result xsd:string
result_count xsd:int
next_offset xsd:int
total_count xsd:int
error tns:error_value

return_document_revision
document_revision tns:document_revision
error tns:error_value

name_value_operator
name xsd:string
value xsd:string
operator xsd:string
value_array tns:select_fields

name_value_operator_list
SOAP-ENC:arrayType tns:name_value_operator[]

newsletter
name xsd:string
prospect_list_id xsd:string
campaign_id xsd:string
description xsd:string
frequency xsd:string

newsletter_list
SOAP-ENC:arrayType tns:newsletter[]

get_subscription_lists_result
unsubscribed tns:newsletter_list
subscribed tns:newsletter_list
error tns:error_value

str_array
SOAP-ENC:arrayType xsd:string[]

name_value_lists_error
name_value_lists tns:name_value_lists
error tns:error_value

get_entries_count_result
result_count xsd:int
error tns:error_value

set_entries_detail_result
name_value_lists tns:name_value_lists
error tns:error_value

contact_detail
email_address xsd:string
name1 xsd:string
name2 xsd:string
association xsd:string
id xsd:string
msi_id xsd:string
type xsd:string

contact_detail_array
SOAP-ENC:arrayType
tns:contact_detail[]

user_detail
email_address xsd:string
user_name xsd:string
first_name xsd:string
last_name xsd:string
department xsd:string
id xsd:string
title xsd:string

user_detail_array
SOAP-ENC:arrayType tns:user_detail[]
Posted by LornaJane in php at 16:34 | Comments (2) | Trackbacks (0)
Defined tags for this entry: , , ,
Related entries by tags:
Printable PDF Handouts from OpenOffice Impress
Working with Web Services - Froscon 2010
One-Step Symlink Switch
Geeks Can Write
CodeigniterCon 2010

Trackbacks
Trackback specific URI for this entry

No Trackbacks

Comments
Display comments as (Linear | Threaded)

do you take any clients for any sugar dev

#1 steve deguzman (Homepage) on 2010-02-06 11:30 (Reply)

Steve: I work full time and don’t take any additional contracts outside of that however my employers "Ibuildings":http://www.ibuildings.com may be interested, and so we could work together that way? My contact details are on my about page if you want to get in touch, just let me know :)

#2 LornaJane (Homepage) on 2010-02-06 15:10 (Reply)

Add Comment

You can use [geshi lang=lang_name [,ln={y|n}]][/lang] tags to embed source code snippets
Textile-formatting allowed
E-Mail addresses will not be displayed and will only be used for E-Mail notifications.
 
 

Quicksearch

Feeds

Comments

Tyrone about PHP5 Soap Server
Thu, 02.09.2010 14:14
Hi Lorna Jane, Thanks for all this – the info on PHP and Soap on the Net is a total mess. Some choosing to to use nusoap.php – which now doesnt even exist anymore. Great work using this method I was up and running very quickly. However – this method only shows a call passing one paramet [...]
LornaJane about Wordpress Automatic Update Asking for FTP
Wed, 01.09.2010 13:03
Thanks so much to everyone that has dropped in and said that this tip is working for them – I had to refer back to this myself the other day to remind me how to get around the FTP prompt!
sherra about Wordpress Automatic Update Asking for FTP
Fri, 27.08.2010 04:17
great insight. thank you. I moved my blog and forgot what I needed to do to avoid ftp. your suggestion works like a charm.
Carl Nobile about Logrotate Error on Ubuntu
Fri, 27.08.2010 00:16
This issue seems to happen when you move a DB from one machine to another as I did. The procedure you describe above should be put into MySQL documentation. You should put in a bug report to the MySQL people as their documentation needs to updated. And yes the PASSWORD parameter needs to be re [...]
Rudger Gravestein about One-Step Symlink Switch
Mon, 23.08.2010 09:19
i also move the current, so in case of non working result, i can easily move it back. mv -fT current fallback; mv -fT next current;
Anon about One-Step Symlink Switch
Sun, 22.08.2010 19:43
This is a convenient way to upgrade, and is certainly a good thing for development / testing environments. On a busy site there might be a slim risk this technique could be problematic. Although the file system is updated in an atomic transaction, a web browser could still read from both the [...]
Les about Working with Web Services - Froscon 2010
Sun, 22.08.2010 17:35
Once more you shine girl yer its true you’re a PHP babe :D
Edmar about One-Step Symlink Switch
Sat, 21.08.2010 20:17
Nice to see a post about this. :-) 100% of our deploys are done using symlinks. We copy our releases into revision-specific folders (which are rev123, rev124, etc.). Deploy is done using: cd /software-revisions-folder ln -sf rev124 current To revert: ln -sf rev123 current Thi [...]
Deep C about One-Step Symlink Switch
Fri, 20.08.2010 19:09
This is very interesting and helpful tip. I just felt its quite similar to adding a new node to link list in C and moving pointer to next :)