Dart

GeoOp - Create a New User

See more GeoOp Examples

Create a new GeoOp user. Dart

import 'package:chilkat/chilkat.dart';

void main() {
  // 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}
  final jsonToken = CkJsonObject();
  jsonToken.loadFile('qa_data/tokens/geoop.json');

  // This example assumes we previously obtained an access token
  final oauth2 = CkOAuth2();
  oauth2.accessToken = jsonToken.stringOf('access_token');

  final rest = CkRest();

  // 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.

  final bAutoReconnect = true;
  try {
    rest.connect('api.geoop.com', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // Provide the authentication credentials (i.e. the access token)
  rest.setAuthOAuth2(oauth2);

  // Set the X-Version header.
  rest.addHeader('X-Version', '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"
  //         }
  //     ]
  // }

  final jsonUser = CkJsonObject();
  jsonUser.updateInt('users[0].account.id', 39409);
  jsonUser.updateString('users[0].firstName', 'Geoff');
  jsonUser.updateString('users[0].lastName', 'Wirtz');
  jsonUser.updateString('users[0].companyName', 'Sample Company');
  jsonUser.updateString('users[0].phone', '+12349282001');
  jsonUser.updateString('users[0].mobile', '+12349332744');
  jsonUser.updateString('users[0].email', 'gwirtz@example2.com');
  jsonUser.updateString('users[0].login', 'gwirtz_sample2');
  jsonUser.updateString('users[0].newPassword', 'pa\$\$wordz');
  jsonUser.updateString('users[0].newPasswordConfirm', 'pa\$\$wordz');

  // Examine the JSON we're about to send...
  jsonUser.emitCompact = false;
  print(jsonUser.emit());

  rest.addHeader('Content-Type', 'application/json');

  jsonUser.emitCompact = true;
  final String responseBody;
  try {
    responseBody = rest.fullRequestString('POST', '/users', jsonUser.emit());
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // If the response status code did not indicate success, then see what happened..
  if (rest.responseStatusCode != 200) {
    print('Request Header: ');
    print(rest.lastRequestHeader);
    print('----');
    print('Response StatusCode = ${rest.responseStatusCode}');
    print('Response StatusLine: ${rest.responseStatusText}');
    print('Response Header:');
    print(rest.responseHeader);
    print(responseBody);
    return;
  }

  final json = CkJsonObject();
  json.emitCompact = false;
  json.load(responseBody);
  // Show the full JSON response..
  print(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": [
  //     ]
  //   }
  // }
  // 
}