HealthVaultPlatformInformation.GetServiceDefinition HealthVaultPlatformInformation.GetServiceDefinition HealthVaultPlatformInformation.GetServiceDefinition Method

Definition

Overloads

GetServiceDefinition(HealthServiceConnection) GetServiceDefinition(HealthServiceConnection) GetServiceDefinition(HealthServiceConnection)

Gets information about the HealthVault service.

GetServiceDefinition(HealthServiceConnection, ServiceInfoSections) GetServiceDefinition(HealthServiceConnection, ServiceInfoSections) GetServiceDefinition(HealthServiceConnection, ServiceInfoSections)

Gets information about the HealthVault service corresponding to the specified categories.

GetServiceDefinition(HealthServiceConnection, DateTime) GetServiceDefinition(HealthServiceConnection, DateTime) GetServiceDefinition(HealthServiceConnection, DateTime)

Gets information about the HealthVault service only if it has been updated since the specified update time.

GetServiceDefinition(HealthServiceConnection, ServiceInfoSections, DateTime) GetServiceDefinition(HealthServiceConnection, ServiceInfoSections, DateTime) GetServiceDefinition(HealthServiceConnection, ServiceInfoSections, DateTime)

Gets information about the HealthVault service corresponding to the specified categories if the requested information has been updated since the specified update time.

GetServiceDefinition(HealthServiceConnection) GetServiceDefinition(HealthServiceConnection) GetServiceDefinition(HealthServiceConnection)

Gets information about the HealthVault service.

public virtual Microsoft.Health.ServiceInfo GetServiceDefinition (Microsoft.Health.HealthServiceConnection connection);
abstract member GetServiceDefinition : Microsoft.Health.HealthServiceConnection -> Microsoft.Health.ServiceInfo
override this.GetServiceDefinition : Microsoft.Health.HealthServiceConnection -> Microsoft.Health.ServiceInfo
Public Overridable Function GetServiceDefinition (connection As HealthServiceConnection) As ServiceInfo

Parameters

connection
HealthServiceConnection HealthServiceConnection HealthServiceConnection

The connection to use to perform the operation.

Returns

A ServiceInfo instance that contains the service version, SDK assemblies versions and URLs, method information, and so on.

Exceptions

The HealthVault service returned an error.

One or more URL strings returned by HealthVault is invalid.

Remarks

Gets the latest information about the HealthVault service. This includes:

  • The version of the service.
  • The SDK assembly URLs.
  • The SDK assembly versions.
  • The SDK documentation URL.
  • The URL to the HealthVault Shell.
  • The schema definition for the HealthVault method's request and response.
  • The common schema definitions for types that the HealthVault methods use.
  • Information about all available HealthVault instances.

GetServiceDefinition(HealthServiceConnection, ServiceInfoSections) GetServiceDefinition(HealthServiceConnection, ServiceInfoSections) GetServiceDefinition(HealthServiceConnection, ServiceInfoSections)

Gets information about the HealthVault service corresponding to the specified categories.

public virtual Microsoft.Health.ServiceInfo GetServiceDefinition (Microsoft.Health.HealthServiceConnection connection, Microsoft.Health.ServiceInfoSections responseSections);
abstract member GetServiceDefinition : Microsoft.Health.HealthServiceConnection * Microsoft.Health.ServiceInfoSections -> Microsoft.Health.ServiceInfo
override this.GetServiceDefinition : Microsoft.Health.HealthServiceConnection * Microsoft.Health.ServiceInfoSections -> Microsoft.Health.ServiceInfo
Public Overridable Function GetServiceDefinition (connection As HealthServiceConnection, responseSections As ServiceInfoSections) As ServiceInfo

Parameters

connection
HealthServiceConnection HealthServiceConnection HealthServiceConnection

The connection to use to perform the operation.

responseSections
ServiceInfoSections ServiceInfoSections ServiceInfoSections

A bitmask of one or more ServiceInfoSections which specify the categories of information to be populated in the ServiceInfo.

Returns

A ServiceInfo instance that contains some or all of the service version, SDK assemblies versions and URLs, method information, and so on, depending on which information categories were specified.

Exceptions

The HealthVault service returned an error.

One or more URL strings returned by HealthVault is invalid.

Remarks

Gets the latest information about the HealthVault service. Depending on the specified responseSections, this will include some or all of:

  • The version of the service.
  • The SDK assembly URLs.
  • The SDK assembly versions.
  • The SDK documentation URL.
  • The URL to the HealthVault Shell.
  • The schema definition for the HealthVault method's request and response.
  • The common schema definitions for types that the HealthVault methods use.
  • Information about all available HealthVault instances.

