Gets the status of an address book import job
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| CRAddressBookAPI | None. | GET, POST | Yes. |
This method returns the status of an active import job. Prerequisite to calling this method, you must obtain a job ID from startOnlineAddressBookImport.
This method will return "PENDING" status until the constituent authenticates with the hosting provider and grants access to his address book, resulting in a successful call to addressBookImportOAuthCallback.
Once the download completes, use getAddressBookImportContacts to return the downloaded data.
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"?>
<getAddressBookImportJobStatusResponse 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">
<jobStatus>PENDING</jobStatus>
<events>
<event>Received authorization</event>
<event>Importing Contacts</event>
</events>
</getAddressBookImportJobStatusResponse>
JSON response
{"getAddressBookImportJobStatusResponse":{"jobStatus":"PENDING","events":{"event":["Received authorization","Importing Contacts"]}}}