CallOptions

Specifies the options needed to work with a specific client. This header is only available for use with the Partner WSDL.

API Calls

The defaultNamespace element supports the following calls: create(), merge(), queryAll(), query(), queryMore(), retrieve(), search(), update(), and upsert().

The client element supports all of the above calls, plus the following: convertLead(), login(), delete(), describeGlobal(), describeLayout(), describeTabs(), describeSObject(), describeSObjects(), getDeleted(), getUpdated(), process(), undelete(), getServerTimestamp(), getUserInfo(), setPassword(), and resetPassword().

Fields

Element Name Type Description

Element Name	Type	Description
client	string	A string that identifies a client. If a valid name is not provided, the value 000000000009998 is used. Subsequent calls can override the existing client name.
defaultNamespace	string	A string that identifies a developer namespace prefix. Use this field to resolve field names in managed packages without having to fully specify the fieldName everywhere. For example, if the developer namespace prefix is `battle`, and you have a custom field in your package called botId, you can set this header, and then queries such as the following will succeed: `1query("SELECT id, botId__c from Account");` In this case the actual field queried is the battle__botId__c field. Using this field allows you to write client code without having to specify the namespace prefix. Without this field specified, the full name of the field would have to be used for the query to succeed. In the example above, you would have to specify battle__botId__c. Note that if this field is set, and the query specifies the namespace as well, the response will not include the prefix. For example, if you set this header to `battle`, and issue a query like `query("SELECT id, battle__botId__c from Account");`, the response would use a `botId__c` element, not a `battle_botId__c` element. Describe calls ignore this header, so there will be no ambiguity between fields with namespace prefixes and customer fields of the same name without the prefix.

client

string

A string that identifies a client.

If a valid name is not provided, the value 000000000009998 is used. Subsequent calls can override the existing client name.

defaultNamespace

string

A string that identifies a developer namespace prefix. Use this field to resolve field names in managed packages without having to fully specify the fieldName everywhere.

For example, if the developer namespace prefix is battle, and you have a custom field in your package called botId, you can set this header, and then queries such as the following will succeed:

1query("SELECT id, botId__c from Account");

In this case the actual field queried is the battle__botId__c field.

Using this field allows you to write client code without having to specify the namespace prefix. Without this field specified, the full name of the field would have to be used for the query to succeed. In the example above, you would have to specify battle__botId__c.

Note that if this field is set, and the query specifies the namespace as well, the response will not include the prefix. For example, if you set this header to battle, and issue a query like query("SELECT id, battle__botId__c from Account");, the response would use a botId__c element, not a battle_botId__c element.

Describe calls ignore this header, so there will be no ambiguity between fields with namespace prefixes and customer fields of the same name without the prefix.

Sample Code—C#

This sample shows how to use the CallOptions header. It sets a client ID and a developer namespace prefix, which is used to resolve field names in managed packages. Next, the sample logs the specified user in.

1public void CallOptionsSample()
2{
3    // Web Reference to the imported Partner WSDL.
4    APISamples.partner.SforceService partnerBinding;
5    
6    string username = "USERNAME";
7    string password = "PASSWORD";
8    
9    // The real Client ID will be an API Token provided by Salesforce
10    // to partner applications following a security review.
11    // For more details, see the Security Review FAQ in the online help.
12    string clientId = "SampleCaseSensitiveToken/100";
13    
14    partnerBinding = new SforceService();
15    partnerBinding.CallOptionsValue = new CallOptions();
16    partnerBinding.CallOptionsValue.client = clientId;
17    
18    // Optionally, if a developer namespace prefix has been registered for
19    // your Developer Edition organization, it may also be specified.
20    string prefix = "battle";
21    partnerBinding.CallOptionsValue.defaultNamespace = prefix;
22    
23    try
24    {
25        APISamples.partner.LoginResult lr =
26            partnerBinding.login(username, password);
27    }
28    catch (SoapException e)
29    {
30        Console.WriteLine(e.Code);
31        Console.WriteLine(e.Message);
32    }
33}

SOAP API Developer Guide

CallOptions

API Calls

Fields

Sample Code—C#