The element of the request that contains the method specific parameters.
The sequence of elements that make up the type.
| Name | Type | Min Occurs | Max Occurs | Summary | Remarks |
|---|---|---|---|---|---|
| name | urn:com.microsoft.wc.types:CultureSpecificString255 | 1 | unbounded | The application name. | |
| public-keys | urn:com.microsoft.wc.application:PublicKeys | The X509 certificate to be used in conjunction with the application id to uniquely identify the application to HealthVault. | This value should be the hexadecimal representation of the entire X509 certificate, excluding the private key. The easiest way to get this value is to take the binary value of a .cer file as a hexadecimal. It is extremely important that the private key that cooresponds to this public key should be secured both physically and electronically so that other applications cannot identify themselves the application being added. | ||
| person-online-base-auth | urn:com.microsoft.wc.auth:AuthXml | 0 | 1 | The list of data types (with corresponding permissions) that the application can access to while the person is logged in and using the application. | This set of authorization rules must be a subset of the calling application's authorization rule set. If not, an INVALID_APPAUTH error will be returned. |
| person-offline-base-auth | urn:com.microsoft.wc.auth:AuthXml | The list of data types (with corresponding permissions) that the application can access at any time. | This set of authorization rules must be a subset of the calling application's authorization rule set. If not, an INVALID_APPAUTH error will be returned. | ||
| methods | urn:com.microsoft.wc.types:stringnz | 0 | 1 | List of HealthVault methods that the application is allowed to call. | Version 1 of the AddApplication ignores this element and configures the application with x-BaseMethods and x-UserDataExtended method groups. Version 2 of the AddApplication ensures the methods specified are equal to or a subset of the child-method-mask-ceiling configured for the master application. |
| action-url | urn:com.microsoft.wc.types:stringnz | 0 | 1 | A single url used by HealthVault with different query string parameters to make specific requests to an online application. | Since an application must have both a privacy statement and a terms of use statement, you must supply one of the following: 1. An action url. 2. Both the privacy statement and terms of use (see the "privacy-statement" and "terms-of-use" parameters). If the above condition is not met, an INVALID_XML error will be returned. Exceptions include HIPAA applications specified using the app-attributes element below. HIPAA applications do not require an action url, privacy statement, or terms of use. |
| description | urn:com.microsoft.wc.types:CultureSpecificStringnz | 1 | unbounded | A high level description about what the application does. | |
| auth-reason | urn:com.microsoft.wc.types:CultureSpecificStringnz | 1 | unbounded | The reason why the application requires the requested permissions to the various data types. | |
| domain-name | urn:com.microsoft.wc.types:string255 | 0 | 1 | The domain name from which emails sent on behalf of the application will originate from. | For example, if the domain name supplied was 'myapp.com', the application would call SendInsecureMessageFromApplication with a mailbox-name 'mailbox', and the recipient would receive an email from mailbox@myapp.com. Currently not supported. The list of methods that the application is given access to by default does not contain any of the methods for sending email. |
| large-logo | urn:com.microsoft.wc.application:AppLargeLogoInfo | The application's logo as a base64 encoded string and its corresponding content type. | The large logo can be up to 120 pixels wide, 60 pixels high, and 160kb in size. | ||
| small-logo | urn:com.microsoft.wc.application:AppSmallLogoInfo | 0 | 1 | The application's logo as a base64 encoded string and its corresponding content type. | The small logo can be up to 40kb in size. |
| persistent-tokens | urn:com.microsoft.wc.application:AppPersistentTokens | 0 | 1 | Specifies whether the application requires using persistent tokens and the duration to persist the tokens for (in seconds) | A persistent token is an encrypted identifier for the user and application. It can be used to enable the "Keep me signed in on this computer" feature in HealthVault. |
| app-type | urn:com.microsoft.wc.types:stringnz | 0 | 1 | The category used to classify the application. | Currently not used by HealthVault. |
| privacy-statement | urn:com.microsoft.wc.application:StatementInfo | 0 | 1 | The application's privacy statement as a base64 encoded string and its corresponding content type. | |
| terms-of-use | urn:com.microsoft.wc.application:StatementInfo | 0 | 1 | The application's terms of use statement as a base64 encoded string and its corresponding content type. | |
| app-auth-required | http://www.w3.org/2001/XMLSchema:boolean | 0 | 1 | Specifies whether the application needs to authenticate the user. | For example, if the application charged a subscription fee for its use, this parameter would need to be true so that the application can verify that the user has in fact paid for the usage before logging him/her in. Currently not supported. |
| is-published | http://www.w3.org/2001/XMLSchema:boolean | 0 | 1 | Currently not supported. | Currently not supported. |
| dtc-success-message | urn:com.microsoft.wc.application:StatementInfo | 0 | 1 | The message to display to the use when direct to clinial authorization completes successfully. | Represented as a base64 encoded string and its corresponding content type. |
| app-attributes | urn:com.microsoft.wc.application:ApplicationAttributes | 0 | 1 | The application attributes. | |
| valid-ip-prefixes | urn:com.microsoft.wc.types:string255nw | 0 | 1 | A comma separated list of IP address masks from which the application can call HealthVault. | HealthVault provides some added security to applications by supporting calls that come from valid IP addresses of the application. IP addresses can be specified using a specific IP address and 32 bit mask like 192.168.0.1/32 or by specifying a subnet and mask like 192.168.0.0/16. You can have more than one IP address or mask by comma separating them. |
All requests contain the info element to pass parameters that are specific to each method. If the method does not define an info element, the method does not take any parameters.