Class EnrollmentClient

Client for interacting with the Enrollment resource.

public class EnrollmentClient : SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>

Inheritance: object

ResourceClient<Enrollment>

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>

EnrollmentClient

Inherited Members: SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.GetAsync(CancellationToken)

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.PostAsync(Uri, CancellationToken)

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.PatchAsync(Enrollment, CancellationToken)

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.PatchAsync(JsonApiDocument<EnrollmentResource>, CancellationToken)

SingletonResourceClient<Enrollment, EnrollmentResource, EnrollmentResponse>.DeleteAsync(CancellationToken)

ResourceClient<Enrollment>.AddQueryParameter(string, string)

ResourceClient<Enrollment>.ReplaceQueryParameter(string, string)

ResourceClient<Enrollment>.EnsureSuccessAsync(HttpResponseMessage, CancellationToken)

ResourceClient<Enrollment>.Uri

ResourceClient<Enrollment>.HttpClient

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Client for interacting with the Enrollment resource.

public EnrollmentClient(HttpClient httpClient, Uri uri)

Adds a custom query parameter to the request URI.

public EnrollmentClient AddCustomParameter(string parameter, string value)

Removes the entire query string from the request URI.

public EnrollmentClient ClearParameters()

Fetches the Enrollment resource asynchronously.

public Task<EnrollmentResponse> GetAsync(CancellationToken cancellationToken = default)

cancellationToken CancellationToken: A token to monitor for cancellation requests.

Task<EnrollmentResponse>: A task representing the asynchronous operation, containing the Enrollment resource.

JsonApiException: Thrown when the HTTP response indicates a failure status code.