rubyhealthvault 0.0.1

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

@@ -0,0 +1,78 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.RemoveThings"
+    xmlns:wc-removethings="urn:com.microsoft.wc.methods.RemoveThings"
+    xmlns:wc-thing="urn:com.microsoft.wc.thing"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        METHOD-REMOVETHINGS.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for RemoveThings method
+
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+
+    <import
+        namespace="urn:com.microsoft.wc.thing"
+        schemaLocation="thing.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                This method deletes things from a record.
+            </summary>
+
+            <remarks>
+                Deletes a previously created thing from a record.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+        </documentation>
+    </annotation>
+
+    <!-- RemoveThings - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+
+    <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="thing-id" type="wc-thing:ThingKey"
+                minOccurs="1" maxOccurs="unbounded" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The list identifying the specific things to be deleted.
+                        </summary>
+
+                        <remarks>
+                            A thing-revision uniquely identifies a thing at 
+                            a specific point in thime
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>

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

@@ -0,0 +1,219 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.SaveOpenQuery"
+    xmlns:wc-soq="urn:com.microsoft.wc.methods.SaveOpenQuery"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns:wc-request="urn:com.microsoft.wc.request"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        METHOD-SAVEOPENQUERY.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for SaveOpenQuery method
+    -->
+
+    <import
+        namespace="urn:com.microsoft.wc.types"
+        schemaLocation="types.xsd" />
+
+    <import
+        namespace="urn:com.microsoft.wc.request"
+        schemaLocation="request.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                Saves an open query and returns the query identifier.
+            </summary>
+
+            <remarks>
+                An open query is a saved request that may be invoked given the
+                returned query identifier issued by Microsoft Health Services.
+                The saved query is invoked by calling the openquery.ashx HTTP
+                handler providing the query identifier, id, as the HTTP query
+                parameter.<br/>
+                For example,<br/>
+                https://&lt;server&gt;/wildcat/openquery.ashx?id=9C4C77CF-1DF0-4c41-BD3D-EC9232B5BC8A
+                will invoke a saved request that corresponds to the specified
+                identifier.<br/>
+                <br/>
+                Currently the only supported request method of a saved query
+                is GetThings. Attempting to save queries for other methods
+                will result in the INVALID_OPENQUERY error.<br/>
+                <br/>
+                Security warning: invocation of the saved queries does
+                not require authentication or authorization when the
+                openquery.ashx handler is called. Anyone that knows the
+                query identifier may successfully execute it and obtain
+                the results.
+            </remarks>
+            <method-visibility>Public</method-visibility>
+        </documentation>
+    </annotation>
+
+    <element name="info">
+        <complexType>
+            <annotation>
+                <documentation>
+                    <summary>
+                        The element of the request that contains the
+                        SaveOpenQuery 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="expires" type="int" 
+                    minOccurs="0" maxOccurs="1" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Optional. Time in minutes from open query
+                                creation until this open query expires.
+                                Expired open queries no longer exists in
+                                the system, and don't need an explicit 
+                                call to DeleteOpenQuery to remove them.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="pin-code" type="wc-types:string128" 
+                    minOccurs="0" maxOccurs="1" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Optional PIN to protect this open query from
+                                unauthorized access.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="note" type="wc-types:string128"
+                    minOccurs="0" maxOccurs="1" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Optional note attached to this open query.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <!-- method name -->
+                <element name="method" type="string" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The name of the method the open query will call.
+                            </summary>
+
+                            <remarks>
+                                Currently the only supported request method of a
+                                saved query is GetThings. Attempting to save
+                                queries for other methods will result in the
+                                INVALID_OPENQUERY error.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <!-- method version -->
+                <element name="method-version" type="int" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The version of the method the open query will call.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <!-- record id (if appropriate for method) -->
+                <element name="record-id" type="wc-types:guid"
+                    minOccurs="0" maxOccurs="1" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The unique identifier for the health record that
+                                the open query will run against.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <!-- optional culture info -->
+                <element name="language" type="wc-types:iso639-1"
+                    minOccurs="0" maxOccurs="1" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The language that will be used for any localizable
+                                strings or data when the open query is run.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+
+                <element name="country" type="wc-types:iso3166"
+                    minOccurs="0" maxOccurs="1" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The country that will be used for any localizable
+                                strings or data when open query is run.
+                            </summary>
+                        </documentation>
+                    </annotation>
+                </element>
+
+
+                <!-- optional xsl to transform FINAL result (request.xsd) -->
+                <element name="final-xsl" type="string"
+                    minOccurs="0" maxOccurs="1" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The XSL used for transforming the results.
+                            </summary>
+
+                            <remarks>
+                                If this parameter is specified the resulting XML
+                                will be transformed using this XSL to produce
+                                the final response that will be sent to the caller.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="info" type="wc-request:Info" >
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The request XML that will be sent to the
+                                Microsoft Health Service when the open query is run.
+                            </summary>
+
+                            <remarks>
+                                This XML is not modified by the SaveOpenQuery
+                                or method processor or the open query handler.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+            </sequence>
+        </complexType>
+    </element>
+
+</schema>

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

