rubyhealthvault 0.0.1

data/lib/xsd/requests/method-setapplicationsettings.xsd

@@ -0,0 +1,166 @@
+<?xml version="1.0"?>
+<!-- Copyright (c) Microsoft Corporation. All rights reserved. -->
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.SetApplicationSettings"
+    xmlns:wc-setapplicationsettings=
+        "urn:com.microsoft.wc.methods.SetApplicationSettings"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+  <!--
+
+        METHOD-SETAPPLICATIONSETTINGS.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for SetApplicationSettings methods
+
+    -->
+
+<import
+  namespace="urn:com.microsoft.wc.types"
+  schemaLocation="types.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Sets the application specific settings for the person.
+            </summary>
+
+            <remarks>
+                An application can store person preferences and other
+                settings for the person in the Microsoft Health
+                Service. These settings are automatically returned
+                when GetPersonInfo is called but can also be retrieved
+                by calling GetApplicationSettings.<br/>
+                <br/>
+                If you are familiar with Windows development, this
+                would be analogus to HKEY_CURRENT_USER settings in
+                the Windows Registry.<br/>
+                <br/>
+                The Microsoft Health Service does not interpret this
+                data at all and only acts as storage for it on
+                behalf of the application.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+
+            <errors>
+                <error id="ACCESS_DENIED">
+                    If the authenticated person or the application does not
+                    have method-level access rights to the method.
+                </error>
+                <error id="INVALID_PERSON">
+                    If the person identifier in the request does not
+                    exist.
+                </error>
+                <error id="INVALID_APP">
+                    If the application identifier in the request does not
+                    exist.
+                </error>
+            </errors>
+        </documentation>
+    </annotation>
+
+    <!-- SetApplicationSettings - - - - - - - - - - - - - - - - - - - - - - - - -->
+
+  <complexType name="AppSettings">
+      <annotation>
+          <documentation>
+              <summary>
+                  The application specific settings for the person.
+              </summary>
+
+              <remarks>
+                  An application can store person preferences and other
+                  settings for the person in the Microsoft Health
+                  Service. These settings are automatically returned
+                  when GetPersonInfo is called but can also be retrieved
+                  through the use of GetApplicationSettings.<br/>
+                  <br/>
+                  If you are familiar with Windows development, this
+                  would be analogus to HKEY_CURRENT_USER settings in
+                  the Windows Registry.<br/>
+                  <br/>
+                  The Microsoft Health Service does not interpret this
+                  data at all and only acts as storage for it on
+                  behalf of the application.
+              </remarks>
+
+          </documentation>
+      </annotation>
+      <sequence>
+          <any minOccurs="0" maxOccurs="unbounded"
+                    namespace="##any" processContents="skip">
+              <annotation>
+                  <documentation>
+                      <summary>
+                          The application settings in XML form.
+                      </summary>
+
+                      <remarks>
+                          An application can put any data in this portion of
+                          settings. The Microsoft Health Service does not
+                          interpret this data in any way and will return it
+                          to the application exactly as it was stored. The
+                          Microsoft Health Service does validate that the
+                          containing node is valid XML so some characters
+                          may need to be escaped or encoded.
+                      </remarks>
+                  </documentation>
+              </annotation>
+          </any>
+      </sequence>
+  </complexType>
+  
+  <element name="info">
+    <complexType>
+        <annotation>
+            <documentation>
+                <summary>
+                    The element of the request that contains the method
+                    specific parameters.
+                </summary>
+
+                <remarks>
+                    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.
+                </remarks>
+            </documentation>
+        </annotation>
+        <sequence>
+          <element name="app-settings" type="wc-setapplicationsettings:AppSettings"
+            minOccurs="0" maxOccurs="1">
+              <annotation>
+                  <documentation>
+                      <summary>
+                          The application specific settings for the person.
+                      </summary>
+
+                      <remarks>
+                          An application can store person preferences and other
+                          settings for the person in the Microsoft Health
+                          Service. These settings are automatically returned
+                          when GetPersonInfo is called but can also be retrieved
+                          through the use of GetApplicationSettings.<br/>
+                          <br/>
+                          If you are familiar with Windows development, this
+                          would be analogus to HKEY_CURRENT_USER settings in
+                          the Windows Registry.<br/>
+                          <br/>
+                          The Microsoft Health Service does not interpret this
+                          data at all and only acts as storage for it on
+                          behalf of the application. It does verify that this
+                          element is valid XML so it may be necessary to
+                          escape or encode any text that is placed in this
+                          node if it is not intended to be XML.
+                      </remarks>
+                  </documentation>
+              </annotation>
+          </element>
+
+      </sequence>
+    </complexType>
+  </element>
+
+</schema>

data/lib/xsd/requests/method-updateapplication.xsd

