API-V2 C#_SDK Objekte lesen

Einzelnes Objekt via DataContract lesen

Als Eigenschafts-Filter werden die Property-Namen (oder falls vorhanden die Value des JsonPropertyAttributes) des DataContracts verwendet

SDK-Methode

Task<TResult> IApiV2Endpoint<TId>.GetByIdAsync<TResult>(
  TId id, 
  CancellationToken cancellationToken = default
)

REST-Equivalent

GET /apiv2/servicedmcore/CoreIdentity/3/
?fields=Nachname,Stadt%20%2F%20Ort

Beispiel-Code

public class MyCoreIdentityDataContract
{
    public string Nachname { get; set; }
    [JsonProperty("Stadt / Ort")]
    public string City { get; set; }
}

public async Task GetCoreIdentityById()
{
    var api = GetService<IApiV2Client>();
    var endpoint = api.DmcoreService.Servicedmcore.CoreIdentity;
    MyCoreIdentityDataContract item = await endpoint.GetByIdAsync<MyCoreIdentityDataContract>(3);
}

Einzelnes Objekt via Template-Objekt lesen

Als Eigenschafts-Filter werden die Property-Namen des Template-Objektes verwendet. Abfragen für Eigenschaften welche als Property nicht gültig sind (z.B: Namen mit Leerzeichen) sind mit dieser Methode nicht möglich

SDK-Methode

Task<TResult> IApiV2Endpoint<TId>.GetByIdAsync<TResult>(
  TId id, 
  TResult template, 
  CancellationToken cancellationToken = default
)

REST-Equivalent

GET /apiv2/servicedmcore/CoreIdentity/3/
?fields=Nachname

Beispiel-Code

public async Task GetCoreIdentityById()
{
    var api = GetService<IApiV2Client>();
    var endpoint = api.DmcoreService.Servicedmcore.CoreIdentity;
    var item = await endpoint.GetByIdAsync(3, new
    {
        Nachname = string.Empty
    });
}

Liste von Objekten via DataContract lesen

Als Eigenschafts-Filter werden die Property-Namen (oder falls vorhanden die Value des JsonPropertyAttributes) des DataContracts verwendet

SDK-Methode

IPagedAsyncEnumerable<TResult> IApiV2Endpoint.GetListAsync<TResult>(
  Action<ListOptions<IListModifier>> options = null, 
  CancellationToken cancellationToken = default
);

REST-Equivalent

Kein exaktes equivalent vorhanden da IPagedAsyncEnumerable<TResult> im Hintergrund ein Paging ausführt und weitere Einträge bei Bedarf nachgeladen werden.

GET /apiv2/servicedmcore/CoreIdentity
?fields=Nachname,Stadt%20%2F%20Ort

Beispiel-Code

public class MyCoreIdentityDataContract
{
    public string Nachname { get; set; }
    [JsonProperty("Stadt / Ort")]
    public string City { get; set; }
}

public async Task GetCoreIdentityList()
{
    var api = GetService<IApiV2Client>();
    var endpoint = api.DmcoreService.Servicedmcore.CoreIdentity;
    var list = await endpoint.GetListAsync<MyCoreIdentityDataContract>().ToArray();
}

Liste von Objekten via Template-Objekt lesen

Als Eigenschafts-Filter werden die Property-Namen des Template-Objektes verwendet. Abfragen für Eigenschaften welche als Property nicht gültig sind (z.B: Namen mit Leerzeichen) sind mit dieser Methode nicht möglich

SDK-Methode

IPagedAsyncEnumerable<TResult> IApiV2Endpoint.GetListAsync<TResult>(
  TResult template, 
  Action<ListOptions<IListModifier>> options = null, 
  CancellationToken cancellationToken = default
);

REST-Equivalent

Kein exaktes equivalent vorhanden da IPagedAsyncEnumerable<TResult> im Hintergrund ein Paging ausführt und weitere Einträge bei Bedarf nachgeladen werden.

GET /apiv2/servicedmcore/CoreIdentity
?fields=Nachname

Beispiel-Code

public async Task GetCoreIdentityList()
{
    var api = GetService<IApiV2Client>();
    var endpoint = api.DmcoreService.Servicedmcore.CoreIdentity;
    var list = await endpoint.GetListAsync(new
    {
        Nachname = string.Empty
    }).ToArray();
}

Liste von Objekten via Template-Objekt mit PropertyChains lesen

Als Eigenschafts-Filter werden die Property-Namen des Template-Objektes verwendet. Abfragen für Eigenschaften welche als Property nicht gültig sind (z.B: Namen mit Leerzeichen) sind mit dieser Methode nicht möglich

SDK-Methode

IPagedAsyncEnumerable<TResult> IApiV2Endpoint.GetListAsync<TResult>(
  TResult template, 
  Action<ListOptions<IListModifier>> options = null, 
  CancellationToken cancellationToken = default
);

REST-Equivalent

Kein exaktes equivalent vorhanden da IPagedAsyncEnumerable<TResult> im Hintergrund ein Paging ausführt und weitere Einträge bei Bedarf nachgeladen werden.

GET /apiv2/servicedmcore/CoreIdentity
?fields=Id,Nachname,CoreIdentityType.Id

Beispiel-Code

public async Task GetCoreIdentityList()
{
    var api = GetService<IApiV2Client>();
    var endpoint = api.DmcoreService.Servicedmcore.CoreIdentity;
    var list = await endpoint.GetListAsync(new
    {
        Id = 0u,
        CoreIdentityType = new
        {
            Id = 0u,
        }
    }).ToArray();
}

Liste von Objekten mit Filter

SDK-Methode

IPagedAsyncEnumerable<TResult> IApiV2Endpoint.GetListAsync<TResult>(
  TResult template, 
  Action<ListOptions<IListModifier>> options = null, 
  CancellationToken cancellationToken = default
);

REST-Equivalent

Kein exaktes equivalent vorhanden da IPagedAsyncEnumerable<TResult> im Hintergrund ein Paging ausführt und weitere Einträge bei Bedarf nachgeladen werden.

GET /apiv2/servicedmcore/CoreIdentity
?fields=Nachname
&filter=Stadt%20%2F%20Ort eq Aarau

Beispiel-Code

public async Task GetCoreIdentityList()
{
    var api = GetService<IApiV2Client>();
    var endpoint = api.DmcoreService.Servicedmcore.CoreIdentity;
    var list = await endpoint.GetListAsync(new
    {
        Nachname = string.Empty
    },
    o => o.AddModifier(new PropertyFilter
    {
        FilterType = FilterType.Equals,
        PropertyName = "Stadt / Ort",
        Value = "Aarau"
    })).ToArray();
}