@@ -0,0 +1,222 @@
+<?xml version="1.0"?>
+<schema
+    targetNamespace="urn:com.microsoft.wc.methods.SearchVocabulary"
+    xmlns:wc-searchvocabulary="urn:com.microsoft.wc.methods.SearchVocabulary"
+    xmlns:wc-types="urn:com.microsoft.wc.types"
+    xmlns:wc-vocab="urn:com.microsoft.wc.vocab"
+    xmlns="http://www.w3.org/2001/XMLSchema" >
+
+    <!--
+
+        METHOD-SEARCHVOCABULARY.XSD
+        Microsoft Wildcat
+
+        Platform API: Info schema for searchvocabulary method
+
+    -->
+
+    <import namespace="urn:com.microsoft.wc.types" schemaLocation="types.xsd" />
+    <import namespace="urn:com.microsoft.wc.vocab" schemaLocation="vocab.xsd" />
+
+    <annotation>
+        <documentation>
+            <summary>
+                This method is used to search a vocabulary and retrieve the code items
+                that match a given search criteria.
+            </summary>
+
+            <remarks>
+
+            </remarks>
+
+            <errors>
+                <error id="INVALID_VOCABULARY">
+                    If the vocabulary specified by the vocabulary keys doesn't 
+                    exist on the system.
+                </error>
+
+                <error id="INVALID_XML">
+                    If the search mode isn't defined.
+                </error> 
+                
+            </errors>
+            
+            <method-visibility>Public</method-visibility>
+        </documentation>
+    </annotation>
+
+    <!-- SEARCHVOCABULARY - - - - - - - - - - - - - - - - - - - - - - - - -->
+
+    <complexType name="VocabularySearchParams">
+        <annotation>
+            <documentation>
+                <summary>
+                    Specifies the text search parameters for the vocabulary search
+                    request.
+                </summary>
+
+                <remarks>
+                    The text search parameters apply to the culture specifed
+                    in the request header by language and country. If the country
+                    is absent, items for the language are searched. If language
+                    is absent, items for the default culture of the system are
+                    searched.
+                </remarks>
+            </documentation>
+        </annotation>
+
+        <sequence>
+            <element name="search-string" type="wc-searchvocabulary:VocabularySearchString">
+                <annotation>
+                    <documentation>
+                        <summary>
+                            The vocabulary search string to use.
+                        </summary>
+
+                        <remarks>
+                            
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>            
+
+            <element name="max-results" type="positiveInteger" 
+                     minOccurs="0" maxOccurs="1" >
+                <annotation>
+                    <documentation>
+                        <summary>
+                            Specifies the maximum number of vocabularies or vocabulary items 
+                            to return that match the search criteria. 
+                        </summary>
+
+                        <remarks>
+                            If this element is absent, the number of returned results is
+                            limited to a system configuration value defined as
+                            "MaxResultsVocabularyRetrieval" which can be retrived through 
+                            GetServiceDefinition.
+                        </remarks>
+                    </documentation>
+                </annotation>
+            </element>
+
+        </sequence>
+        
+    </complexType>
+
+    <complexType name="VocabularySearchString">
+        <annotation>
+            <documentation>
+                <summary>
+                    Type defining a vocabulary search string.
+                </summary>
+
+                <remarks>
+                    The search string is a culture specific string of characters against 
+                    which vocabulary items are compared using the specified search mode.
+                </remarks>
+            </documentation>
+        </annotation>
+        <simpleContent>
+            <extension base="wc-types:string255">
+                <attribute name="search-mode" type="wc-types:string64" use="optional">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The search mode to use for this search string. 
+                                If not specified, the "Prefix" search mode is used.
+                            </summary>
+
+                            <remarks>
+                                Allowable values for the search mode string are:
+                                <br></br>
+                                1) "Prefix"
+                                <br></br>
+                                The Prefix search mode retrieves all vocabulary items
+                                that begin with the search string. For instance if the
+                                search string is "ab" all vocabulary items beginning with
+                                "ab" are returned.
+                                <br></br>
+                                2) "Contains"
+                                <br></br>
+                                The Contains search mode retrieves vocabulary items that
+                                contain the search string as a substring.
+                                <br></br>
+                                An INVALID_XML error is returned if the search mode doesn't 
+                                match one of the above strings.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </attribute>
+
+            </extension>
+        </simpleContent>
+    </complexType>
+
+    <element name="info">
+        <complexType>
+            <annotation>
+                <documentation>
+                    <summary>
+                        The element of the request that contains the method
+                        specific parameters.
+                    </summary>
+
+                    <remarks>
+
+                    </remarks>
+                </documentation>
+            </annotation>
+            <sequence>
+                <element name="vocabulary-key" type="wc-vocab:VocabularyKey"
+                         minOccurs="0" maxOccurs="1">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                The unique key used to identify the vocabulary to search.                                
+                            </summary>
+
+                            <remarks>
+                                If the vocabulary key is not present to identify a vocabulary,
+                                the vocabulary headers are searched.
+                                <br></br>
+                                If the vocabulary key is present, then the vocabulary name,
+                                family and version must identify an existing vocabulary on
+                                the system otherwise an INVALID_VOCABULARY error is returned.
+                                <br></br>
+                                If the family is not specified in the vocabulary key, the system                                
+                                looks for a vocabulary with the specified name in the
+                                Wildcat Vocabularies family.
+                                <br></br>
+                                If the vocabulary version is empty, the latest version of the 
+                                vocabulary is used in the search.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                </element>
+
+                <element name="text-search-parameters"
+                         type="wc-searchvocabulary:VocabularySearchParams">
+                    <annotation>
+                        <documentation>
+                            <summary>
+                                Specifies the text search parameters for the vocabulary search
+                                request. 
+                            </summary>
+
+                            <remarks>
+                                The text search parameters apply to the culture specifed
+                                in the request header by language and country. If the country
+                                is absent, items for the language are searched. If language
+                                is absent, items for the default culture of the system are 
+                                searched.
+                            </remarks>
+                        </documentation>
+                    </annotation>
+                    
+                </element>
+                         
+
+            </sequence>
+        </complexType>
+    </element>
+</schema>