rubyhealthvault 0.0.1

data/lib/xsd/common/vocab.xsd

@@ -0,0 +1,359 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.vocab"
+    xmlns:wc-vocab="urn:com.microsoft.wc.vocab"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        VOCAB.XSD
+        Microsoft Wildcat
+
+        Platform API: Shared vocab types 
+
+    -->
+
+    <import namespace="urn:com.microsoft.wc.types" schemaLocation="types.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Defines common types for interfacing with vocabularies in the system.
+            </summary>
+
+            <remarks>
+
+            </remarks>
+        </documentation>
+    </annotation>
+
+    <complexType name="VocabularyKey">
+        <annotation>
+            <documentation>
+                <summary>
+                    Used to uniquely identify a specific vocabulary in the system.
+                </summary>
+
+                <remarks>
+                    Information about supported vocabularies can be obtained though 
+                    the partner labs site.
+                </remarks>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="name" type="wc-types:stringnz">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The name of the vocabulary being referenced.
+                        </summary>
+
+                        <remarks>
+                        
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+            <element name="family" type="wc-types:stringnz"
+                     minOccurs="0" maxOccurs="1">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The family to which the vocabulary being referenced belongs.
+                        </summary>
+
+                        <remarks>
+                            Vocabularies can be defined by HealthVault or by a number 
+                            of standards organizations such as the ISO. The family 
+                            parameter specfies this source.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+            <element name="version" type="wc-types:stringnz"
+                     minOccurs="0" maxOccurs="1">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The version of the vocabulary being referenced.
+                        </summary>
+
+                        <remarks>
+                            A string used to identify a particular version of a 
+                            vocabulary.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+            <element name="code-value" type ="string" minOccurs="0" maxOccurs="1">
+                <annotation>
+                    <documentation>
+                        <summary>
+
+                        </summary>
+
+                        <remarks>
+                            If the code-value is specified, all vocabulary code items starting with
+                            the one which has the specified code value are returned.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+        </sequence>
+    </complexType>
+
+    <complexType name="VocabularyKeyInfo">
+        <annotation>
+            <documentation>
+                <summary>
+                    Summary information about a vocabulary in the system.
+                </summary>
+
+                <remarks>
+                    This information is made up of the key and a description
+                    of the vocabulary. The key is made up of the name, family, 
+                    and version.
+                </remarks>
+            </documentation>
+        </annotation>
+        <complexContent>
+            <extension base="wc-vocab:VocabularyKey">                
+                <sequence>
+                    <element name="description"
+                             type ="string" minOccurs="0" maxOccurs="1" >
+                        <annotation>
+                            <documentation>
+                                <summary>
+                                    This is a description of the vocabulary being returned.
+                                </summary>
+
+                                <remarks>
+                                    This is a text description of the vocabulary returned by
+                                    the system as a part of vocabulary key information.
+                                </remarks>
+                            </documentation>
+                        </annotation>
+                    </element>
+
+
+                </sequence>
+            </extension>
+        </complexContent>
+    </complexType>
+
+    <complexType name="VocabularyCodeSet">
+        <annotation>
+            <documentation>
+                <summary>
+                    Contains information about a vocabulary along with items
+                    belonging to that vocabulary.
+                </summary>
+
+                <remarks>
+
+                </remarks>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="name" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The name of the referenced vocabulary.
+                        </summary>
+
+                        <remarks>
+
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="family" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The family the referenced vocabulary belongs to.
+                        </summary>
+
+                        <remarks>
+
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="version" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The version of the referenced vocabulary.
+                        </summary>
+
+                        <remarks>
+
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="code-item"
+                     type="wc-vocab:VocabularyCodeItem"
+                     minOccurs="0" maxOccurs="unbounded" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            A list of vocabulary items belonging to a vocabulary.
+                        </summary>
+
+                        <remarks>                            
+                            This is the full list of items in the vocabulary for a GetVocabulary 
+                            call, and a list of matching items for a SearchVocabulary call.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+            <element name="is-vocab-truncated"
+                     type="boolean" minOccurs="0" maxOccurs="1" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            Indicates if list of vocabulary items in the vocabulary has been
+                            truncated.
+                        </summary>
+
+                        <remarks>
+                            HealthVault only returns a maximum number of vocabulary items indicated
+                            by the configuration.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+        </sequence>
+
+    </complexType>
+
+
+    <complexType name="VocabularyCodeItem">
+        <annotation>
+            <documentation>
+                <summary>
+                    Describes an indivdual code item.
+                </summary>
+
+                <remarks>
+                    A code item is a unit member of a vocabulary.
+                </remarks>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="code-value" type="string">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            This is the value associated with the item which uniquely
+                            identifies it within a vocabulary.
+                        </summary>
+
+                        <remarks>
+
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="display-text" type="string"
+                     minOccurs ="0" maxOccurs="1">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            This is the display text of the item.
+                        </summary>
+
+                        <remarks>
+
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="abbreviation-text" type="string"
+                     minOccurs ="0" maxOccurs="1">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            This is the abbreviation text of an item.
+                        </summary>
+
+                        <remarks>
+
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="info-xml" type="wc-vocab:InfoXml"
+                     minOccurs="0" maxOccurs="1">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            Contains important auxillary information that can be used
+                            for operations such as unit conversions.
+                        </summary>
+
+                        <remarks>
+
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+        </sequence>
+    </complexType>
+
+    <complexType name="InfoXml">
+        <annotation>
+            <documentation>
+                <summary>
+                    Contains important auxillary information that can be used
+                    for operations such as unit conversions.
+                </summary>
+
+                <remarks>
+
+                </remarks>
+            </documentation>
+        </annotation>
+        <sequence>
+            <any namespace="##any" processContents="skip">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            Code item specific blob that contains auxillary information about
+                            the code item.
+                        </summary>
+
+                        <remarks>
+                            This can be for instance, information on how to convert a 
+                            value from one measurement unit to another, or nutritional
+                            information of a food item.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </any>
+        </sequence>
+    </complexType>
+</schema>

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

@@ -0,0 +1,349 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.AddApplication"
+    xmlns:wc-addapplication="urn:com.microsoft.wc.methods.AddApplication"
+    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-ADDAPPLICATION.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for AddApplication 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>
+                Adds an application configuration.
+            </summary>
+
+            <remarks>
+                Before an application can call HealthVault, two things must happen:
+                    1. The application configuration must be added to HealthVault.
+                    2. A user must allow the application to access his/her health data.
+
+                The application configuration specifies how the application will interact with
+                HealthVault (i.e. which methods it will call, which data types it needs access
+                to, etc.). It also provides information specificially for the user (i.e. a 
+                description about what the application does, the application logo, etc.). This
+                information will be shown to the user during application authorization.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+        </documentation>
+    </annotation>
+
+    <!-- AddApplication - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+    <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="name" type="wc-types:string255">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The application name.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="public-keys" type="wc-app:PublicKeys">
+                    <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">
+                    <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. Instead, each application is given access
+                                to the following default list of methods:
+                                
+                                - CreateAuthenticatedSessionToken
+                                - GetApplicationSettings
+                                - GetAuthorizedRecords
+                                - GetPersonInfo
+                                - GetServiceDefinition
+                                - GetThings
+                                - GetThingType
+                                - GetVocabulary
+                                - PutThings
+                                - QueryPermissions
+                                - RemoveThings
+                                - SetApplicationSettings
+                            </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, 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.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="description" type="wc-types:stringnz">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                A high level description about what the application does.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="auth-reason" type="wc-types:stringnz">
+                    <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">
+                    <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>