I need help with sorting/cleaning up a json object. I have a global class for calling out responses with 4-5 objects.

Consider this example (for sample with 2 objects), My requirement is that I have to create account & list of contacts related to that account and an exception if anything breaks. Respective responses should be sent for the above 3 objects as shown below, which is working fine. Main class & response are also working fine. Need some inputs for removing null objects from JSON.

response class:

global class Qc_Responses {

    global AccountResponse accountResponse {get;set;}
    global list<ContactResponse> contactResponses {get;set;}
    global ExceptionResponse exceptionResponse {get;set;}

    public class AccountResponse
        public String statusCode;
        public String sfAccountId;
        public String message;

        // account Responses for Success / error 
        public AccountResponse(String statusCode, String accId){
            this.statusCode = statusCode;
            SFAccountId = accId;
            this.message = (String.isBlank(accId)) ? 'Account is not Created, Duplicate Account Found' : 'Account Created Successfully' ;


    public class ContactResponse{
        public String statusCode;
        public String message;
        public String sfContactid;
        public String email;
        public String lastName;
        public String phone;
        public ContactResponse(String statusCode,String message, String sfContactid, String email, String lastName, String phone){
            this.statusCode = statusCode;
            this.message = Message;  
            this.sfContactid = sfContactid;
            this.email = email;   
            this.phone = phone;
            this.lastName = lastName; 

    public class ExceptionResponse {
        public String message;
        public String errorCode;
        public ExceptionResponse(String message, String errorcode){
            this.message = message;
            this.errorCode = errorcode;

json response :

    "exceptionResponse": null,
    "contactResponses": [
            "statusCode": "201",
            "sfContactid": "0030k00000RpgLdAAJ",
            "phone": "+610212345678",
            "message": "1Contact(s) Created Successfully",
            "lastName": "Britto",
            "email": "[email protected]"
            "statusCode": "201",
            "sfContactid": "0030k00000RpgLeAAJ",
            "phone": "+61-(02)-12346678",
            "message": "2Contact(s) Created Successfully",
            "lastName": "Smith",
            "email": "[email protected]"
    "accountResponse": {
        "statusCode": "201",
        "sfAccountId": "0010k00000PKwIpAAL",
        "message": "Account Created Successfully"

Main Class :

( adding only the relevant code to minimize space )

global with sharing class QAC_AccountServicesProcess 

    // Instance variables here

    global static QAC_Responses dosomeProcess()
        // All Responses from Salesforce after processing
        QAC_Responses qacResp = new QAC_Responses();
        QAC_Responses.AccountResponse myAccResp;
        QAC_Responses.ContactResponse myContResp;
        QAC_Responses.ExceptionResponse myExcepResp;

        // some object responses are returned as lists after processing
        list<QAC_Responses.ContactResponse> myContRespList = new list<QAC_Responses.ContactResponse>();

        // local variables for business logic

        // Getting REST JSON from Request and setting to Response codes
        RestRequest req = RestContext.request;
        RestResponse res = RestContext.response;
        receivedReq = req.requestBody.toString();

            system.debug(' @@ request 1 @@' +receivedReq);
            QAC_AccountServicesAPI acApi = QAC_AccountServicesAPI.parse(receivedReq);

                    QAC_AccountServicesAPI.AccountDetail accRecResp = acApi.agencyRegistration.accountDetail;

                        // insert Account records
                        createdAcc = doAccountCreation(accRecResp);
                        findObject = 'Account';
                        insert createdAcc;

                        if(createdAcc.Id != null)
                            res.statusCode = 201;
                            myAccResp = new QAC_Responses.AccountResponse('201', 

                            qacResp.accountResponse = myAccResp;


                        // insert Contact (or) ACR Records
                        for(QAC_AccountServicesAPI.ContactDetails contRecResp : accRecResp.contactDetails)
                            // do some logics here and add .. 
                            findObject = 'Contact';
                            insert newContactList;
                            for(Contact eachContact : newContactList){
                                if(eachContact.Id != null){
                                    res.statusCode = 201;
                                    myContResp = new QAC_Responses.contactResponse('201',i+'Contact(s) Created Successfully',
                            qacResp.contactResponses = myContRespList;
            system.debug('QAC Response**'+qacResp);
            return qacResp;
        catch(Exception ex)
            isException = true;

            res.statusCode = 400;
            String sfErrMessage = ex.getMessage();

                sfErrMessage = ex.getMessage().split(':')[1];

                jsonErrMessage = 'Issue with JSON Format. Please check your Payload';
                res.statusCode = (findObject == 'Account') ? 500 : 201 ;
                jsonErrMessage = 'Found errors, Registration Process Failed for - '+findObject+'.Please contact Salesforce';

            myExcepResp = new QAC_Responses.ExceptionResponse('400',jsonErrMessage,
                                                              'Exception Found',sfErrMessage);
            qacResp.exceptionResponse = myExcepResp;

            system.debug('QAC Response**'+qacResp);
            return qacResp;

Need to do 2 things here in the response json..

  1. to remove the null value object here (if No Exception is found, to remove that part of exceptionResponse from JSON)
  2. to sort the response as account object first , then contact , then exception . . (to put accountResponse first in the JSON string and then remaining objects)

Please let me know if this can be done

1 Answer 1


Use the JSON.serialize method, and place the response in RestContext.response.responseBody, as follows:

RestContext.response.responseBody = Blob.valueOf(JSON.serialize(qacResp, true)); 
    // true = suppress nulls

You'll also need to change your return type from QAS_Responses to void:

global static void dosomeProcess()
  • Is there a way to sort the qacResp alphabetically ? Should i have to deserialize it into a list of objects and then do Sort() over the list and then call it back in response ?
    – AjaySFDC
    Jan 18, 2018 at 6:39
  • @AjaySFDC It used to do that automatically. Is this not still the case?
    – sfdcfox
    Jan 18, 2018 at 6:42
  • I can see that its sorting it in reverse alphabetical order, I see that in the response account object stays at the end and other objects pile up above in reverse alphabetical order. Is there any workaround ? I should do as i suggested ? or if there is any easy way about it
    – AjaySFDC
    Jan 18, 2018 at 6:45
  • That null removal is not working. Response is failing.
    – AjaySFDC
    Jan 18, 2018 at 6:52
  • @AjaySFDC It's supposed to work. I wonder if that's some kind of bug in Apex Code or the documentation... I'll ask around.
    – sfdcfox
    Jan 18, 2018 at 7:32

You must log in to answer this question.

Not the answer you're looking for? Browse other questions tagged .