@@ -0,0 +1,357 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.UpdateApplication"
+    xmlns:wc-updateapplication="urn:com.microsoft.wc.methods.UpdateApplication"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns:wc-auth="urn:com.microsoft.wc.auth" 
+    xmlns:wc-app="urn:com.microsoft.wc.application"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        METHOD-UPDATEAPPLICATION.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for UpdateApplication method
+
+    -->
+
+    <import namespace="urn:com.microsoft.wc.types" schemaLocation="types.xsd" />
+    <import namespace="urn:com.microsoft.wc.auth" schemaLocation="auth.xsd" />
+    <import namespace="urn:com.microsoft.wc.application" schemaLocation="application.xsd" />
+    
+    <annotation>
+        <documentation>
+            <summary>
+                Updates an application configuration.
+            </summary>
+            <method-visibility>Public</method-visibility>
+            <errors>
+                <error id="ACCESS_DENIED">
+                    If the calling application doesn't have permission to update applications, or
+                    to update the application with the passed in id.
+                </error>
+                <error id="INVALID_APP">
+                    If the application id specified cannot be found.
+                </error>
+                <error id="INVALID_PUBLIC_KEY">
+                    If the provided public key hexadecimal string cannot be converted to a
+                    X509 Certificate.
+                </error>
+                <error id="INVALID_XML">
+                    If the action-url parameter and at least one of the privacy-statement and
+                    terms-of-use parameters are not provided.
+                </error>
+                <error id="INVALID_APPAUTH">
+                    If either the online or offline base authorization is a super set of the
+                    calling application's online or offline base authorization.
+                </error>
+            </errors>
+        </documentation>
+    </annotation>
+
+    <!-- UpdateApplication - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+    <element name="info">
+        <complexType>
+            <annotation>
+                <documentation>
+                    <summary>
+                        The element of the response that contains the method
+                        specific return value(s).
+                    </summary>
+
+                    <remarks>
+                        All response schemas contain the info element which
+                        contain the return value of the method. If the method
+                        does not define an info element, the method has no
+                        return value.
+                    </remarks>
+                </documentation>
+            </annotation>
+            <sequence>
+                <element name="id" type="wc-types:guid">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The id of the application to update.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+                <element name="name" type="wc-types:string255" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The application name.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="public-keys" type="wc-app:PublicKeys" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The X509 certificate to be used in conjunction with the
+                                application id to uniquely identify the application to HealthVault.
+                            </summary>
+
+                            <remarks>
+                                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.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="person-online-base-auth" type="wc-auth:AuthXml" 
+                         minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The list of data types (with corresponding permissions) that
+                                the application can access to while the person is logged in
+                                and using the application.
+                            </summary>
+
+                            <remarks>
+                                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.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+                
+                <element name="person-offline-base-auth" type="wc-auth:AuthXml" 
+                         minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The list of data types (with corresponding permissions) that
+                                the application can access at any time.
+                            </summary>
+
+                            <remarks>
+                                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.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="methods" type="wc-types:stringnz" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                List of HealthVault methods that the application is allowed to
+                                call.
+                            </summary>
+
+                            <remarks>
+                                Currently not supported. The application can only use the methods
+                                it was given access to when added.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="action-url" type="wc-types:stringnz" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                A single url used by HealthVault with different query string
+                                parameters to make specific requests to an online application.
+                            </summary>
+
+                            <remarks>
+                                Since an application must have both a privacy statement and a
+                                terms of use statement, the application configuration must have
+                                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.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="description" type="wc-types:stringnz" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                A high level description about what the application does.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="auth-reason" type="wc-types:stringnz" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The reason why the application requires the requested permissions
+                                to the various data types.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="domain-name" type="wc-types:string255" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The domain name from which emails sent on behalf of the
+                                application will originate from.
+                            </summary>
+
+                            <remarks>
+                                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.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="large-logo" type="wc-app:AppLargeLogoInfo" 
+                         minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The application's logo as a base64 encoded string and its
+                                corresponding content type.
+                            </summary>
+
+                            <remarks>
+                                The large logo can be up to 160kb in size.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="small-logo" type="wc-app:AppSmallLogoInfo" 
+                         minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The application's logo as a base64 encoded string and its
+                                corresponding content type.
+                            </summary>
+
+                            <remarks>
+                                The small logo can be up to 40kb in size.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="persistent-tokens" type="wc-app:AppPersistentTokens" 
+                         minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Specifies whether the application requires using persistent tokens
+                                and the duration to persist the tokens for (in seconds)
+                            </summary>
+                            
+                            <remarks>
+                                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.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="app-type" type="wc-types:stringnz" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The category used to classify the application.
+                            </summary>
+
+                            <remarks>
+                                Currently not used by HealthVault.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="privacy-statement" type="wc-app:StatementInfo" 
+                         minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The application's privacy statement as a base64 encoded string
+                                and its corresponding content type.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="terms-of-use" type="wc-app:StatementInfo" 
+                         minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The application's terms of use statement as a base64 encoded string
+                                and its corresponding content type.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="app-auth-required" type="boolean" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Specifies whether the application needs to authenticate the user.
+                            </summary>
+
+                            <remarks>
+                                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.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="is-published" type="boolean" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Currently not supported.
+                            </summary>
+
+                            <remarks>
+                                Currently not supported.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+                
+            </sequence>
+        </complexType>
+    </element>
+</schema>