SugarCRM SOAP Data Types

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[]

2 thoughts on “SugarCRM SOAP Data Types

  1. 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 :)

Leave a Reply

Please use [code] and [/code] around any source code you wish to share.

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>