Gets the contacts from an address book import job
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRAddressBookAPI | None. | GET, POST | Yes. |
This method returns a list of contact data imported from an online address book such as Gmail or Yahoo. Prerequisite to calling this method, you must obtain a job ID from startOnlineAddressBookImport and addressBookImportOAuthCallback, and the getAddressBookImportJobStatus method must reflect that the import job has completed successfully.
After retrieving contacts from the hosting provider with this method, call importAddressBookContacts to add the returned contacts to the constituent's address book. For usage details refer to the Usage Notes for startOnlineAddressBookImport
See topic Common Parameters.
Required. ID of an address book import job.
Type xsd:integer.
Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.
Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<getAddressBookImportContactsResponse 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">
<contact>
<firstName>Adam</firstName>
<lastName>Adams</lastName>
<email>aadams@address.net</email>
</contact>
<contact>
<firstName>Brian</firstName>
<lastName>Brians</lastName>
<email>bbrians@address.net</email>
</contact>
<contact>
<firstName>Charlie</firstName>
<lastName>Charles</lastName>
<email>ccharles@address.net</email>
</contact>
</getAddressBookImportContactsResponse>
JSON response
{"getAddressBookImportContactsResponse":{"contact":[{"lastName":"Adams","email":"aadams@address.net","firstName":"Adam"},{"lastName":"Brians","email":"bbrians@address.net","firstName":"Brian"},{"lastName":"Charles","email":"ccharles@address.net","firstName":"Charlie"}]}}