The CData ADO.NET Provider for Paylocity implements a standard DbConnection object in PaylocityConnection. You can also use the PaylocityConnectionStringBuilder to programmatically build, parse, and rebuild connection strings.

Creating Connection Objects

See Establishing a Connection for guides to defining the connection string and authenticating. Below is a typical invocation to create PaylocityConnection objects.

C#

using (PaylocityConnection connection =   
  new PaylocityConnection("InitiateOauth=GETANDREFRESH;OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;CompanyId=YourCompanyId;"))  
{  
  connection.Open();  
}

VB.NET

Using connection As New PaylocityConnection("InitiateOauth=GETANDREFRESH;OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;CompanyId=YourCompanyId;")
  connection.Open
End Using

Using PaylocityConnectionStringBuilder

The following code example shows how to use an ADO.NET connection string builder to parse a connection string.

C#

PaylocityConnectionStringBuilder builder =
  new PaylocityConnectionStringBuilder("InitiateOauth=GETANDREFRESH;OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;CompanyId=YourCompanyId;");
  //Pass the connection string builder an existing connection string, and you can get and set any of the elements as strongly typed properties.
  builder.ConnectionString = "InitiateOauth=GETANDREFRESH;OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;CompanyId=YourCompanyId;";
  //Now that the connection string has been parsed,
  // you can work with individual items:
  builder.MyString = "new property";
  builder.MyBoolean = true;

  // You can refer to connection keys using strings, 
  // as well. 
  builder["Logfile"] = "test.log";
  builder["Verbosity"] = 5;

VB.NET

Dim builder As PaylocityConnectionStringBuilder = New PaylocityConnectionStringBuilder("InitiateOauth=GETANDREFRESH;OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;CompanyId=YourCompanyId;")
'Pass the connection string builder an existing connection string, and you can get and set any of the elements using strongly typed properties.
builder.ConnectionString = InitiateOauth=GETANDREFRESH;OAuthClientID=YourClientId;OAuthClientSecret=YourClientSecret;CompanyId=YourCompanyId;"
'Now that the connection string has been parsed,
' you can work with individual items:
builder.MyString = "new property"
builder.MyBoolean = True
  
' You can refer to connection keys using strings, 
' as well. 
builder("Logfile") = "test.log"
builder("Verbosity") = 5