Objective-C

SugarCRM Filtering Records

See more SugarCRM Examples

Export records and filter. Objective-C

#import <CkoRest.h>
#import <CkoJsonObject.h>
#import <CkoStringBuilder.h>
#import <NSString.h>

BOOL success = NO;

CkoRest *rest = [[CkoRest alloc] init];

success = [rest Connect: @"your.site.domain" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: YES];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

[rest AddHeader: @"Cache-Control" value: @"no-cache"];
[rest AddHeader: @"OAuth-Token" value: @"<access_token>"];

//  The following code creates the JSON request body.
//  The JSON created by this code is shown below.
CkoJsonObject *jsonReq = [[CkoJsonObject alloc] init];
[jsonReq UpdateString: @"filter[0].$or[0].name.$starts" value: @"A"];
[jsonReq UpdateString: @"filter[0].$or[1].name.$starts" value: @"b"];
[jsonReq UpdateNumber: @"max_num" numericStr: @"2"];
[jsonReq UpdateNumber: @"offset" numericStr: @"0"];
[jsonReq UpdateString: @"fields" value: @"id"];
[jsonReq UpdateString: @"order_by" value: @"date_entered"];
[jsonReq UpdateBool: @"favorites" value: NO];
[jsonReq UpdateBool: @"my_items" value: NO];

//  The JSON request body created by the above code:

//  {
//    "filter": [
//      {
//        "$or": [
//          {
//            "name": {
//              "$starts": "A"
//            }
//          },
//          {
//            "name": {
//              "$starts": "b"
//            }
//          }
//        ]
//      }
//    ],
//    "max_num": 2,
//    "offset": 0,
//    "fields": "id",
//    "order_by": "date_entered",
//    "favorites": false,
//    "my_items": false
//  }

CkoStringBuilder *sbReq = [[CkoStringBuilder alloc] init];
[jsonReq EmitSb: sbReq];

[rest AddHeader: @"Content-Type" value: @"application/json"];

CkoStringBuilder *sbJson = [[CkoStringBuilder alloc] init];
success = [rest FullRequestSb: @"POST" uriPath: @"/rest/v10/Accounts/filter" requestBody: sbReq responseBody: sbJson];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@%d",@"Received error response code: ",[rest.ResponseStatusCode intValue]);
    NSLog(@"%@",@"Response body:");
    NSLog(@"%@",[sbJson GetAsString]);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json LoadSb: sbJson];

//  The following code parses the JSON response.
//  A sample JSON response is shown below the sample code.
int next_offset;
int i;
int count_i;
NSString *id = 0;
NSString *date_modified = 0;
NSString *v_module = 0;

next_offset = [[json IntOf: @"next_offset"] intValue];
i = 0;
count_i = [[json SizeOfArray: @"records"] intValue];
while (i < count_i) {
    json.I = [NSNumber numberWithInt: i];
    id = [json StringOf: @"records[i].id"];
    date_modified = [json StringOf: @"records[i].date_modified"];
    v_module = [json StringOf: @"records[i]._module"];
    i = i + 1;
}

//  A sample JSON response body that is parsed by the above code:

//  {
//    "next_offset": 2,
//    "records": [
//      {
//        "id": "f16760a4-3a52-f77d-1522-5703ca28925f",
//        "date_modified": "2016-04-05T10:23:28-04:00",
//        "_acl": {
//          "fields": {}
//        },
//        "_module": "Accounts"
//      },
//      {
//        "id": "ec409fbb-2b22-4f32-7fa1-5703caf78dc3",
//        "date_modified": "2016-04-05T10:23:28-04:00",
//        "_acl": {
//          "fields": {}
//        },
//        "_module": "Accounts"
//      }
//    ]
//  }

NSLog(@"%@",@"Example Completed.");