HealthServiceConnection.GetServiceDefinition HealthServiceConnection.GetServiceDefinition HealthServiceConnection.GetServiceDefinition Method

Definition

Overloads

GetServiceDefinition(ServiceInfoSections, DateTime) GetServiceDefinition(ServiceInfoSections, DateTime) GetServiceDefinition(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(DateTime) GetServiceDefinition(DateTime) GetServiceDefinition(DateTime)

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

GetServiceDefinition() GetServiceDefinition() GetServiceDefinition()

Gets information about the HealthVault service.

GetServiceDefinition(ServiceInfoSections) GetServiceDefinition(ServiceInfoSections) GetServiceDefinition(ServiceInfoSections)

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

GetServiceDefinition(ServiceInfoSections, DateTime) GetServiceDefinition(ServiceInfoSections, DateTime) GetServiceDefinition(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 Microsoft.Health.ServiceInfo GetServiceDefinition (Microsoft.Health.ServiceInfoSections responseSections, DateTime lastUpdatedTime);
member this.GetServiceDefinition : Microsoft.Health.ServiceInfoSections * DateTime -> Microsoft.Health.ServiceInfo
Public Function GetServiceDefinition (responseSections As ServiceInfoSections, lastUpdatedTime As DateTime) As ServiceInfo

Parameters

responseSections
ServiceInfoSections ServiceInfoSections ServiceInfoSections

The categories of information to be populated in the ServiceInfo instance, represented as the result of XOR'ing the desired categories.

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.

GetServiceDefinition(DateTime) GetServiceDefinition(DateTime) GetServiceDefinition(DateTime)

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

public Microsoft.Health.ServiceInfo GetServiceDefinition (DateTime lastUpdatedTime);
member this.GetServiceDefinition : DateTime -> Microsoft.Health.ServiceInfo
Public Function GetServiceDefinition (lastUpdatedTime As DateTime) As ServiceInfo

Parameters

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() GetServiceDefinition() GetServiceDefinition()

Gets information about the HealthVault service.

public Microsoft.Health.ServiceInfo GetServiceDefinition ();
member this.GetServiceDefinition : unit -> Microsoft.Health.ServiceInfo
Public Function GetServiceDefinition () As ServiceInfo

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(ServiceInfoSections) GetServiceDefinition(ServiceInfoSections) GetServiceDefinition(ServiceInfoSections)

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

public Microsoft.Health.ServiceInfo GetServiceDefinition (Microsoft.Health.ServiceInfoSections responseSections);
member this.GetServiceDefinition : Microsoft.Health.ServiceInfoSections -> Microsoft.Health.ServiceInfo
Public Function GetServiceDefinition (responseSections As ServiceInfoSections) As ServiceInfo

Parameters

responseSections
ServiceInfoSections ServiceInfoSections ServiceInfoSections

The categories of information to be populated in the ServiceInfo instance, represented as the result of XOR'ing the desired categories.

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.

Applies to