Skip to main content

Interface IApiAgent

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

Implements

IAgentBase, IDisposable

Methods

GetApiVersionAsync(RequestOptions)

Gets version info from base URL.

Parameters

requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<StringDictionary&gt; 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.

Parameters

tenantCustId string The Online customer id: “Cust1234” subdomain string “sod”, “qastage” or “online”. Default “online” (production). See <xref href=“SuperOffice.WebApi.SubDomain” data-throw-if-not-resolved=“false”></xref> requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<TenantStatus&gt; Tenant status