Server::getUser

This method returns a constituent record. Use this method when calling from another application or server.

Post URL

Authentication

Authenticating Convio Server API calls is a three-stage process. First, the IP address of the server invoking the API call will be checked against the list of allowed IP ranges, per the Convio Site Configuration parameters. If the API is being invoked from a server in the allowed IP range, then the login_name and login_password parameters will be used to login to the Convio site. Finally, once the login credentials have been verified, the account specified by the login credentials will be examined to ensure that it has the Contact Management “Use Convio API” permission. If all the above hold, the caller will be authenticated and the API call will proceeed. If any of the above fail, then the call will not be authenticated and an error message will be returned.

Parameters

The definition of all constituent record fields that can be retrieved is defined in an XML Schema document (crm.public.v1.xsd). However, many of those fields might not be in use for the site and some of them might not be visible to the user requesting the record. Use the listUserFields API method to list the fields that can be retrieved.

The following parameters also apply:

If the requester is not an administrator, then the requester's own record is retrieved regardless of what cons_id is specified.

If the requester is an administrator, then one of cons_id, member_id, or primary_email must be specified in order to locate the record to retrieve.

1. If cons_id is given, then it is the only thing used to search.

2. If cons_id is absent and member_id is given, then it is the only thing used to search.

   • If one record matches member_id, it is retrieved.
   • If multiple records match member_id, then this is an error and no record is retrieved.
   • If no records match member_id, then primary_email is searched. If exactly one match is found, then that record is retrieved.
3. If cons_id and member_id are absent, then primary_email is searched and a record is updated if exactly one match is found.

If the requester is not an administrator, then the requester's own record is updated regardless of what cons_id is specified.

Response

Success

The HTTP status code is 200. The response is formatted as XML by default, but the response_format input parameter can be used to specify either XML or JSON formatting. A successful invocation might appear as follows:

<getConsResponse 
  xsi:schemaLocation=http://convio.com/crm/v1.0
  http://service.convio.net/xmlschema/crm.public.v1.xsd
  xmlns="http://convio.com/crm/v1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<cons_id>1001172</cons_id>
<name>
   <title xsi:nil="true"/>
   <first>Zaphod</first>
   <last>Beeblebrox</last>
</name>
<email>
   <primary_address>zaphod@convio.com</primary_address>
</email>
</getConsResponse>

{"getConsResponse":{"cons_id":"1001172",
"email":{"primary_address":zaphod@convio.com}, 
"name":{"last":"Beeblebrox","title":null,"first":"Zaphod"}}}

Notes:

• If a field is not included in the response, it is either not enabled for the site or it is invisible to the caller.
• If the field is included but has no value (xsi:nil="true" in an XML response or null in a JSON response), then the field is visible and has a null value for the retrieved record.
• If a composite element (one that can contain nested elements), such as "name" or "email" in the example above, is nil then all of its contained fields are either disabled or have nil values for this record.

Error

<errorResponse 
  xsi:schemaLocation=http://convio.com/crm/v1.0
  http://service.convio.net/xmlschema/crm.public.v1.xsd
  xmlns="http://convio.com/crm/v1.0"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<code>16</code>
<message> Cannot access the user because no records 
match the search criteria.</message>
</errorResponse>

{"errorResponse":{"code":"16",
"message":"Cannot access the user because no records 
match the search criteria."}}