Skip to main content
Cards

Download the final result CSV for a card import batch

Download a CSV report containing the final outcome for all rows in the specified import batch, including rows that were created, updated, skipped, or failed.

GET
/fm/cards/imports/{import_batch_id}/result

Returns 404 if the specified batch does not exist.

Returns 422 if the batch exists but has not yet been processed (i.e. the process step has not been completed). The error report download (GET /fm/cards/imports/{import_batch_id}/errors) is available as soon as the upload/validation step is complete; the result download only becomes available after processing.

This method requires the Cards:Get permission to be associated with your role.

CSV columns:

ColumnDescription
row_number1-based row number from the original upload file (excluding the header row)
card_numberCard number from the uploaded row
actionAction performed: create, update, or blank if not applicable
statusFinal row outcome: create, update, invalid, duplicate, or unauthorized
error_messageHuman-readable reason for failure, or blank for successfully processed rows
card_idThe card_id of the created or updated card record, or blank if the row was not processed
Authorizationstringheaderrequired

For accessing the API a valid token must be passed in all the queries in the 'Authorization' header.

A valid token is generated by the API and returned by the /authenticate method by supplying a valid username and password.

The following syntax must be used in the 'Authorization' header :

Bearer aaaaaa/bbbbbb.ccccccc.dddddd
import_batch_idstringrequired

The import_batch_id returned from the upload step.

Maximum string length: 10
Pattern: ^[1-9]{1}[0-9]*$

Response

text/csv

CSV file containing the final outcome for all rows in the batch. Content-Disposition header will be set to attachment; filename="card-import-{import_batch_id}-result.csv".

bodystring