Learn more
 

Ready to get started?

Download a free trial of the Microsoft Planner ODBC Driver to get started:

 Download Now

Learn more:

Microsoft Planner Icon Microsoft Planner ODBC Driver

The Microsoft Planner ODBC Driver is a powerful tool that allows you to connect with live data from Microsoft Planner, directly from any applications that support ODBC connectivity.

Access Microsoft Planner data like you would a database - read, write, and update Microsoft Planner Buckets, Plans, Tasks, etc. through a standard ODBC Driver interface.

In this article

Related articles

Natively Connect to Microsoft Planner Data in PHP


The CData ODBC driver for Microsoft Planner enables you to create PHP applications with connectivity to Microsoft Planner data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for Microsoft Planner into your LAMP or WAMP stack to build Microsoft Planner-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to Microsoft Planner data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

You can connect without setting any connection properties for your user credentials. Below are the minimum connection properties required to connect.

  • InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.
  • Tenant (optional): Set this if you wish to authenticate to a different tenant than your default. This is required to work with an organization not on your default Tenant.

When you connect the Driver opens the MS Planner OAuth endpoint in your default browser. Log in and grant permissions to the Driver. The Driver then completes the OAuth process.

  1. Extracts the access token from the callback URL and authenticates requests.
  2. Obtains a new access token when the old one expires.
  3. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Establish a Connection

Open the connection to Microsoft Planner by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC MicrosoftPlanner Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC MicrosoftPlanner Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Tasks WHERE TaskId = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC MicrosoftPlanner Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Tasks WHERE TaskId = ?"); $success = odbc_execute($query, array('BCrvyMoiLEafem-3RxIESmUAHbLK'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC MicrosoftPlanner Source","user","password"); $query = odbc_exec($conn, "SELECT TaskId, startDateTime FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC Microsoft Planner data Source","user","password"); $query = odbc_exec($conn, "SELECT TaskId, startDateTime FROM Tasks WHERE TaskId = 'BCrvyMoiLEafem-3RxIESmUAHbLK'"); while($row = odbc_fetch_array($query)){ echo $row["TaskId"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC Microsoft Planner data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Tasks WHERE TaskId = ?"); $success = odbc_execute($query, array('BCrvyMoiLEafem-3RxIESmUAHbLK')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are Microsoft Planner-specific adaptations of the PHP community documentation for all ODBC functions.