Step 4: Walk Through the Sample Code

1swfobject.registerObject("clippy.codeblock-1", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17using System;
18using System.Collections.Generic;
19using System.Linq;
20using System.Text;
21using System.Web.Services.Protocols;
22using Walkthrough.sforce;
23
24namespace Walkthrough
25{
26
27   class QuickstartApiSample
28   {
29      private SforceService binding;
30
31      [STAThread]
32      static void Main(string[] args)
33      {
34         QuickstartApiSample sample = new QuickstartApiSample();
35         sample.run();
36      }
37
38      public void run()
39      {
40         // Make a login call 
41         if (login())
42         {
43            // Do a describe global 
44            describeGlobalSample();
45
46            // Describe an account object 
47            describeSObjectsSample();
48
49            // Retrieve some data using a query 
50            querySample();
51
52            // Log out
53            logout();
54         }
55      }
56
57      private bool login()
58      {
59         Console.Write("Enter username: ");
60         string username = Console.ReadLine();
61         Console.Write("Enter password: ");
62         string password = Console.ReadLine();
63
64         // Create a service object 
65         binding = new SforceService();
66
67         // Timeout after a minute 
68         binding.Timeout = 60000;
69
70         // Try logging in   
71         LoginResult lr;
72         try
73         {
74
75            Console.WriteLine("\nLogging in...\n");
76            lr = binding.login(username, password);
77         }
78
79         // ApiFault is a proxy stub generated from the WSDL contract when     
80         // the web service was imported 
81         catch (SoapException e)
82         {
83            // Write the fault code to the console 
84            Console.WriteLine(e.Code);
85
86            // Write the fault message to the console 
87            Console.WriteLine("An unexpected error has occurred: " + e.Message);
88
89            // Write the stack trace to the console 
90            Console.WriteLine(e.StackTrace);
91
92            // Return False to indicate that the login was not successful 
93            return false;
94         }
95
96
97
98         // Check if the password has expired 
99         if (lr.passwordExpired)
100         {
101            Console.WriteLine("An error has occurred. Your password has expired.");
102            return false;
103         }
104
105
106         /** Once the client application has logged in successfully, it will use
107          * the results of the login call to reset the endpoint of the service
108          * to the virtual server instance that is servicing your organization
109          */
110         // Save old authentication end point URL
111         String authEndPoint = binding.Url;
112         // Set returned service endpoint URL
113         binding.Url = lr.serverUrl;
114
115         /** The sample client application now has an instance of the SforceService
116          * that is pointing to the correct endpoint. Next, the sample client
117          * application sets a persistent SOAP header (to be included on all
118          * subsequent calls that are made with SforceService) that contains the
119          * valid sessionId for our login credentials. To do this, the sample
120          * client application creates a new SessionHeader object and persist it to
121          * the SforceService. Add the session ID returned from the login to the
122          * session header
123          */
124         binding.SessionHeaderValue = new SessionHeader();
125         binding.SessionHeaderValue.sessionId = lr.sessionId;
126
127         printUserInfo(lr, authEndPoint);
128
129         // Return true to indicate that we are logged in, pointed  
130         // at the right URL and have our security token in place.     
131         return true;
132      }
133
134      private void printUserInfo(LoginResult lr, String authEP)
135      {
136         try
137         {
138            GetUserInfoResult userInfo = lr.userInfo;
139
140            Console.WriteLine("\nLogging in ...\n");
141            Console.WriteLine("UserID: " + userInfo.userId);
142            Console.WriteLine("User Full Name: " +
143                userInfo.userFullName);
144            Console.WriteLine("User Email: " +
145                userInfo.userEmail);
146            Console.WriteLine();
147            Console.WriteLine("SessionID: " +
148                lr.sessionId);
149            Console.WriteLine("Auth End Point: " +
150                authEP);
151            Console.WriteLine("Service End Point: " +
152                lr.serverUrl);
153            Console.WriteLine();
154         }
155         catch (SoapException e)
156         {
157            Console.WriteLine("An unexpected error has occurred: " + e.Message +
158                " Stack trace: " + e.StackTrace);
159         }
160      }
161
162      private void logout()
163      {
164         try
165         {
166            binding.logout();
167            Console.WriteLine("Logged out.");
168         }
169         catch (SoapException e)
170         {
171            // Write the fault code to the console 
172            Console.WriteLine(e.Code);
173
174            // Write the fault message to the console 
175            Console.WriteLine("An unexpected error has occurred: " + e.Message);
176
177            // Write the stack trace to the console 
178            Console.WriteLine(e.StackTrace);
179         }
180      }
181
182      /**
183      * To determine the objects that are available to the logged-in
184      * user, the sample client application executes a describeGlobal
185      * call, which returns all of the objects that are visible to
186      * the logged-in user. This call should not be made more than
187      * once per session, as the data returned from the call likely
188      * does not change frequently. The DescribeGlobalResult is
189      * simply echoed to the console.
190      */
191      private void describeGlobalSample()
192      {
193         try
194         {
195            // describeGlobal() returns an array of object results that  
196            // includes the object names that are available to the logged-in user. 
197            DescribeGlobalResult dgr = binding.describeGlobal();
198
199            Console.WriteLine("\nDescribe Global Results:\n");
200            // Loop through the array echoing the object names to the console             
201            for (int i = 0; i < dgr.sobjects.Length; i++)
202            {
203               Console.WriteLine(dgr.sobjects[i].name);
204            }
205         }
206         catch (SoapException e)
207         {
208            Console.WriteLine("An exception has occurred: " + e.Message +
209                "\nStack trace: " + e.StackTrace);
210         }
211      }
212
213      /**
214      * The following method illustrates the type of metadata
215      * information that can be obtained for each object available
216      * to the user. The sample client application executes a
217      * describeSObject call on a given object and then echoes  
218      * the returned metadata information to the console. Object
219      * metadata information includes permissions, field types
220      * and length and available values for picklist fields
221      * and types for referenceTo fields.
222      */
223      private void describeSObjectsSample()
224      {
225         Console.Write("\nType the name of the object to " +
226             "describe (try Account): ");
227         string objectType = Console.ReadLine();
228         try
229         {
230
231            // Call describeSObjects() passing in an array with one object type name 
232            DescribeSObjectResult[] dsrArray =
233                  binding.describeSObjects(new string[] { objectType });
234
235            // Since we described only one sObject, we should have only
236            // one element in the DescribeSObjectResult array.
237            DescribeSObjectResult dsr = dsrArray[0];
238
239            // First, get some object properties                  
240            Console.WriteLine("\n\nObject Name: " + dsr.name);
241
242            if (dsr.custom) Console.WriteLine("Custom Object");
243            if (dsr.label != null) Console.WriteLine("Label: " + dsr.label);
244
245            // Get the permissions on the object 
246            if (dsr.createable) Console.WriteLine("Createable");
247            if (dsr.deletable) Console.WriteLine("Deleteable");
248            if (dsr.queryable) Console.WriteLine("Queryable");
249            if (dsr.replicateable) Console.WriteLine("Replicateable");
250            if (dsr.retrieveable) Console.WriteLine("Retrieveable");
251            if (dsr.searchable) Console.WriteLine("Searchable");
252            if (dsr.undeletable) Console.WriteLine("Undeleteable");
253            if (dsr.updateable) Console.WriteLine("Updateable");
254
255            Console.WriteLine("Number of fields: " + dsr.fields.Length);
256
257            // Now, retrieve metadata for each field
258            for (int i = 0; i < dsr.fields.Length; i++)
259            {
260               // Get the field 
261               Field field = dsr.fields[i];
262
263               // Write some field properties
264               Console.WriteLine("Field name: " + field.name);
265               Console.WriteLine("\tField Label: " + field.label);
266
267               // This next property indicates that this  
268               // field is searched when using 
269               // the name search group in SOSL 
270               if (field.nameField)
271                  Console.WriteLine("\tThis is a name field.");
272
273               if (field.restrictedPicklist)
274                  Console.WriteLine("This is a RESTRICTED picklist field.");
275
276               Console.WriteLine("\tType is: " + field.type.ToString());
277
278               if (field.length > 0)
279                  Console.WriteLine("\tLength: " + field.length);
280
281               if (field.scale > 0)
282                  Console.WriteLine("\tScale: " + field.scale);
283
284               if (field.precision > 0)
285                  Console.WriteLine("\tPrecision: " + field.precision);
286
287               if (field.digits > 0)
288                  Console.WriteLine("\tDigits: " + field.digits);
289
290               if (field.custom)
291                  Console.WriteLine("\tThis is a custom field.");
292
293               // Write the permissions of this field
294               if (field.nillable) Console.WriteLine("\tCan be nulled.");
295               if (field.createable) Console.WriteLine("\tCreateable");
296               if (field.filterable) Console.WriteLine("\tFilterable");
297               if (field.updateable) Console.WriteLine("\tUpdateable");
298
299               // If this is a picklist field, show the picklist values   
300               if (field.type.Equals(fieldType.picklist))
301               {
302                  Console.WriteLine("\tPicklist Values");
303                  for (int j = 0; j < field.picklistValues.Length; j++)
304                     Console.WriteLine("\t\t" + field.picklistValues[j].value);
305               }
306
307               // If this is a foreign key field (reference),     
308               // show the values 
309               if (field.type.Equals(fieldType.reference))
310               {
311                  Console.WriteLine("\tCan reference these objects:");
312                  for (int j = 0; j < field.referenceTo.Length; j++)
313                     Console.WriteLine("\t\t" + field.referenceTo[j]);
314               }
315               Console.WriteLine("");
316            }
317         }
318         catch (SoapException e)
319         {
320            Console.WriteLine("An exception has occurred: " + e.Message +
321                "\nStack trace: " + e.StackTrace);
322         }
323         Console.WriteLine("Press ENTER to continue...");
324         Console.ReadLine();
325      }
326
327      private void querySample()
328      {
329         String soqlQuery = "SELECT FirstName, LastName FROM Contact";
330         try
331         {
332            QueryResult qr = binding.query(soqlQuery);
333            bool done = false;
334
335            if (qr.size > 0)
336            {
337               Console.WriteLine("Logged-in user can see "
338                     + qr.records.Length + " contact records.");
339
340               while (!done)
341               {
342                  Console.WriteLine("");
343                  sObject[] records = qr.records;
344                  for (int i = 0; i < records.Length; i++)
345                  {
346                     Contact con = (Contact)records[i];
347                     string fName = con.FirstName;
348                     string lName = con.LastName;
349                     if (fName == null)
350                        Console.WriteLine("Contact " + (i + 1) + ": " + lName);
351                     else
352                        Console.WriteLine("Contact " + (i + 1) + ": " + fName
353                               + " " + lName);
354                  }
355
356                  if (qr.done)
357                  {
358                     done = true;
359                  }
360                  else
361                  {
362                     qr = binding.queryMore(qr.queryLocator);
363                  }
364               }
365            }
366            else
367            {
368               Console.WriteLine("No records found.");
369            }
370         }
371         catch (Exception ex)
372         {
373            Console.WriteLine("\nFailed to execute query succesfully," +
374                "error message was: \n{0}", ex.Message);
375         }
376         Console.WriteLine("\nPress ENTER to continue...");
377         Console.ReadLine();
378      }
379   }
380}

1swfobject.registerObject("clippy.codeblock-2", "9");
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17using System;
18using System.Collections.Generic;
19using System.Linq;
20using System.Text;
21using System.Threading.Tasks;
22
23using System.ServiceModel;
24using Walkthrough.sforce;
25
26namespace Walkthrough
27{
28    class QuickstartApiSample
29    {
30        private static SoapClient loginClient; // for login endpoint
31        private static SoapClient client; // for API endpoint
32        private static SessionHeader header;
33        private static EndpointAddress endpoint;
34
35        static void Main(string[] args)
36        {
37            QuickstartApiSample sample = new QuickstartApiSample();
38            sample.run();
39        }
40
41        public void run()
42        {
43            // Make a login call 
44            if (login())
45            {
46                // Do a describe global 
47                describeGlobalSample();
48
49                // Describe an account object 
50                describeSObjectsSample();
51
52                // Retrieve some data using a query 
53                querySample();
54
55                // Log out
56                logout();
57            }
58        }
59
60        private bool login()
61        {
62            Console.Write("Enter username: ");
63            string username = Console.ReadLine();
64            Console.Write("Enter password: ");
65            string password = Console.ReadLine();
66
67            // Create a SoapClient specifically for logging in
68            loginClient = new SoapClient();
69
70            // (combine pw and token if necessary)
71            LoginResult lr;
72            try
73            {
74                Console.WriteLine("\nLogging in...\n");
75                lr = loginClient.login(null, username, password);
76            }
77            catch (Exception e)
78            {
79                // Write the fault message to the console 
80                Console.WriteLine("An unexpected error has occurred: " + e.Message);
81
82                // Write the stack trace to the console 
83                Console.WriteLine(e.StackTrace);
84                return false;
85            }
86
87            // Check if the password has expired 
88            if (lr.passwordExpired)
89            {
90                Console.WriteLine("An error has occurred. Your password has expired.");
91                return false;
92            }
93
94            /** Once the client application has logged in successfully, it will use
95             * the results of the login call to reset the endpoint of the service
96             * to the virtual server instance that is servicing your organization
97             */
98
99            // On successful login, cache session info and API endpoint info
100            endpoint = new EndpointAddress(lr.serverUrl);
101
102            /** The sample client application now has a cached EndpointAddress
103            * that is pointing to the correct endpoint. Next, the sample client
104            * application sets a persistent SOAP header that contains the
105            * valid sessionId for our login credentials. To do this, the sample
106            * client application creates a new SessionHeader object. Add the session 
107            * ID returned from the login to the session header
108            */
109            header = new SessionHeader();
110            header.sessionId = lr.sessionId;
111
112            // Create and cache an API endpoint client
113            client = new SoapClient("Soap", endpoint);
114
115            printUserInfo(lr, lr.serverUrl);
116
117            // Return true to indicate that we are logged in, pointed  
118            // at the right URL and have our security token in place. 
119            return true;
120        }
121
122        private void printUserInfo(LoginResult lr, String authEP)
123        {
124            try
125            {
126                GetUserInfoResult userInfo = lr.userInfo;
127
128                Console.WriteLine("\nLogging in ...\n");
129                Console.WriteLine("UserID: " + userInfo.userId);
130                Console.WriteLine("User Full Name: " +
131                    userInfo.userFullName);
132                Console.WriteLine("User Email: " +
133                    userInfo.userEmail);
134                Console.WriteLine();
135                Console.WriteLine("SessionID: " +
136                    lr.sessionId);
137                Console.WriteLine("Auth End Point: " +
138                    authEP);
139                Console.WriteLine("Service End Point: " +
140                    lr.serverUrl);
141                Console.WriteLine();
142            }
143            catch (Exception e)
144            {
145                Console.WriteLine("An unexpected error has occurred: " + e.Message +
146                    " Stack trace: " + e.StackTrace);
147            }
148        }
149
150        private void logout()
151        {
152            try
153            {
154                client.logout(header);
155                Console.WriteLine("Logged out.");
156            }
157            catch (Exception e)
158            {
159                // Write the fault message to the console 
160                Console.WriteLine("An unexpected error has occurred: " + e.Message);
161
162                // Write the stack trace to the console 
163                Console.WriteLine(e.StackTrace);
164            }
165        }
166
167        /**
168        * To determine the objects that are available to the logged-in
169        * user, the sample client application executes a describeGlobal
170        * call, which returns all of the objects that are visible to
171        * the logged-in user. This call should not be made more than
172        * once per session, as the data returned from the call likely
173        * does not change frequently. The DescribeGlobalResult is
174        * simply echoed to the console.
175        */
176        private void describeGlobalSample()
177        {
178            try
179            {
180                // describeGlobal() returns an array of object results that  
181                // includes the object names that are available to the logged-in user. 
182                DescribeGlobalResult dgr = client.describeGlobal(
183                          header, // session header
184                          null // package version header
185                          );
186
187                Console.WriteLine("\nDescribe Global Results:\n");
188                // Loop through the array echoing the object names to the console             
189                for (int i = 0; i < dgr.sobjects.Length; i++)
190                {
191                    Console.WriteLine(dgr.sobjects[i].name);
192                }
193            }
194            catch (Exception e)
195            {
196                Console.WriteLine("An exception has occurred: " + e.Message +
197                    "\nStack trace: " + e.StackTrace);
198            }
199        }
200
201        /**
202        * The following method illustrates the type of metadata
203        * information that can be obtained for each object available
204        * to the user. The sample client application executes a
205        * describeSObject call on a given object and then echoes  
206        * the returned metadata information to the console. Object
207        * metadata information includes permissions, field types
208        * and length and available values for picklist fields
209        * and types for referenceTo fields.
210        */
211        private void describeSObjectsSample()
212        {
213            Console.Write("\nType the name of the object to " +
214                 "describe (try Account): ");
215            string objectType = Console.ReadLine();
216            try
217            {
218
219                // Call describeSObjects() passing in an array with one object type name 
220                DescribeSObjectResult[] dsrArray =
221                      client.describeSObjects(
222                        header, // session header
223                        null, // package version header
224                        null, // locale options
225                        new string[] { objectType } // object name array
226                        );
227
228                // Since we described only one sObject, we should have only
229                // one element in the DescribeSObjectResult array.
230                DescribeSObjectResult dsr = dsrArray[0];
231
232                // First, get some object properties                  
233                Console.WriteLine("\n\nObject Name: " + dsr.name);
234
235                if (dsr.custom) Console.WriteLine("Custom Object");
236                if (dsr.label != null) Console.WriteLine("Label: " + dsr.label);
237
238                // Get the permissions on the object 
239                if (dsr.createable) Console.WriteLine("Createable");
240                if (dsr.deletable) Console.WriteLine("Deleteable");
241                if (dsr.queryable) Console.WriteLine("Queryable");
242                if (dsr.replicateable) Console.WriteLine("Replicateable");
243                if (dsr.retrieveable) Console.WriteLine("Retrieveable");
244                if (dsr.searchable) Console.WriteLine("Searchable");
245                if (dsr.undeletable) Console.WriteLine("Undeleteable");
246                if (dsr.updateable) Console.WriteLine("Updateable");
247
248                Console.WriteLine("Number of fields: " + dsr.fields.Length);
249
250                // Now, retrieve metadata for each field
251                for (int i = 0; i < dsr.fields.Length; i++)
252                {
253                    // Get the field 
254                    Field field = dsr.fields[i];
255
256                    // Write some field properties
257                    Console.WriteLine("Field name: " + field.name);
258                    Console.WriteLine("\tField Label: " + field.label);
259
260                    // This next property indicates that this  
261                    // field is searched when using 
262                    // the name search group in SOSL 
263                    if (field.nameField)
264                        Console.WriteLine("\tThis is a name field.");
265
266                    if (field.restrictedPicklist)
267                        Console.WriteLine("This is a RESTRICTED picklist field.");
268
269                    Console.WriteLine("\tType is: " + field.type.ToString());
270
271                    if (field.length > 0)
272                        Console.WriteLine("\tLength: " + field.length);
273
274                    if (field.scale > 0)
275                        Console.WriteLine("\tScale: " + field.scale);
276
277                    if (field.precision > 0)
278                        Console.WriteLine("\tPrecision: " + field.precision);
279
280                    if (field.digits > 0)
281                        Console.WriteLine("\tDigits: " + field.digits);
282
283                    if (field.custom)
284                        Console.WriteLine("\tThis is a custom field.");
285
286                    // Write the permissions of this field
287                    if (field.nillable) Console.WriteLine("\tCan be nulled.");
288                    if (field.createable) Console.WriteLine("\tCreateable");
289                    if (field.filterable) Console.WriteLine("\tFilterable");
290                    if (field.updateable) Console.WriteLine("\tUpdateable");
291
292                    // If this is a picklist field, show the picklist values   
293                    if (field.type.Equals(fieldType.picklist))
294                    {
295                        Console.WriteLine("\tPicklist Values");
296                        for (int j = 0; j < field.picklistValues.Length; j++)
297                            Console.WriteLine("\t\t" + field.picklistValues[j].value);
298                    }
299
300                    // If this is a foreign key field (reference),     
301                    // show the values 
302                    if (field.type.Equals(fieldType.reference))
303                    {
304                        Console.WriteLine("\tCan reference these objects:");
305                        for (int j = 0; j < field.referenceTo.Length; j++)
306                            Console.WriteLine("\t\t" + field.referenceTo[j]);
307                    }
308                    Console.WriteLine("");
309                }
310            }
311            catch (Exception e)
312            {
313                Console.WriteLine("An exception has occurred: " + e.Message +
314                    "\nStack trace: " + e.StackTrace);
315            }
316            Console.WriteLine("Press ENTER to continue...");
317            Console.ReadLine();
318        }
319
320        private void querySample()
321        {
322            String soqlQuery = "SELECT FirstName, LastName FROM Contact";
323            try
324            {
325                QueryResult qr = client.query(
326                    header, // session header
327                    null, // query options
328                    null, // mru options
329                    null, // package version header
330                    soqlQuery // query string
331                    );
332
333                bool done = false;
334
335                if (qr.size > 0)
336                {
337                    Console.WriteLine("Logged-in user can see "
338                        + qr.records.Length + " contact records.");
339
340                    while (!done)
341                    {
342                        Console.WriteLine("");
343                        sObject[] records = qr.records;
344                        for (int i = 0; i < records.Length; i++)
345                        {
346                            Contact con = (Contact)records[i];
347                            string fName = con.FirstName;
348                            string lName = con.LastName;
349                            if (fName == null)
350                                Console.WriteLine("Contact " + (i + 1) + ": " + lName);
351                            else
352                                Console.WriteLine("Contact " + (i + 1) + ": " + fName
353                                   + " " + lName);
354                        }
355
356                        if (qr.done)
357                        {
358                            done = true;
359                        }
360                        else
361                        {
362                            qr = client.queryMore(
363                                    header, // session header
364                                    null, // query options
365                                    qr.queryLocator // query locator
366                                    );
367                        }
368                    }
369                }
370                else
371                {
372                   Console.WriteLine("No records found.");
373                }
374            }
375            catch (Exception ex)
376            {
377                Console.WriteLine("\nFailed to execute query succesfully," +
378                    "error message was: \n{0}", ex.Message);
379            }
380            Console.WriteLine("\nPress ENTER to continue...");
381            Console.ReadLine();
382        }
383    }
384}
385