dpCSVFileImportStatus (Command)

Mis à jour le 20 Dec 2024
1 Minute à lire

Partager
Sombre
Lumière
PDF

The content is currently unavailable in French. You are viewing the default English version.

Résumé de l’article

Avez-vous trouvé ce résumé utile ?

Merci pour vos commentaires

Availability: OneSpan Authentication Server 3.21 and later
Scenario: Administration

The dpCSVFileImportStatus command returns the current status of a server task that has been previously started via the dpCSVFileImport command (see dpCSVFileImport (Command)).

Parameters

Table: dpCSVFileImportStatus input parameters
Parameter name	Data type	Description
sessionID	String	Required. The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)).
cacheID	String	Required. The unique identifier of the uploaded DIGIPASS import file generated by the dpCSVFileUploadMTOM command.
returnErrors	Boolean	Optional. Specifies whether to return a list of errors for each record that could not be imported.

Table: dpCSVFileImportStatus output parameters
Parameter name	Data type	Description
status	CommandStatusResponse	Required. The error stack, if applicable, which indicates that the command has not completed successfully. This also includes the result and status codes returned by the command.
result	dpCSVFileImportStatusResult	Required. The result set of a successful command execution containing the status information (see dpCSVFileImportStatusResult (Data type)).

dpCSVFileImportStatusResult (Data type)

Table: dpCSVFileImportStatusResult (Data type)
Parameter name	Data type	Description
applsTotal	Unsigned integer	The total number of authenticator application instances in the file.
applsRead	Unsigned integer	The total number of authenticator application instances read from the file.
dpRead	Unsigned integer	The total number of authenticator records that were processed so far.
dpImported	Unsigned integer	The total number of authenticator records that were successfully imported so far.
dpFailed	Unsigned integer	The total number of authenticator records that could not be imported so far.
errorList	RecordErrorList	Optional. A list of the individual results for all records that could not be imported so far (see RecordErrorList (Data type)). This list is only returned if returnErrors is set to true in the input parameters.

RecordErrorList (Data type)

Table: RecordErrorList (Data Type)
Parameter Name	Data Type	Description
errors	RecordError	Zero or more records containing the individual error details of a record that could not be imported (see RecordError (Data type)).

RecordError (Data type)

Table: RecordError (Data type)
Parameter name	Data type	Description
recordID	String	The unique ID of the record.
errorCode	Integer	The numeric error code.
errorDesc	String	The error description.

Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Header/>
  <soapenv:Body>
    <adm:dpCSVFileImportStatus xmlns:prov="http://www.vasco.com/IdentikeyServer/IdentikeyTypes/Administration">
      <sessionID>3JSK8cmRjw4E30wAA=0nUTL-~3fmifTO</sessionID>
      <cacheID>5FD10FA7-D830-5149-A3B6-A4AA623EBFB9</cacheID>
      <returnErrors>true</returnErrors>
    </adm:dpCSVFileImportStatus>
  </soapenv:Body>
</soapenv:Envelope>

Requirements

Required administrative privileges:

Import DIGIPASS

Cet article vous a-t-il été utile ?

What's Next

dpCSVFileImportStop (Command)

Table des matières

Parameters
Example
Requirements