The following is an example of a completed Export Job.
{
"exportJobId": 999888,
"exportJobGuid": "7B623929-05DA-4356-BF30-EF7D1BB0248C",
"savedListId": 1234,
"webhookUrl": "https://webhook.example.org/completedExportJobs",
"downloadUrl": "https://ngpvan.blob.core.windows.net/completed-export-jobs/7B623929-05DA-4356-BF30-EF7D1BB0248C_2017-01-01T12:00:00.csv",
"status": "Completed",
"type": 777,
"dateExpired": "2017-01-04T12:00:00Z",
"errorCode": null,
"surveyQuestions": [ { "surveyQuestionId": 1234 } ],
"activistCodes": [ { "activistCodeId": 4567 } ],
"customFields": [ { "customFieldId": 5678 } ],
"districtFields": [ { "districtFieldId": 10 } ]
}
Export Job
Property | Type | Description |
---|---|---|
| int | Read-only; Unique identifier for an Export Job |
| string | Read-only; Globally unique identifier for an Export Job |
| int | The Saved List containing People who are to be exported. This Saved List must be available to the API - i.e. it must be available via |
| string | The URL to be notified when the Export Job has completed |
| string | Read-only; The URL where the completed Export Job may be downloaded. Will be |
| string | Read-only; The status of the Export Job; may be |
| int | The type of Export Job, indicating the columns to provide about the People in the Saved List. Contact us at [email protected] to determine the appropriate type. Note that while the list of columns provided with an Export Job type is static, some columns may be blank in certain contexts due to lack of availability. |
| datetime | Read-only; The date when the download URL expires. |
| string | Read-only; a reference for any error which occurred during the processing of the Export Job. Will be |
| array | Write-only; an array of objects, each containing a |
| array | Write-only; an array of objects, each containing an |
| array | Write-only; an array of objects, each containing a |
| array | Write-only; an array of objects, each containing a |
Note about Survey Questions, Activist Codes, Custom Fields and District Fields
Please note the following caveats about using these properties:
- Use of these properties requires special permissions, please contact us if you think you will need these properties.
- No more than ten such elements total may be requested per Export Job.
- No more than five elements of any type may be requested per Export Job.
For example, it is valid to request three Survey Questions and three Activist Codes, but it is not valid to request six Activist Codes in a single Export Job; or to request three Survey Questions, three Activist Codes, three Custom Fields, and three District Fields in a single Export Job.