[SalesForce] How to pass parameters in web service class in Salesforce

I am writing a web service that would expose Salesforce fields and this one would be called by an external system.

The scenario is that when a user there would views a record detail page of the external system, then a "field present in there needs to get updated with Salesforce Account OwenerID" for that particular record.

So, when the user clicks the record, the web service needs to get that recordId of the external system (memberId) and query back in Salesforce with the memberID and send the response back in JSON format.

The object that I am working is Account, where in I need to send the Account Name, OwnerID and a Custom Field. And the parameter used in the WHERE condition is the "custom filed".

@RestResource(urlMapping='/GetAccountDetails/*')
global with sharing class GetAccountDetails
{
   @HttpGet
   global static String getManagers(RestRequest req, RestResponse res) {
    String memberID = req.requestURI.substring(req.requestURI.lastIndexOf('/')+1);
    //Account result = [SELECT Id, Name, Member_c, OwnerID FROM Account WHERE Member__c = :memberID];
    String accountFields = 'SELECT Id, Name, Member_Number__c, OwnerID FROM Account WHERE Member__c';
    String detailsJSON = JSON.serializePretty(Database.query(accountFields));
    system.debug('******'+detailsJSON);
    return detailsJSON;
}
}

And would also like to know how do I invoke this service at the external system, like, by any URL call or any other way.

Best Answer

You don't need to pass the Request/Response into the method. I would have written this like:

@RestResource(urlMapping='/GetAccountDetails/*')
global with sharing class GetAccountDetails
{
  @HttpGet
  global static List<Account> getManagers()
  {
    RestRequest req = RestContext.request;
    String memberID = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
    return [SELECT Id, Name, Member_c, OwnerID FROM Account WHERE Member__c = :memberID];
  }
}

This assumes you are passing an additional String into the parameters.

And would also like to know how do I invoke this service at the external system, like, by any URL call or any other way.

You could use a SOAP service if you want, but IMO REST is usually the better way to go.

EDIT: @sfdcfox also pointed out that returning the native object allows the caller to specify a JSON or XML response.

EDIT 2: String version of the query.

String query = 'SELECT Id, Name, Member_c, OwnerID FROM Account WHERE Member__c = :memberID';
return Database.query(query);
/* you could also cast it to Account before returning
List<Account> result = Database.query(query);
return result;
*/

Related Solutions

[SalesForce] Creating a schedule web service tutorial

If you are making Http Callouts, you have to use Scheduled Batch Apex. In Batch Apex, you can only make 10 callouts per call. Basically, you just pass 10 records at a time.

I dont have a link to a tutorial but here is sample code for the batch:

global class BatchSync implements Database.Batchable<sObject>,   Database.AllowsCallouts {

 public String query = 'Select ID, Name from Account';
 global Database.QueryLocator start(Database.BatchableContext BC) {
    return Database.getQueryLocator(query);
 }

     global void execute(Database.BatchableContext BC, List<Account> records) {         
        String endpoint;        

        for ( integer i = 0; i< records.size(); i++ ){
         try {                  
          HttpRequest req = new HttpRequest();
          HttpResponse res = new HttpResponse();
          Http http = new Http();
          // Set values to Params

          endpoint = 'Your endpoint';

          req.setHeader('Authorization', header);
          req.setHeader('Content-Type', 'application/json');
          req.setEndpoint(endpoint);
          req.setMethod('POST');
          req.setBody('Information you wanna send');
          req.setCompressed(true); // This is imp according to SF, but please check if
                                 // the webservice accepts the info. Mine did not :P
                                 // Had to set it to false

          if (!Test.isRunningTest()) {      
            res = http.send(req);
            String sJson = res.getBody();
            System.debug('Str:' + res.getBody());
          }             
          // now do what u want to with response.               
          }
          catch (Exception e) {         
            System.debug('Error:' + e.getMessage() + 'LN:' + e.getLineNumber() );           
          }
       }
    }   

    global void finish(Database.BatchableContext BC){    
    }
}

You can use the records Account object to use any data from Accounts and even perform DML operations.

Basically, the above query should have more that 10 Accounts, but in order to make the callouts successful, you tell it do to 10 at a time like this:

 BatchSync BS =  new BatchSync();
 Database.executeBatch(BS,10); // you can also do less than 10

Now you can put these above two lines in the Schedule class and schedule it for the time you want. Using the above method, you can process upto 50 million records in one session.

[SalesForce] Sending a SOAP web-service for each Lead insert

If Leads are added one by one then the trigger size will always be 1.

You could build a check into the trigger to e.g. block batch size larger than 1.

Alternatively, you could maximize the batch size to 10, since that is the max amount of callouts in 1 transaction. You could even make it 100 if you really want to, because you can start 10 @future contexts in 1 transaction, each of which can do 10 callouts.

Best practice, however, is to ask third party webservices to be batch-proof.

Best Answer

Related Solutions

[SalesForce] Creating a schedule web service tutorial

[SalesForce] Sending a SOAP web-service for each Lead insert

Related Topic