Function prototype | case_get_contact ( session , case, [subscription] , [admission], [mode]) |
|---|---|
API Version | ALL |
SOAP |
Description
Returns personal data of a CASEThe case reference can be any of the references obtained from a case_get(). Be aware that passing two different references from the same source will return the same values (is only an alternate identifier). If the parameter case is null, the function returns an empty XML template.
The data included in the response is determined by one of the CASE FORMAT SETTINGS (FORMAT.CASE or FORMAT.CASE.NEW)
Required permissions: The active user must have role XXXX. Otherwise an INSUFFICIENT_PRIVILEGES error will be returned.
Input parameters: |
|
Output parameters: |
|
Request example
case_get_contact( “LCAAAAAAAAAAAA”, 10261)
Response
<contact>
<ref>10261</ref>
<username>alex4234</username>
<editable>true</editable>
<pictures>
<insignia>
<ref>1</ref>
</insignia>
</pictures>
<identifiers>
<identifier>
<description>Participant Reference</description>
<label>PARTICIPANT_REF</label>
<value>0001</value>
<validation_id>PARTICIPANT_REF#243#1</validation_id>
<program>
<ref>243</ref>
<code>SPIRO</code>
<name>Spirometry study</name>
</program>
<team>
<ref>1</ref>
<code>LINKCARE</code>
<name>Linkcare</name>
</team>
<editable>true</editable>
<source/>
</identifier>
<identifier>
<description>NIF</description>
<label>NAT_ES</label>
<value>ALEXEY</value>
<validation_id>NAT_ES</validation_id>
<image_ref>3626</image_ref>
<editable>true</editable>
<source/>
</identifier>
<identifier>
<description>PASSPORT</description>
<label>PASS</label>
<value />
<validation_id>PASS</validation_id>
<editable>true</editable>
<source/>
</identifier>
</identifiers>
<full_name>Maria Rosa Gosa Imbern</full_name>
<data>
<bdate>
<bdate>1998-03-20</bdate>
<age>17</age>
<editable>true</editable>
<source/>
</bdate>
<gender>
<gender>F</gender>
<editable>true</editable>
<source/>
</gender>
<nationality>
<name>Spain</name>
<ref>ES</ref>
<editable>true</editable>
<source/>
</nationality>
</data>
<name>
<given_name>Maria Rosa</given_name>
<family_name>Gosa Imbern</family_name>
<complete_name></complete_name>
<editable>true</editable>
<source/>
</name>
<addresses>
<address>
<kind>Main Address</kind>
<street>Roger de LLuria</street>
<number>50</number>
<floor>SAT</floor>
<suite>A</suite>
<district />
<city>Barcelona</city>
<postcode>08009</postcode>
<state />
<country>España</country>
<comment />
<gps_map_url>http://maps.google.com/maps?q=Roger+de+Lluria%2C+50%2C+Barcelona%2C+%2C+08009%2C+Spain</gps_map_url>
<full_address>Roger de Lluria 50 SAT A, 08009 Barcelona, Barcelona, Spain</full_address>
<editable>true</editable>
<source/>
</address>
</addresses>
<channels>
<phones>
<channel_type>phone</channel_type>
<description>Teléfonos</description>
<phone>
<type>mobile</type>
<ref>1</ref>
<value>934546365</value>
<description>Móvil</description>
<comment />
<preferred>true</preferred>
<verified>true</verified>
<editable>true</editable>
<source/>
</phone>
<phone>
<ref>2</ref>
<type>ext</type>
<value>22</value>
<description>Ext.</description>
<comment />
<preferred>false</preferred>
<verified>false</verified>
<editable>true</editable>
<source/>
</phone>
<phone>
<ref>4</ref>
<type>work</type>
<value>935555555</value>
<description>Oficina</description>
<comment />
<preferred>false</preferred>
<verified>false</verified>
<editable>true</editable>
<source/>
</phone>
</phones>
<emails>
<channel_type>email</channel_type>
<description>Correo electrónico</description>
<email>
<ref>5</ref>
<type>work</type>
<value>PITIKLIN@LINKCARE.ES</value>
<description>Oficina</description>
<comment />
<preferred>true</preferred>
<verified>false</verified>
<editable>true</editable>
<source/>
</email>
<email>
<ref>6</ref>
<type>home</type>
<value>RPELAEZ@LINKCARE.ES</value>
<description>Casa</description>
<comment />
<preferred>false</preferred>
<verified>false</verified>
<editable>true</editable>
<source/>
</email>
</emails>
<aims>
<channel_type>aim</channel_type>
<description>Mensajería instantánea</description>
<aim>
<ref>7</ref>
<type>Skype</type>
<value>SKYPEUSER</value>
<description>Skype</description>
<comment />
<preferred>false</preferred>
<verified>false</verified>
<editable>true</editable>
<source/>
</aim>
</aims>
<device>
<channel_type>device</channel_type>
<description>Dispositivos</description>
<ref>8</ref>
<type>bluetooth</type>
<value>D898989</value>
<description>bluetooth</description>
<source />
<comment />
</device>
<devices />
</channels>
</contact>
Return Error codes
ERROR CODE | |
|---|---|
INVALID_TOKEN | The session token provided is not valid |
INSUFFICIENT_PRIVILEGES | The session user does not have the necessary privileges to … |
Changes in XML structure (previous versions)
Changes in version 2.7.25
The Gender, Birthdate and Nationality information returned in versions before 2.7.27 had a different format:
2.7.24 and previous | 2.7.25 and newer |
|---|---|
<data>
<bdate>1998-03-20</bdate>
<age>17</age>
<gender>F</gender>
<nationality>Spain</nationality>
<nationality_ref>ES</nationality_ref>
<editable>true</editable>
<source/>
</data>
| <data>
<bdate>
<bdate>1998-03-20</bdate>
<age>17</age>
<editable>true</editable>
<source/>
</bdate>
<gender>
<gender>F</gender>
<editable>true</editable>
<source/>
</gender>
<nationality>
<name>Spain</name>
<ref>ES</ref>
<editable>true</editable>
<source/>
</nationality>
</data>
|