rubyhealthvault 0.0.1

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

@@ -0,0 +1,216 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.CreateAuthenticatedSessionToken"
+    xmlns:wc-createauthenticatedsessiontoken="urn:com.microsoft.wc.methods.CreateAuthenticatedSessionToken"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns:wc-auth="urn:com.microsoft.wc.auth"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+    METHOD-CreateAuthenticatedSessionToken.XSD
+    Microsoft Wildcat
+
+    Platform API: Info schema for CreateAuthenticatedSessionToken method
+
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+    <import
+        namespace="urn:com.microsoft.wc.auth"
+        schemaLocation="auth.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Provides a way for clients to establish an authenticated
+                session with the Microsoft Health Service.
+            </summary>
+
+            <remarks>
+                Once the authenticated session is established, the client
+                may call web methods that is authorized to call.  
+                The authorization context depends upon the credential type and 
+                the subsequent authenticated session context.  Both
+                application and user authorization policies apply to what
+                clients may call.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+        </documentation>
+    </annotation>
+
+    <!-- this is a scoped down wc-types:Credential -->
+    <complexType name="Credential">
+        <annotation>
+            <documentation>
+                <summary>
+                    Credential in which the authenticated session
+                    will be in the context of.
+                </summary>
+
+                <remarks>
+                    The credential serves two purposes.  First,
+                    it must be verified as valid.  Once verified,
+                    the credential provides the authentication context
+                    for the session.
+                </remarks>
+            </documentation>
+        </annotation>
+        <choice>
+            <element name="cardspaceauthsession"
+                type="wc-types:CardSpaceCred">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            A CardSpace SAML token.
+                        </summary>
+
+                        <remarks>
+                            The SAMLE token is generated via CardSpace using
+                            GetToken.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+            <element name="appserver"
+                type="wc-types:AppServerCred">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            Web application server credential.
+                        </summary>
+
+                        <remarks>
+                            The credential is a signed request showing 
+                            proof-of-posession of the application-specific 
+                            private key.  This credential may be used to
+                            establish two modes of authentication. First,
+                            it may be used to create an trusted anonymous session
+                            in the context of the application.  Secondly,
+                            it may be used to create a trusted session in 
+                            the context of a specified user.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+            <!--- temporary type for auth-plus release -->
+            <element name="userpassauthsession"
+                type="wc-auth:UserPassAuthSessionCred">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            A credential consisting of username and password.
+                        </summary>
+
+                        <remarks>
+                            This is for test purposes only.
+                            Both the username and password are in plaintext.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+        </choice>
+    </complexType>
+
+    <!-- CreateAuthenticatedSessionToken - - - - - - - - - - - - - - - - - - - - - - - -->
+    <complexType name="AuthTokenInfo">
+        <annotation>
+            <documentation>
+                <summary>
+                    Parameters for creating an authenticated session token.
+                </summary>
+
+                <remarks>
+                    The caller must provide the application information as well
+                    as the user credential for which the session will be in 
+                    the context of.
+                </remarks>
+            </documentation>
+        </annotation>
+        <sequence>
+            <element name="app-id" 
+                type="wc-types:AppInfo"
+                minOccurs="1" maxOccurs="1">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            Application identifier for the authenticated session.
+                        </summary>
+
+                        <remarks>
+                            In order for a session to be created,
+                            the user must grant access to the application to 
+                            run in the context of the user.  If permission
+                            has not been granted, this will result in a
+                            access denied error.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+            <element name="credential"
+                type="wc-createauthenticatedsessiontoken:Credential">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            Credential in which the authenticated session
+                            will be in the context of.
+                        </summary>
+
+                        <remarks>
+                            The credential serves two purposes.  First,
+                            it must be verified as valid.  Once verified,
+                            the credential provides the authentication context
+                            for the session.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+        </sequence>
+    </complexType>
+
+    <element name="info">
+        <complexType>
+            <annotation>
+                <documentation>
+                    <summary>
+                        Creates an authenticated session token.
+                    </summary>
+
+                    <remarks>
+                        The authenticated session is in the context
+                        of the provided credential and the application.
+                    </remarks>
+                </documentation>
+            </annotation>
+            <sequence>
+                <element name="auth-info"
+                    type="wc-createauthenticatedsessiontoken:AuthTokenInfo">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Parameters for creating an authenticated session token.
+                            </summary>
+
+                            <remarks>
+                                The caller must provide the application information as well
+                                as the user credential for which the session will be in 
+                                the context of.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>
+
+

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

