Interface IApiAgent

Namespace: SuperOffice.WebApi.Agents
Assembly: SuperOffice.WebApi.dll Interface for API agents: API info, tenant status, Client library version

public interface IApiAgent : IAgentBase, IDisposable

Implements

IAgentBase, IDisposable

Methods

GetApiVersionAsync(RequestOptions)

Gets version info from base URL.

Task<StringDictionary> GetApiVersionAsync(RequestOptions requestOptions = null)

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<StringDictionary> Dictionary containing meta-data: “NetServerVersion”, “Services”, “Version”

GetTenantStatusAsync(string, string, RequestOptions)

Returns the tenant status for a given customer, in a given environment. Does not need base URL to be set.

Task<TenantStatus> GetTenantStatusAsync(string tenantCustId, string subdomain, RequestOptions requestOptions = null)

Parameters

tenantCustId string The Online customer id: “Cust1234” subdomain string “sod”, “qastage” or “online”. Default “online” (production). See SubDomain requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<TenantStatus> Tenant status

​Interface IApiAgent

​Implements

​Methods

​GetApiVersionAsync(RequestOptions)

​Parameters

​Returns

​GetTenantStatusAsync(string, string, RequestOptions)

​Parameters

​Returns

Interface IApiAgent

Implements

Methods

GetApiVersionAsync(RequestOptions)

Parameters

Returns

GetTenantStatusAsync(string, string, RequestOptions)

Parameters

Returns