Crews.PlanningCenter.Api 1.0.0-preview.5

Planning Center API Library

A client library for the Planning Center API built on the JSON:API Framework.

[!NOTE] This is a "scaffolding library" that consists mostly of abstract members and interfaces. It is intended to be implemented as a dependency in the development of higher level Planning Center API clients.

Installation

Crews.PlanningCenter.Api is available on NuGet:

dotnet add package Crews.PlanningCenter.Api

Basic Usage

1. Create a document context derived from PlanningCenterDocumentContext:

class MyContext : PlanningCenterDocumentContext
{
	// Add any conventions or other context settings supported by the JSON:API Framework
}

2. Create a resource POCO type:

class MyResource
{
	public string? FavoriteColor { get; set; }
	public int FavoriteNumber { get; set; }
}

3. Create a fetchable resource wrapper:

class MyFetchableResource : PlanningCenterSingletonFetchableResource<MyResource, MyFetchableResource, MyContext>
{
	private static readonly Uri _resourceUri = new("https://api-url.com/path/to/resource");

	// The following is for example only; do not use HttpClient like this.
	private static readonly HttpClient _client = new();

	public MyFetchableResource() : base(_resourceUri, _client) { }

	// Optionally implement POST and PATCH members, if your resource supports them.
	public new Task<MyResource?> PostAsync(MyResource resource) => base.PostAsync(resource);
	public new Task<MyResource?> PatchAsync(MyResource resource) => base.PatchAsync(resource);
}

4. Fetch your resource!

MyFetchableResource fetchableResource = new();
MyResource resource = await fetchableResource.GetAsync();