Objective-C Requires Chilkat v11.7.0+

Validate a QR Code Request

See more QR Code Examples

Demonstrates the validate operation, which examines a request without producing anything. The scope says how far to look: definition checks the options, capacity also checks that the data fits a QR symbol, and layout also checks the rendered size against the limits. The response has a validationStatus of valid or invalid, a list of checks, and findings[] describing what is wrong. A request that cannot be understood at all, such as one with a misspelled option, still makes the call fail in the usual way. Objective-C

#import <CkoFormats.h>
#import <CkoJsonObject.h>

BOOL success = NO;

//  This example requires the Chilkat API to have been previously unlocked.
//  See Global Unlock Sample for sample code.

CkoFormats *fmt = [[CkoFormats alloc] init];
CkoJsonObject *jsonOut = [[CkoJsonObject alloc] init];
int i;
int n;

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"target" value: @"symbol"];
[json UpdateString: @"validation.scope" value: @"capacity"];
[json UpdateString: @"payload.text" value: @"https://www.chilkatsoft.com/barcode_overview.asp"];

success = [fmt QrCode: @"validate" jsonIn: json jsonOut: jsonOut];
if (success == NO) {
    NSLog(@"%@",fmt.LastErrorText);
    return;
}

NSLog(@"%@%@",@"status: ",[jsonOut StringOf: @"validationStatus"]);
n = [[jsonOut SizeOfArray: @"checks"] intValue];
for (i = 0; i <= n - 1; i++) {
    jsonOut.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@%@%@",@"  ",[jsonOut StringOf: @"checks[i].name"],@": ",[jsonOut StringOf: @"checks[i].status"]);
}

//  The same text does not fit version 2 at error-correction level H.
[json UpdateInt: @"encoding.qr.maxVersion" value: [NSNumber numberWithInt: 2]];
[json UpdateString: @"encoding.qr.errorCorrection" value: @"H"];

success = [fmt QrCode: @"validate" jsonIn: json jsonOut: jsonOut];
if (success == NO) {
    NSLog(@"%@",fmt.LastErrorText);
    return;
}

NSLog(@"%@%@",@"status: ",[jsonOut StringOf: @"validationStatus"]);
n = [[jsonOut SizeOfArray: @"checks"] intValue];
for (i = 0; i <= n - 1; i++) {
    jsonOut.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@%@%@",@"  ",[jsonOut StringOf: @"checks[i].name"],@": ",[jsonOut StringOf: @"checks[i].status"]);
}

n = [[jsonOut SizeOfArray: @"findings"] intValue];
for (i = 0; i <= n - 1; i++) {
    jsonOut.I = [NSNumber numberWithInt: i];
    NSLog(@"%@%@%@%@",@"finding: ",[jsonOut StringOf: @"findings[i].code"],@" at ",[jsonOut StringOf: @"findings[i].path"]);
    NSLog(@"%@%@",@"  ",[jsonOut StringOf: @"findings[i].message"]);
}

//  Sample output:

//  status: valid
//    definition: passed
//    capacity: passed
//    layout: notApplicable
//  status: invalid
//    definition: passed
//    capacity: failed
//    layout: notApplicable
//  finding: capacityExceeded at /payload
//    the payload does not fit any admitted QR version at the selected error-correction level