Dart

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. 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.

  // First load the previously obtained API token.
  // See Get Populi Access Token for sample code showing how to get the API token.
  final xml = CkXml();
  xml.loadXmlFile('qa_data/tokens/populi_token.xml');
  final String accessKey;
  try {
    accessKey = xml.getChildContent('access_key');
  } on ChilkatException {
    print('Did not find the access_key');
    return;
  }

  final rest = CkRest();

  // Connect using TLS.
  // A single REST object, once connected, can be used for many Populi REST API calls.
  // The auto-reconnect indicates that if the already-established HTTPS connection is closed,
  // then it will be automatically re-established as needed.
  final bAutoReconnect = true;
  try {
    rest.connect('yourcollege.populi.co', 443, true, bAutoReconnect);
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  rest.authorization = accessKey;

  rest.addQueryParam('task', 'getRoles');

  final String responseBody;
  try {
    responseBody = rest.fullRequestFormUrlEncoded('POST', '/api/index.php');
  } on ChilkatException catch (e) {
    print(e.lastErrorText);
    return;
  }

  // We should expect a 200 response if successful.
  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('Response Body:');
    print(responseBody);
    return;
  }

  xml.loadXml(responseBody);
  print(xml.getXml());

  // Sample response:
  // Use this online tool to generate parsing code from sample XML: 
  // Generate Parsing Code from XML

  // <?xml version="1.0" encoding="ISO-8859-1"?>
  // <response>
  //     <role>
  //         <id>7</id>
  //         <name>Academic Admin</name>
  //         <inactive>0</inactive>
  //     </role>
  //     <role>
  //         <id>19</id>
  //         <name>Financial Aid</name>
  //         <inactive>0</inactive>
  //     </role>
  //     <role>
  //         <id>15</id>
  //         <name>Registrar</name>
  //         <inactive>0</inactive>
  //     </role>
  //     <role>
  //         <id>4</id>
  //         <name>Staff</name>
  //         <inactive>0</inactive>
  //     </role>
  //     <role>
  //         <id>1</id>
  //         <name>Everyone</name>
  //         <inactive>0</inactive>
  //     </role>
  // </response>

  var i = 0;
  var id = 0;
  var name = '';
  var inactive = 0;

  i = 0;
  final countI = xml.numChildrenHavingTag('role');
  while (i < countI) {
    xml.i = i;
    id = xml.getChildIntValue('role[i]|id');
    name = xml.getChildContent('role[i]|name');
    inactive = xml.getChildIntValue('role[i]|inactive');
    i++;
  }
}