10.07.2015 Views

SuiteTalk (Web Services) Platform Guide - NetSuite

SuiteTalk (Web Services) Platform Guide - NetSuite

SuiteTalk (Web Services) Platform Guide - NetSuite

SHOW MORE
SHOW LESS

Create successful ePaper yourself

Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.

Setting <strong>Web</strong> <strong>Services</strong> PreferencesSetting Search Preferences34Setting the ignoreReadOnlyFields PreferenceAfter getting or initializing a record, it is recommended that you set the ignoreReadOnlyFieldspreference to true when submitting the record using write operations such as add/addList orupdate/updateList. Setting this preference to true reduces the possibility of receiving anINSUFFICIENT_PERMISSION error because a read-only field was mistakenly set and thensubmitted.It is also recommended that you set this preference to true when using the initialize/initializeList operations. To submit an initialized record without having to remove read-onlyfields populated during the initialization, set the ignoreReadOnlyFields preference headerpreference to true. When this preference is set to true, read-only fields are simply ignoredduring the <strong>Web</strong> services request.Note: For details on initialize operations, see initialize / initializeList.Setting Search PreferencesThe SearchPreferences type is used to set preferences for the search. This must be set in theSOAP message header. The SearchPreferences type contains the following fields.Element Name XSD Type NotesbodyFieldsOnly boolean Defaults to TRUE and indicates that the information in the bodyfields of the record are returned — significantly improvingperformance. Any fields in associated lists or sublists are notreturned. If the bodyFieldsOnly field is set to FALSE, all fieldsassociated with the record are returned. See Returning BodyFields Only below.pageSize int See Pagination below.returnSearchColumns boolean Defaults to TRUE, meaning that only search columns will bereturned in your search. See Returning Search Columns.passportplatformCore:PassportNote: For information and code samples regarding setting additional request-levelpreferences not related to search, see Setting Request Level Preferences.Returning Body Fields OnlyReferences the Passport object. This is an optional argumentdepending on whether you are authenticating through the loginoperation or you authenticating through request-levelcredentials.When performing searches on records, by default only the body fields are returned only. Toreturn field (line item) values for all sublists on a record, you must set the bodyFieldsOnlyelement to FALSE.It is recommended that the default settings are used wherever sublist values are not necessarysince this significantly improves performance.<strong>SuiteTalk</strong> <strong>Platform</strong> <strong>Guide</strong>

Hooray! Your file is uploaded and ready to be published.

Saved successfully!

Ooh no, something went wrong!