<a id=“SuperOffice_WebApi_Agents_IApiAgent”></a> 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

<a id=“SuperOffice_WebApi_Agents_IApiAgent_GetApiVersionAsync_SuperOffice_WebApi_RequestOptions_”></a> 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”

<a id=“SuperOffice_WebApi_Agents_IApiAgent_GetTenantStatusAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> 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 <xref href=“SuperOffice.WebApi.SubDomain” data-throw-if-not-resolved=“false”></xref> requestOptions RequestOptions Override language/culture codes on this request.

Returns

Task<TenantStatus> Tenant status

​<a id=“SuperOffice_WebApi_Agents_IApiAgent”></a> Interface IApiAgent

​Implements

​Methods

​<a id=“SuperOffice_WebApi_Agents_IApiAgent_GetApiVersionAsync_SuperOffice_WebApi_RequestOptions_”></a> GetApiVersionAsync(RequestOptions)

​Parameters

​Returns

​<a id=“SuperOffice_WebApi_Agents_IApiAgent_GetTenantStatusAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetTenantStatusAsync(string, string, RequestOptions)

​Parameters

​Returns

<a id=“SuperOffice_WebApi_Agents_IApiAgent”></a> Interface IApiAgent

Implements

Methods

<a id=“SuperOffice_WebApi_Agents_IApiAgent_GetApiVersionAsync_SuperOffice_WebApi_RequestOptions_”></a> GetApiVersionAsync(RequestOptions)

Parameters

Returns

<a id=“SuperOffice_WebApi_Agents_IApiAgent_GetTenantStatusAsync_System_String_System_String_SuperOffice_WebApi_RequestOptions_”></a> GetTenantStatusAsync(string, string, RequestOptions)

Parameters

Returns