rubyhealthvault 0.0.1

data/lib/xsd/responses/response-getopenqueryinfo.xsd

@@ -0,0 +1,64 @@
+<?xml version="1.0"?>
+<schema
+   targetNamespace="urn:com.microsoft.wc.methods.response.GetOpenQueryInfo"
+   xmlns:wc-doq-response="urn:com.microsoft.wc.methods.response.GetOpenQueryInfo"
+   xmlns:wc-types="urn:com.microsoft.wc.types"
+   xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        RESPONSE-GETOPENQUERYINFO.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for GetOpenQueryInfo method response
+
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Defines the response to a GetOpenQueryInfo request.
+            </summary>
+
+            <remarks>
+                GetOpenQueryInfo is used to get information about a previously 
+                created query that was created using the SaveOpenQuery method.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+
+            <errors>
+                <error id="INVALID_OPENQUERY">
+                    If a query with the specified identifier does not exist,
+                    which includes expired open queries.                                                     
+                </error>
+                <error id="ACCESS_DENIED">
+                    If the authenticated application or the target person does
+                    not match with the corresponding properties of the saved
+                    query.
+                </error>
+            </errors>
+        </documentation>
+    </annotation>
+
+    <element name="info"
+             type="wc-types:OpenQueryInfo">
+        <annotation>
+            <documentation>
+                <summary>
+                    The information describing the saved OpenQuery.
+                </summary>
+
+                <remarks>
+                    This information is used to invoke an OpenQuery
+                    after it is saved.
+                </remarks>
+            </documentation>
+        </annotation>
+    </element>
+
+</schema>
+

data/lib/xsd/responses/response-getpeopleforrecord.xsd

@@ -0,0 +1,95 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.response.GetPeopleForRecord"
+    xmlns:wc-people-for-record-response=
+        "urn:com.microsoft.wc.methods.response.GetPeopleForRecord"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns:wc-record="urn:com.microsoft.wc.record"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        RESPONSE-GETPEOPLEFORRECORD.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for GetPeopleForRecord method 
+        response
+
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+
+    <import
+        namespace="urn:com.microsoft.wc.record"
+        schemaLocation="record.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Gets information about the people that have been authorized
+                to the record specified in the header or have been invited
+                to share the record.
+            </summary>
+            <remarks>
+                This method can only be called record custodians.
+            </remarks>
+        </documentation>
+    </annotation>
+
+    <!-- - - - - - - - - - - GetPeopleForRecord - - - - - - - - - -->
+
+
+
+    <element name="info">
+        <complexType>
+            <annotation>
+                <documentation>
+                    <summary>
+                        The element that contains the method
+                        specific response.
+                    </summary>
+                    <remarks>
+                        All responses contain the info element to return data
+                        that are specific to each method. If the method does not
+                        define an info element, the method does not expect any
+                        data for the response.
+                    </remarks>
+                </documentation>
+            </annotation>
+            <sequence>
+                <element name="active-person-authorization"
+                        type="wc-record:ActivePersonAuthorizationNoIds"
+                        minOccurs="1" maxOccurs="unbounded" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                List of persons that have authorizations to the record.
+                            </summary>
+                            <remarks>
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+
+                <element name="non-active-authorization"
+                        type="wc-record:NonActiveAuthorizationNoIds"
+                        minOccurs="0" maxOccurs="unbounded" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                List of persons that have not accepted their sharing invites to 
+                                the record.
+                            </summary>
+                            <remarks>
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>

data/lib/xsd/responses/response-getpersoninfo.xsd

@@ -0,0 +1,87 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.response.GetPersonInfo"
+    xmlns:wc-getpersoninfo-response=
+        "urn:com.microsoft.wc.methods.response.GetPersonInfo"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        RESPONSE-GETPERSONINFO.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for GetPersonInfo method response
+
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                The basic information about an authenticated person.
+            </summary>
+
+            <remarks>
+                GetPersonInfo is used to retrieve basic information about the
+                authenticated person, like, their name,
+                application specific settings for the person, the selected
+                record for the application, and the records that the person
+                has authorized the application to use. It can also, optionally,
+                get the groups the person is a member of.
+            </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>
+            </errors>            
+        </documentation>
+    </annotation>
+
+    <!-- GetPersonInfo - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+
+    <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="person-info" type="wc-types:PersonInfo" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Basic information about a person.
+                            </summary>
+
+                            <remarks>
+                                Basic information about a person including their
+                                name, application  specific settings, record 
+                                selected for use by the application, and other 
+                                records that are the person authorized the 
+                                application to use.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>

data/lib/xsd/responses/response-getservicedefinition.xsd

