conquery($id) : Contact querying
A simple query operation. The only scalar argument is the
identifier of the contact and the hash returned has up to three tags:
| Hash returned by conquery() |
| Hash Key | Description |
| contact |
Hash of contact data:
| Key | Description |
| name | Contact's Name |
| address | Contact's Address |
| cc | Contact's country: ISO code |
| email | Contact's email address |
| phone | Contact's phone number |
| fax | Contact's fax number |
| id | Contact's identifier |
| registered | Registration date (YYYY-MM-DD) |
|
| found |
| 1 | if the contact was found |
| 0 | otherwise | |
|
| error |
An array of error messages which may include:
| Code | Description |
| 310 | Invalid argument format |
| 500 | Error in query |
|
Example
Request
conquery('per4073.tc')
<?xml version="1.0" encoding="UTF-8"?>
<methodCall>
<methodName>conquery</methodName>
<params>
<param>
<value><string>per4073.tc</string></value>
</param>
</params>
</methodCall>
Return
{
'found' => '1',
'contact' => {
'phone' => '1',
'email' => 'person@adamsnames.tc',
'registered' => '1998-08-28',
'cc' => 'uk',
'address' => '3 Adams Road\\nCAMBRIDGE\\nCB3 9AD',
'id' => 'per4073.tc',
'fax' => '',
'name' => 'AdamsNames'
},
'error' => []
}
<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<name>error</name>
<value>
<array><data/></array>
</value>
</member>
<member>
<name>contact</name>
<value>
<struct>
<member>
<name>registered</name>
<value><string>1998-08-28</string></value>
</member>
<member>
<name>name</name>
<value><string>AdamsNames</string></value>
</member>
<member>
<name>phone</name>
<value><int>1</int></value>
</member>
<member>
<name>email</name>
<value><string>person@adamsnames.tc</string></value>
</member>
<member>
<name>cc</name>
<value><string>uk</string></value>
</member>
<member>
<name>fax</name>
<value><string/></value>
</member>
<member>
<name>address</name>
<value><string>3 Adams Road\nCAMBRIDGE...</string></value>
</member>
<member>
<name>id</name>
<value><string>per4073.tc</string></value>
</member>
</struct>
</value>
</member>
<member>
<name>found</name>
<value>
<int>1</int>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>
|