List of all methods
These are the XML methods that HealthVault currently exposes.
These are the supporting XML schemas for types used in the methods above.
Service Definition Details
Service definition for HealthVault, using the latest GetServiceDefinition method.
<wc:info xmlns:wc="urn:com.microsoft.wc.methods.response.GetServiceDefinition2">
<platform>
<url>https://platform.healthvault-ppe.com/platform/wildcat.ashx</url>
<version>1.9.1048.7710</version>
<configuration key="allowedDocumentExtensions">.avi,.bluebutton,.bmp,.ccd,.ccr,.cda,.doc,.docm,.docx,.eml,.gif,.jpg,.mp3,.one,.pdf,.png,.ppsm,.ppsx,.ppt,.pptm,.pptx,.pub,.rpmsg,.rtf,.scp,.tif,.tiff,.txt,.vsd,.wav,.wma,.wmv,.xls,.xlsb,.xlsm,.xlsx,.xltx,.xml,.xps</configuration>
<configuration key="autoReconcilableTypes">1e1ccbfc-a55d-4d91-8940-fa2fbf73c195,9c48a2b8-952c-4f5a-935d-f3292326bf54</configuration>
<configuration key="blobHashBlockSizeBytes">2097152</configuration>
<configuration key="blobHashDefaultAlgorithm">SHA256Block</configuration>
<configuration key="blobStreamWriteTokenTtlMs">172800000</configuration>
<configuration key="defaultCulture">en</configuration>
<configuration key="defaultPersonInfosPerRetrieval">200</configuration>
<configuration key="emailValidationExp">^([\w-+\.]+)@((\[[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.)|(([\w-]+\.)+))([a-zA-Z]{2,8}|[0-9]{1,3})(\]?)$</configuration>
<configuration key="liveIdAuthPolicy">HBI</configuration>
<configuration key="liveIdEnvironment">PROD</configuration>
<configuration key="liveIdSiteName">account.healthvault.com</configuration>
<configuration key="maxAlternateIdsPerRecord">100</configuration>
<configuration key="maxBlobChunkSizeBytes">4194304</configuration>
<configuration key="maxBlobSizeBytes">1073741824</configuration>
<configuration key="maxCredentials">5</configuration>
<configuration key="maxFullThingResultsPerGroup">240</configuration>
<configuration key="maxGetThingsQueryGroups">120</configuration>
<configuration key="maxInitialRecords">25</configuration>
<configuration key="maxInlineBlobSizeBytes">5242880</configuration>
<configuration key="maxPartialThingResultsPerGroup">30000</configuration>
<configuration key="maxPersonInfosPerRetrieval">1000</configuration>
<configuration key="maxRequestUncompressedSizeBytes">13631488</configuration>
<configuration key="maxResultsPerVocabularyRetrieval">500</configuration>
<configuration key="maxVocabularyItems">500</configuration>
<configuration key="passwordValidationExp">^.*(?=.{8,})(?=.*\D)(?=.*\d).*$</configuration>
<configuration key="platformUrl">https://platform.healthvault-ppe.com/platform/wildcat.ashx</configuration>
</platform>
<shell>
<url>https://account.healthvault-ppe.com/</url>
<redirect-url>https://account.healthvault-ppe.com/redirect.aspx</redirect-url>
<redirect-token>
<token>APPAUTH</token>
<description>Redirects to the Shell application authorization page. On successful authentication and verification of authorization the Shell will redirect to the application action URL with the target set to AppAuthSuccess. If authorization is declined by the user, then the Shell will redirect to the application action URL with the target set to AppAuthRejected.</description>
<querystring-parameters>appid,actionqs</querystring-parameters>
</redirect-token>
<redirect-token>
<token>APPSIGNOUT</token>
<description>Redirects to Shell page for signing out a user from the Shell, after the user has been signed out from the application. On successful signout the Shell will redirect to the application action URL with the target set to SignOut.</description>
<querystring-parameters>appid,actionqs</querystring-parameters>
</redirect-token>
<redirect-token>
<token>AUTH</token>
<description>Redirects to the Shell authentication page. On successful authentication and verification of authorization the Shell will redirect to the application action URL with the target set to AppAuthSuccess. If authorization is declined by the user, then the Shell will redirect to the application action URL with the target set to AppAuthRejected.</description>
<querystring-parameters>appid,actionqs</querystring-parameters>
</redirect-token>
<redirect-token>
<token>SHARERECORD</token>
<description>Redirects to the Shell page to initiate sharing a record with a person. The record identifier must be passed as the "extrecordid" query string parameter. If the sharing is successful, then the Shell will redirect to the application action URL with the target set to ShareRecordSuccess. If the sharing is unsuccessful, then the Shell will redirect to the application action URL with the target set to ShareRecordFailed.</description>
<querystring-parameters>extrecordid,actionqs,appid</querystring-parameters>
</redirect-token>
<redirect-token>
<token>VERIFYLIVEID</token>
<description>Redirects to the Shell page for verifying a Windows Live ID ticket. The ticket must be base64 encoded and passed in the "LiveIdTicket" header. A shared secret must also be passed in the "SharedSecret" header. The application identifier must be passed as the "appid" query string parameter.</description>
<querystring-parameters>appid</querystring-parameters>
</redirect-token>
</shell>
<xml-method>
<name>AddApplication</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-addapplication.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-addapplication.xsd</response-schema-url>
</version>
<version number="2">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-addapplication.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-addapplication.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>AllocatePackageId</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-allocatepackageid.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>AssociateAlternateId</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-associatealternateid.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>BeginPutBlob</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-beginputblob.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>BeginPutConnectPackageBlob</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>CreateAuthenticatedSessionToken</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-createauthenticatedsessiontoken.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-createauthenticatedsessiontoken.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>CreateConnectPackage</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-createconnectpackage.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-createconnectpackage.xsd</response-schema-url>
</version>
<version number="2">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-createconnectpackage2.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-createconnectpackage.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>CreateConnectRequest</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-createconnectrequest.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-createconnectrequest.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>DeleteOpenQuery</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-deleteopenquery.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-deleteopenquery.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>DeletePendingConnectPackage</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-deletependingconnectpackage.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>DeletePendingConnectRequest</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-deletependingconnectrequest.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>DisassociateAlternateId</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-disassociatealternateid.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetAlternateIds</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getalternateids.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getalternateids.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetApplicationInfo</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getapplicationinfo.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getapplicationinfo.xsd</response-schema-url>
</version>
<version number="2">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getapplicationinfo.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getapplicationinfo.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetApplicationSettings</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getapplicationsettings.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetAuthorizedConnectRequests</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getauthorizedconnectrequests.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getauthorizedconnectrequests.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetAuthorizedPeople</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getauthorizedpeople.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getauthorizedpeople.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetAuthorizedRecords</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getauthorizedrecords.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getauthorizedrecords.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetEventSubscriptions</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-geteventsubscriptions.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetOpenQueryInfo</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getopenqueryinfo.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getopenqueryinfo.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetPeopleForRecord</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getpeopleforrecord.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetPersonAndRecordForAlternateId</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getpersonandrecordforalternateid.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getpersonandrecordforalternateid.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetPersonInfo</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getpersoninfo.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getpersoninfo.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetServiceDefinition</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getservicedefinition.xsd</response-schema-url>
</version>
<version number="2">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getservicedefinition2.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetThings</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getthings.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getthings.xsd</response-schema-url>
</version>
<version number="2">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getthings.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getthings.xsd</response-schema-url>
</version>
<version number="3">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getthings3.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getthings3.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetThingType</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getthingtype.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getthingtype.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetUpdatedRecordsForApplication</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getupdatedrecordsforapplication.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getupdatedrecordsforapplication.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetValidGroupMembership</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getvalidgroupmembership.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getvalidgroupmembership.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>GetVocabulary</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getvocabulary.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getvocabulary.xsd</response-schema-url>
</version>
<version number="2">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-getvocabulary.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-getvocabulary.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>NewApplicationCreationInfo</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-newapplicationcreationinfo.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>NewSignupCode</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-newsignupcode.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>OverwriteThings</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-overwritethings.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-overwritethings.xsd</response-schema-url>
</version>
<version number="2">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-overwritethings2.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-overwritethings.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>PutThings</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-putthings.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-putthings.xsd</response-schema-url>
</version>
<version number="2">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-putthings2.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-putthings.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>QueryPermissions</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-querypermissions.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-querypermissions.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>RemoveApplicationRecordAuthorization</name>
<version number="1">
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>RemoveThings</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-removethings.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>SaveOpenQuery</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-saveopenquery.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-saveopenquery.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>SearchVocabulary</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-searchvocabulary.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-searchvocabulary.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>SendInsecureMessage</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-sendinsecuremessage.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>SendInsecureMessageFromApplication</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-sendinsecuremessagefromapplication.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>SetApplicationSettings</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-setapplicationsettings.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>SubscribeToEvent</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-subscribetoevent.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-subscribetoevent.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>UnsubscribeToEvent</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-unsubscribetoevent.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>UpdateApplication</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-updateapplication.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
<version number="2">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-updateapplication.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>UpdateEventSubscription</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-updateeventsubscription.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<xml-method>
<name>UpdateExternalId</name>
<version number="1">
<request-schema-url>https://platform.healthvault-ppe.com/platform/XSD/method-updateexternalid.xsd</request-schema-url>
<response-schema-url>https://platform.healthvault-ppe.com/platform/XSD/response-any.xsd</response-schema-url>
</version>
</xml-method>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/types.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/auth.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/application.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/vocab.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/thing.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/subscription.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/record.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/method-getthings.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/request.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/dates.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/directory.xsd</common-schema>
<common-schema>https://platform.healthvault-ppe.com/platform/XSD/notification.xsd</common-schema>
</wc:info>