Response Message for a Valid User Request
In the PM response message, there are optional "param" XML elements in various locations of the XML. These can be used to describe additional parameters that may exist for different users, projects or global data. For example, if there is a need to prevent a user from getting access to particular data, the user param field could be used to hold a security alert. Or the project parameter could hold the name of a project sponsor or surrogate. The param tags are generic XML tags for adding more information to the messages.
<message_body>
<configure>
<environment>PRODUCTION</environment>
<helpURL>http://i2b2.org/help</helpURL>
<user>
<full_name>Demo User</full_name>
<user_name>demo</user_name>
<password>demouser</password>
<domain>HIVE</domain>
<admin>true</admin>
<project id="ASTH">
<name>Asthma group</name>
<key>X567j83</key>
<wiki>htt://asthma.i2b2.org/wiki/</wiki>
<role>USER</role>
<role>MANAGER</role>
<param name="IRB_Number">2008P00345</param>
</project>
<param name="user_key"1941jd2-02d21=""</param>
</user>
<cell_datas>
<cell_data id="PM">
<name>Project Management</name>
<url>http://i2b2.org/PMService/</url>
<method>SOAP</method>
</cell_data>
<cell_data id="ONT">
<name>ontology</name>
<url>http://i2b2.org/OntologyServiceAsthma/</url>
<method>SOAP</method>
<param name="OntMax">200</param>
<param name="OntSyn">false</param>
</cell_data>
<cell_data id="PFT">
<name>PFT</name>
<url>http://i2b2.org/PFTService/</url>
<method>REST</method>
</cell_data>
<cell_data id="CRC">
<name>PreviousQuery</name>
<url>http://i2b2.org/QueryToolService/</url>
<method>SOAP</method>
</cell_data>
<cell_datas>
<global_data>
<param name-nickname="">Demo guy</param>
</global_data>
</configure>
</message_body>
Response Message for an Invalid User Request
<response_header>
<result_status>
<status type="ERROR">Supplied password does not match user password!</status>
</result_status>
</response_header>