Objective-C

GeoOp - Create a New User

See more GeoOp Examples

Create a new GeoOp user. Objective-C

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

BOOL success = NO;

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

//  This example also assumes an OAuth2 access token was previously fetched.
//  and saved in a JSON file.  

//  First get our previously obtained access token.
//  {"access_token":"e6dqdG....mzjpT04w==","token_type":"Bearer","expires_in":2592000,"owner_id":999236}
CkoJsonObject *jsonToken = [[CkoJsonObject alloc] init];
success = [jsonToken LoadFile: @"qa_data/tokens/geoop.json"];

//  This example assumes we previously obtained an access token
CkoOAuth2 *oauth2 = [[CkoOAuth2 alloc] init];
oauth2.AccessToken = [jsonToken StringOf: @"access_token"];

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

//  Connect to GeoOp..
//  Note: The same REST object, once connected, can be used for many requests.
//  The bAutoReconnect argument allows it to automatically reconnect as required for any subsequent request.

BOOL bAutoReconnect = YES;
success = [rest Connect: @"api.geoop.com" port: [NSNumber numberWithInt: 443] tls: YES autoReconnect: bAutoReconnect];
if (success != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

//  Provide the authentication credentials (i.e. the access token)
[rest SetAuthOAuth2: oauth2];

//  Set the X-Version header.
[rest AddHeader: @"X-Version" value: @"1.0"];

//  To create a new user, we must build and send the following JSON:
//  {
//      "users": [
//          {
//              "account": {
//                  "id": 39409    <--- This account ID must be one that already exists.
//              },
//              "firstName": "Geoff",
//              "lastName": "Wirtz",
//              "companyName": "Sample Company",
//              "phone": "+12349282001",
//              "mobile": "+12349332744",
//              "email": "gwirtz@example2.com",
//              "login": "gwirtz_sample2",
//              "newPassword": "pa$$wordz",
//              "newPasswordConfirm": "pa$$wordz"
//          }
//      ]
//  }

CkoJsonObject *jsonUser = [[CkoJsonObject alloc] init];
[jsonUser UpdateInt: @"users[0].account.id" value: [NSNumber numberWithInt: 39409]];
[jsonUser UpdateString: @"users[0].firstName" value: @"Geoff"];
[jsonUser UpdateString: @"users[0].lastName" value: @"Wirtz"];
[jsonUser UpdateString: @"users[0].companyName" value: @"Sample Company"];
[jsonUser UpdateString: @"users[0].phone" value: @"+12349282001"];
[jsonUser UpdateString: @"users[0].mobile" value: @"+12349332744"];
[jsonUser UpdateString: @"users[0].email" value: @"gwirtz@example2.com"];
[jsonUser UpdateString: @"users[0].login" value: @"gwirtz_sample2"];
[jsonUser UpdateString: @"users[0].newPassword" value: @"pa$$wordz"];
[jsonUser UpdateString: @"users[0].newPasswordConfirm" value: @"pa$$wordz"];

//  Examine the JSON we're about to send...
jsonUser.EmitCompact = NO;
NSLog(@"%@",[jsonUser Emit]);

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

jsonUser.EmitCompact = YES;
NSString *responseBody = [rest FullRequestString: @"POST" uriPath: @"/users" bodyText: [jsonUser Emit]];
if (rest.LastMethodSuccess != YES) {
    NSLog(@"%@",rest.LastErrorText);
    return;
}

//  If the response status code did not indicate success, then see what happened..
if ([rest.ResponseStatusCode intValue] != 200) {
    NSLog(@"%@",@"Request Header: ");
    NSLog(@"%@",rest.LastRequestHeader);
    NSLog(@"%@",@"----");
    NSLog(@"%@%d",@"Response StatusCode = ",[rest.ResponseStatusCode intValue]);
    NSLog(@"%@%@",@"Response StatusLine: ",rest.ResponseStatusText);
    NSLog(@"%@",@"Response Header:");
    NSLog(@"%@",rest.ResponseHeader);
    NSLog(@"%@",responseBody);
    return;
}

CkoJsonObject *json = [[CkoJsonObject alloc] init];
json.EmitCompact = NO;
[json Load: responseBody];
//  Show the full JSON response..
NSLog(@"%@",[json Emit]);

//  The success JSON looks like this:
//  {
//    "result": "success",
//    "users": [
//      {
//        "id": 984244,
//        "firstName": "Geoff",
//        "lastName": "Wirtz",
//        "companyName": "Sample Company",
//        "email": "gwirtz@example2.com",
//        "phone": "+12349282001",
//        "mobile": "+12349332744",
//        "hourlyRate": 0,
//        "active": 1,
//        "deleted": false,
//        "colour": "#000000",
//        "created": "2016-10-26T18:03:59+00:00",
//        "modified": "2016-10-26T18:03:59+00:00",
//        "isAssignable": true,
//        "avatarUrl": "https:\/\/www.geoop.com\/images\/mobithumb_984244.jpg",
//        "role": {
//          "id": 2
//        },
//        "account": {
//          "id": 39409
//        },
//        "status": {}
//      }
//    ],
//    "metadata": {
//      "receivedItemsCount": 1,
//      "validItems": [
//        0
//      ],
//      "invalidItems": [
//      ]
//    }
//  }
//