@@ -0,0 +1,143 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.CreateConnectRequest"
+    xmlns:wc-createconnectrequest="urn:com.microsoft.wc.methods.CreateConnectRequest"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        METHOD-CREATECONNECTREQUEST.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for CreateConnectRequest method
+
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Creates a connect request which will allow the user to tie their HealthVault 
+                account to the calling application once the user validates the connect request.
+            </summary>
+
+            <remarks>
+                The connect requests are validated when the HealthVault user correctly supplies the
+                identity code and is able to successfully answer the challenge question 
+                (via account.healthvault.com). Validated connect requests will be delivered once 
+                the corresponding external application calls GetAuthorizedConnectRequests.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+        </documentation>
+    </annotation>
+
+    <!-- CreateConnectRequest - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+
+    <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="friendly-name" type="wc-types:stringnz">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                A friendly name that will be presented to the user after the user
+                                successfully answers the challenge question. 
+                            </summary>
+                            
+                            <remarks>
+                                The friendly name should be something that is recognizable and
+                                distinguishes one connect request from another so that the user may
+                                choose the expected record during application authorization. For 
+                                example, a mother of 2 children may want to name her connect 
+                                requests after each child so she can distinguish one child's 
+                                connect request from the others.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+                <element name="question" type="wc-types:stringnz">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                A challenge question posed to the user once the identity code has 
+                                been successfully entered.
+                            </summary>
+                            
+                            <remarks>
+                                The challenge question should be personal and easy to answer for
+                                the user. It is recommended that the challenge question require a
+                                one word answer. An empty question will result in an
+                                InvalidVerificationQuestion error.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+                <element name="answer" type="wc-types:stringnz">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The answer that the patient is expected to provide when posed with 
+                                the challenge question.
+                            </summary>
+                            
+                            <remarks>
+                                It is recommended that this be a single word. The answer is
+                                case-insensitive, however, it is whitespace sensitive. An empty
+                                answer will result in an InvalidVerificationAnswer error.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+                <element name="external-id" type="wc-types:stringnz">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                An identifier supplied by the external application for the 
+                                connect request.
+                            </summary>
+                            
+                            <remarks>
+                                This value will tie the external application to the HealthVault
+                                record being shared. For instance, this could be the patient 
+                                identifier used to store information in the calling application's 
+                                database.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+                <element name="call-back-url" type="wc-types:stringnz" minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                A URL for call back once the connect request is validated.
+                            </summary>
+
+                            <remarks>
+                                Currently not supported.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+            </sequence>
+        </complexType>
+    </element>
+</schema>

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

@@ -0,0 +1,75 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.DeleteOpenQuery"
+    xmlns:wc-doq="urn:com.microsoft.wc.methods.DeleteOpenQuery"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        METHOD-DELETEOPENQUERY.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for DeleteOpenQuery method
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Deletes a saved open query given the query identifier.
+            </summary>
+
+            <remarks>
+                Deletes a previously created query using the SaveOpenQuery
+                method. Expired open queries no longer exists in the 
+                system, and don't need an explicit call to DeleteOpenQuery 
+                to remove them.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+        </documentation>
+    </annotation>
+
+    <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="query-id" type="wc-types:guid" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The identifier of the saved query that is to be deleted.
+                        </summary>
+
+                        <remarks>
+                            When a query is saved by the SaveOpenQuery method
+                            a unique identifier is issued by the Microsoft
+                            Health Services. This identifier is used to delete
+                            the saved query by calling the DeleteOpenQuery method.
+                        </remarks>
+                    </documentation>
+                </annotation>
+                </element>
+
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>

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

@@ -0,0 +1,77 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.DeletePendingConnectRequest"
+    xmlns:wc-deletependingconnectrequest="urn:com.microsoft.wc.methods.DeletePendingConnectRequest"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        METHOD-DELETEPENDINGCONNECTREQUEST.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for DeletePendingConnectRequest method
+
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Deletes the pending connect request for the supplied external id. 
+            </summary>
+            
+            <remarks>
+                This method should be used if the user loses the identity code, or is afraid it has
+                been compromised. The connect request will deleted only if it has not been 
+                authorized.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+            <errors>
+                <error id="ACCESS_DENIED">
+                    If the calling application does not have method-level access rights to 
+                    the method.
+                </error>
+            </errors>
+        </documentation>
+    </annotation>
+    
+    <!-- DeletePendingConnectRequest - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+    
+    <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="external-id" type="wc-types:stringnz">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Specifies the external id for which the associated pending
+                                connect request is removed.
+                            </summary>
+                            <remarks>
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+            </sequence>
+        </complexType>
+    </element>
+</schema>