Delphi DLL

Populi Get Roles

See more Populi Examples

Demonstrates the Populi getRoles task. Delphi DLL

uses
    Winapi.Windows, Winapi.Messages, System.SysUtils, System.Variants, System.Classes, Vcl.Graphics,
    Vcl.Controls, Vcl.Forms, Vcl.Dialogs, Vcl.StdCtrls, Rest, Xml;

...

procedure TForm1.Button1Click(Sender: TObject);
var
success: Boolean;
xml: HCkXml;
accessKey: PWideChar;
rest: HCkRest;
bAutoReconnect: Boolean;
responseBody: PWideChar;
i: Integer;
count_i: Integer;
id: Integer;
name: PWideChar;
inactive: Integer;

begin
success := False;

// 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.
xml := CkXml_Create();
success := CkXml_LoadXmlFile(xml,'qa_data/tokens/populi_token.xml');
accessKey := CkXml__getChildContent(xml,'access_key');
if (CkXml_getLastMethodSuccess(xml) <> True) then
  begin
    Memo1.Lines.Add('Did not find the access_key');
    Exit;
  end;

rest := CkRest_Create();

// 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.
bAutoReconnect := True;
success := CkRest_Connect(rest,'yourcollege.populi.co',443,True,bAutoReconnect);
if (success <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

CkRest_putAuthorization(rest,accessKey);

CkRest_AddQueryParam(rest,'task','getRoles');

responseBody := CkRest__fullRequestFormUrlEncoded(rest,'POST','/api/index.php');
if (CkRest_getLastMethodSuccess(rest) <> True) then
  begin
    Memo1.Lines.Add(CkRest__lastErrorText(rest));
    Exit;
  end;

// We should expect a 200 response if successful.
if (CkRest_getResponseStatusCode(rest) <> 200) then
  begin
    Memo1.Lines.Add('Request Header: ');
    Memo1.Lines.Add(CkRest__lastRequestHeader(rest));
    Memo1.Lines.Add('----');
    Memo1.Lines.Add('Response StatusCode = ' + IntToStr(CkRest_getResponseStatusCode(rest)));
    Memo1.Lines.Add('Response StatusLine: ' + CkRest__responseStatusText(rest));
    Memo1.Lines.Add('Response Header:');
    Memo1.Lines.Add(CkRest__responseHeader(rest));
    Memo1.Lines.Add('Response Body:');
    Memo1.Lines.Add(responseBody);
    Exit;
  end;

CkXml_LoadXml(xml,responseBody);
Memo1.Lines.Add(CkXml__getXml(xml));

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

i := 0;
count_i := CkXml_NumChildrenHavingTag(xml,'role');
while i < count_i do
  begin
    CkXml_putI(xml,i);
    id := CkXml_GetChildIntValue(xml,'role[i]|id');
    name := CkXml__getChildContent(xml,'role[i]|name');
    inactive := CkXml_GetChildIntValue(xml,'role[i]|inactive');
    i := i + 1;
  end;

CkXml_Dispose(xml);
CkRest_Dispose(rest);

end;