@@ -0,0 +1,515 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace=
+        "urn:com.microsoft.wc.methods.response.GetServiceDefinition"
+    xmlns:wc-getservicedefinition-response=
+        "urn:com.microsoft.wc.methods.response.GetServiceDefinition"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        METHOD-GETSERVICEDEFINITION.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for GetServiceDefinition method
+
+    -->
+
+    <import
+      namespace="urn:com.microsoft.wc.types"
+      schemaLocation="types.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Gets information about the Microsoft Health Service and
+                its related features.
+            </summary>
+
+            <remarks>
+                GetServiceDefinition gets information about the Microsoft
+                Health Service like its version, the schemas for its 
+                published methods, and pointers to the Microsoft Health
+                Shell and software development kit.
+                
+                It is recommended that instead of calling this method, that
+                you get the "servicedefinition.xml" file at the root of the 
+                HealthVault Platform application.  
+                For example: "http://platform.healthvault.com/platform/servicedefinition.xml".
+            </remarks>
+            <method-visibility>Public</method-visibility>
+        </documentation>
+    </annotation>
+
+
+    <!-- info - - - - - -  - - - - - - - - - - - - - - -->
+
+    <complexType name="ConfigurationEntry">
+        <annotation>
+            <documentation>
+                <summary>
+                    A configuration value that is important for developers
+                    to know about the Microsoft Health Service.
+                </summary>
+
+                <remarks>
+                    The Microsoft Health Service has some configuration that
+                    dictates the behavior of certain methods and data. For
+                    instance, GetThings will return only a certain number
+                    of full things in the response and give only thing keys
+                    for anything beyond that limit. The number of full things
+                    returned is defined by configuration and can be changed
+                    at any time to optimize the services ability to respond
+                    to applications. These configuration values are surfaced
+                    here so that application developers can make programmatic
+                    decisions based on these values if necessary.
+                </remarks>
+            </documentation>
+        </annotation>
+        <simpleContent>
+            <extension base="string">
+                <attribute name="key"
+                    type="string" use="required">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The name of the configuration value.
+                            </summary>
+                       </documentation>
+                    </annotation>
+                </attribute>
+            </extension>
+        </simpleContent>
+    </complexType>
+
+    <complexType name="Platform">
+        <annotation>
+            <documentation>
+                <summary>
+                    Information about the Microsoft Health Service.
+                </summary>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="url" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The URL to use to access the Microsoft 
+                            Health Service methods.
+                        </summary>
+
+                        <remarks>
+                            All Microsoft Health Service method requests
+                            must go through this URL.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="version" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The Microsoft Health Service version number.
+                        </summary>
+
+                        <remarks>
+                            This version number will follow the general
+                            .NET guidlines for versioning of assemblies:
+                            major.minor.build.revision. Changes to the
+                            major version number signify breaking changes.
+                            Changes to other parts of the version signify
+                            added or updates to functionality.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="configuration"
+                type="wc-getservicedefinition-response:ConfigurationEntry"
+                minOccurs="0"
+                maxOccurs="unbounded" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            Configuration values that are important for developers
+                            to know about the Microsoft Health Service.
+                        </summary>
+
+                        <remarks>
+                            The Microsoft Health Service has some configuration that
+                            dictates the behavior of certain methods and data. For
+                            instance, GetThings will return only a certain number
+                            of full things in the response and give only thing keys
+                            for anything beyond that limit. The number of full things
+                            returned is defined by configuration and can be changed
+                            at any time to optimize the services ability to respond
+                            to applications. These configuration values are surfaced
+                            here so that application developers can make programmatic
+                            decisions based on these values if necessary.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+        </sequence>
+    </complexType>
+
+
+    <complexType name="ShellRedirectToken">
+        <annotation>
+            <documentation>
+                <summary>
+                    A representation of the redirect information that can be
+                    supplied along with the Shell redirect url to access specific
+                    functionalities in the Shell.
+                </summary>
+            </documentation>
+        </annotation>        
+        <sequence>
+            <element name="token" type="string">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            A string token used to redirect to specific parts
+                            within the Shell, accessing specific functions.
+                        </summary>
+                    </documentation>
+                </annotation>
+            </element>
+            <element name="description" type="string">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            A localized text description of the Shell 
+                            functionality accessible by using the token.
+                        </summary>
+                    </documentation>
+                </annotation>
+            </element>
+            <element name="querystring-parameters" type="string">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            A comma seperated list of parameters that must
+                            be supplied in the query string in addition to 
+                            the redirect token.
+                        </summary>
+                    </documentation>
+                </annotation>
+            </element>
+        </sequence>
+    </complexType>
+    
+    <complexType name="Shell">
+        <annotation>
+            <documentation>
+                <summary>
+                    Information about the Microsoft Health Shell.
+                </summary>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="url" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The URL used to access the Microsoft Health Shell.
+                        </summary>
+                    </documentation>
+                </annotation>
+            </element>
+            <element name="redirect-url" type="string">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The URL used to redirect to specific functions within the Microsoft Health Shell.
+                        </summary>
+                    </documentation>
+                </annotation>               
+            </element>
+            <element name="redirect-token" 
+                type="wc-getservicedefinition-response:ShellRedirectToken" 
+                minOccurs="0" maxOccurs="unbounded">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The possible redirect tokens that can be supplied 
+                            in addition to the redirect url to route to specific 
+                            functionalities within the Shell.
+                        </summary>
+                    </documentation>
+                </annotation>
+            </element>
+
+        </sequence>
+    </complexType>
+
+    <complexType name="SDKAssembly">
+        <annotation>
+            <documentation>
+                <summary>
+                    Information about the .NET assembly that can be used to
+                    access the Microsoft Health Service.
+                </summary>
+
+                <remarks>
+                    The Microsoft Health Service can be accessed via XML
+                    web methods. Microsoft has also developed .NET assemblies
+                    for making it easier for developers using .NET to access
+                    the Microsoft Health Service. The following contains
+                    information about those assemblies.
+                </remarks>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="url" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The URL to the Microsoft Health Service .NET assembly
+                            for download.
+                        </summary>
+                    </documentation>
+                </annotation>
+            </element>
+
+            <element name="version" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The version number for the Microsoft Health Service
+                            .NET assembly.
+                        </summary>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="doc-url" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The URL to the documentation for the Microsoft
+                            Health Service .NET assembly.
+                        </summary>
+
+                        <remarks>
+                            The URL references online documentation for the
+                            Microsoft Health Service SDK.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+        </sequence>
+    </complexType>
+
+    <complexType name="XmlMethodVersion">
+        <annotation>
+            <documentation>
+                <summary>
+                    Information about a particular version of one of the
+                    Microsoft Health Service XML web-methods.
+                </summary>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="request-schema-url"
+                     type="string"
+                     minOccurs="0"
+                     maxOccurs="1" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The URL of the method request schema.
+                        </summary>
+
+                        <remarks>
+                            The URL points to an .xsd file defining the 
+                            schema for a request to this method.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="response-schema-url"
+                     type="string"
+                     minOccurs="0"
+                     maxOccurs="1" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The URL of the method response schema.
+                        </summary>
+
+                        <remarks>
+                            The URL points to an .xsd file defining the
+                            schema for a response from this method.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+        </sequence>
+        <attribute name="number" type="string" use="required">
+            <annotation>
+                <documentation>
+                    <summary>
+                        The version number of the method.
+                    </summary>
+
+                    <remarks>
+                        The version number for a Microsoft Health Service
+                        web-method is a sequencially increasing number starting
+                        at one. Breaking changes to a method will increment
+                        the version number for the method but old versions of
+                        a method are still available to handle requests. The
+                        method request must contain the appropriate method
+                        version number for the XML schema that it is sending.
+                    </remarks>
+                </documentation>
+            </annotation>
+        </attribute>
+
+    </complexType>
+
+    <complexType name="XmlMethod">
+        <annotation>
+            <documentation>
+                <summary>
+                    Information about a Microsoft Health Service web-method.
+                </summary>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="name" type="string" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The name of the Microsoft Health Service method.
+                        </summary>
+
+                        <remarks>
+                            The name is used in the XML request to define the
+                            method the request is calling.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+            <element name="version"
+                type="wc-getservicedefinition-response:XmlMethodVersion"
+                minOccurs="0"
+                maxOccurs="unbounded" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The set of available versions of the method.
+                        </summary>
+                    </documentation>
+                </annotation>
+            </element>
+
+
+        </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="platform"
+                         type="wc-getservicedefinition-response:Platform">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                 Information about the Microsoft Health Service.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+
+                <element name="shell"
+                         type="wc-getservicedefinition-response:Shell" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Information about the Microsoft Health Shell.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+
+                <element name="sdk-assembly"
+                         type="wc-getservicedefinition-response:SDKAssembly"
+                         minOccurs="1"
+                         maxOccurs="unbounded">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Information about the Microsoft Health Service
+                                .NET software development kit.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+
+                <element name="xml-method"
+                         type="wc-getservicedefinition-response:XmlMethod"
+                         minOccurs="1"
+                         maxOccurs="unbounded" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Information about the Microsoft Health Service
+                                web methods.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="common-schema"
+                         type="string"
+                         minOccurs="0"
+                         maxOccurs="unbounded" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                URLs to schemas referenced by the Microsoft 
+                                Health Service methods.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>