Retrieving only the sections you need will give a faster response time than downloading the full response.

GetServiceDefinition(HealthServiceConnection, DateTime) GetServiceDefinition(HealthServiceConnection, DateTime) GetServiceDefinition(HealthServiceConnection, DateTime)

Gets information about the HealthVault service only if it has been updated since the specified update time.

public virtual Microsoft.Health.ServiceInfo GetServiceDefinition (Microsoft.Health.HealthServiceConnection connection, DateTime lastUpdatedTime);
abstract member GetServiceDefinition : Microsoft.Health.HealthServiceConnection * DateTime -> Microsoft.Health.ServiceInfo
override this.GetServiceDefinition : Microsoft.Health.HealthServiceConnection * DateTime -> Microsoft.Health.ServiceInfo
Public Overridable Function GetServiceDefinition (connection As HealthServiceConnection, lastUpdatedTime As DateTime) As ServiceInfo

Parameters

connection
HealthServiceConnection HealthServiceConnection HealthServiceConnection

The connection to use to perform the operation.

lastUpdatedTime
DateTime DateTime DateTime

The time of the last update to an existing cached copy of ServiceInfo.

Returns

If there were updates to the service information since the specified lastUpdatedTime, a ServiceInfo instance that contains the service version, SDK assemblies versions and URLs, method information, and so on. Otherwise, if there were no updates, returns null.

Exceptions

The HealthVault service returned an error.

One or more URL strings returned by HealthVault is invalid.

Remarks

Gets the latest information about the HealthVault service, if there were updates since the specified lastUpdatedTime. If there were no updates the method returns null. This includes:

  • The version of the service.
  • The SDK assembly URLs.
  • The SDK assembly versions.
  • The SDK documentation URL.
  • The URL to the HealthVault Shell.
  • The schema definition for the HealthVault method's request and response.
  • The common schema definitions for types that the HealthVault methods use.
  • Information about all available HealthVault instances.

GetServiceDefinition(HealthServiceConnection, ServiceInfoSections, DateTime) GetServiceDefinition(HealthServiceConnection, ServiceInfoSections, DateTime) GetServiceDefinition(HealthServiceConnection, ServiceInfoSections, DateTime)

Gets information about the HealthVault service corresponding to the specified categories if the requested information has been updated since the specified update time.

public virtual Microsoft.Health.ServiceInfo GetServiceDefinition (Microsoft.Health.HealthServiceConnection connection, Microsoft.Health.ServiceInfoSections responseSections, DateTime lastUpdatedTime);
abstract member GetServiceDefinition : Microsoft.Health.HealthServiceConnection * Microsoft.Health.ServiceInfoSections * DateTime -> Microsoft.Health.ServiceInfo
override this.GetServiceDefinition : Microsoft.Health.HealthServiceConnection * Microsoft.Health.ServiceInfoSections * DateTime -> Microsoft.Health.ServiceInfo
Public Overridable Function GetServiceDefinition (connection As HealthServiceConnection, responseSections As ServiceInfoSections, lastUpdatedTime As DateTime) As ServiceInfo

Parameters

connection
HealthServiceConnection HealthServiceConnection HealthServiceConnection

The connection to use to perform the operation.

responseSections
ServiceInfoSections ServiceInfoSections ServiceInfoSections

A bitmask of one or more ServiceInfoSections which specify the categories of information to be populated in the ServiceInfo.

lastUpdatedTime
DateTime DateTime DateTime

The time of the last update to an existing cached copy of ServiceInfo.

Returns

If there were updates to the service information since the specified lastUpdatedTime, a ServiceInfo instance that contains some or all of the service version, SDK assemblies versions and URLs, method information, and so on, depending on which information categories were specified. Otherwise, if there were no updates, returns null.

Exceptions

The HealthVault service returned an error.

One or more URL strings returned by HealthVault is invalid.

Remarks

Gets the latest information about the HealthVault service, if there were updates since the specified lastUpdatedTime. If there were no updates the method returns null. Depending on the specified responseSections, this will include some or all of:

  • The version of the service.
  • The SDK assembly URLs.
  • The SDK assembly versions.
  • The SDK documentation URL.
  • The URL to the HealthVault Shell.
  • The schema definition for the HealthVault method's request and response.
  • The common schema definitions for types that the HealthVault methods use.
  • Information about all available HealthVault instances.

Retrieving only the sections you need will give a faster response time than downloading the full response.

Applies to