Navigation:  Integration via SOAP web services > Published web services > Capture >

newBatch

Previous  Top  Next

This method allows you to insert a new capture batch.

 

Java class

Request

web/wwwroot/ws/java/capture/NewBatchRequestType.java

Return

web/wwwroot/ws/java/capture/NewBatchResponseType.java

 

Request

ID #

Required

Description

CaptureSettingID

X

Capture configuration ID #

BatchID

 

Capture batch ID #. If uninformed, the system will generate a sequential ID #.

BatchName

 

Batch title. If uninformed, the system will generate a title based on the date/time of the batch creation.

 

Return

ID #

Description

Status

FAILURE (in case of failure)

SUCCESS (in case of success)

Code

Error code:

0 - No error (record created successfully);

1 - Required parameter not entered or entered incorrectly;

2 - This user does not have permission for this operation;

3 - ID # already exists;

4 - Capture configuration not found;

Detail

Message detailing the error or success in the execution of the method

RecordID

Created batch ID # (in case of success) or empty (in case of failure)