API reference: Imports

Prev Next

 API reference: Imports documents the function signatures, parameters, return values, and error behavior of the Elaine HTTP API.

Note

Function availability depends on the Elaine release and enabled features. Authenticate HTTP requests with an Elaine-issued Bearer JWT.

Function overview

array|integerapi_getImportStatus ( string $filename )
Returns the status of the import via the import file name $filename.

Functions


api_getImportStatus

array|integer api_getImportStatus( string $filename )

SINCE 5.11.3 Returns the status of the import via the import file name $filename. The return array contains the following information:
  • 'i_id': import ID
  • 'ev_id': recipient group ID
  • 'i_status': 'pending','processing','finished' oder 'rollback'
  • 'i_start': start time of the import as string
  • 'i_finish': end time of the import as string
  • 'sieis_report': the full report of the import in JSON format (only with SIES imports).

Parameters

string$filenameName of the import file

Return Value

array|integerStatus data of the imported file