Get the status of a data job - GetJobStatus

Monitors the status of a job once initiated.

This call is optional in the job process. If a data job completes with errors, you can view detailed results in the results file (.res) and error file (.err) found in the Download folder of the FTP account.

Elements (Required)

JOB_ID - Identifies the background job created and scheduled as a result of another API call.

<Envelope>
  <Body>
    <GetJobStatus>
      <JOB_ID>40865</JOB_ID>
    </GetJobStatus>
  </Body>
</Envelope>
<Envelope>
  <Body>
    <RESULT>
      <SUCCESS>TRUE</SUCCESS>
      <JOB_ID>789052</JOB_ID>
      <JOB_STATUS>COMPLETE</JOB_STATUS>
      <JOB_DESCRIPTION>Creating new contact source, Master database
      </JOB_DESCRIPTION>
      <PARAMETERS>
        <PARAMETER>
          <NAME>NOT_ALLOWED</NAME>
          <VALUE>0</VALUE>
        </PARAMETER>
        <PARAMETER>
          <NAME>LIST_ID</NAME>
          <VALUE>116347</VALUE>
        </PARAMETER>
        <PARAMETER>
          <NAME>RESULTS_FILE_NAME</NAME>
          <VALUE>1241474.res</VALUE>
        </PARAMETER>
        <PARAMETER>
          <NAME>SQL_ADDED</NAME>
          <VALUE>65535</VALUE>
        </PARAMETER>
        <PARAMETER>
        </PARAMETER>
        <PARAMETER>
          <NAME>ERROR_FILE_NAME</NAME>
          <VALUE>1241474.err</VALUE>
        </PARAMETER>
        <PARAMETER>
          <NAME>LIST_NAME</NAME>
          <VALUE>BigList</VALUE>
        </PARAMETER>
        <PARAMETER>
          <NAME>BAD_ADDRESSES</NAME>
          <VALUE>0</VALUE>
        </PARAMETER>
        <PARAMETER>
          <NAME>SQL_UPDATED</NAME>
          <VALUE>0</VALUE>
        </PARAMETER>
        <PARAMETER>
          <NAME>BAD_RECORDS</NAME>
          <VALUE>0</VALUE>
        </PARAMETER>
        <PARAMETER>
          <NAME>TOTAL_VALID</NAME>
          <VALUE>65535</VALUE>
        </PARAMETER>
      </PARAMETERS>
    </RESULT>
  </Body>
</Envelope>

Elements (Results)

SUCCESS - True if successful; False if not.

JOB_ID - Identifies the background job created and scheduled as a result of the API call. Matches the JOB_ID passed in the request.

JOB_STATUS - Identifies the current job status at the time of the API call: WAITING, RUNNING, CANCELLED, ERROR, or COMPLETE.

JOB_DESCRIPTION - Description of the job processed.

PARAMETERS - Parameter list that contains elements with name-value pairs. See the specific details for different job types below.

Job type

Status

Import job

Waiting/running

Import job

Complete

Export job

Waiting/running

Export job

Complete

child elements based on return status

GetJobStatus can monitor various job types executed in Acoustic Campaign. However, the response data differs between types of jobs and the status. For example, if the status of a database import job is WAITING, the response element contains different elements and values from the same call with a status of ERROR.

A database import job is waiting/running

NOT_ALLOWED - Number of rows not allowed.
LIST_ID - ID of database. Blank until Acoustic Campaign creates the database. Once created, this has a value throughout processing and when the job is complete.
SQL_ADDED - Number of rows added to the database. During processing, this number increments in steps of 10,000 until the job is complete.
DUPLICATES - Number of duplicate rows detected.
TOTAL_ROWS - Number of rows in database. During processing, this value changes as the initial source file parses and it reads all rows in the file.
LIST_NAME - Name of database.
BAD_ADDRESSES - Number of email addresses in incorrect format.
SQL_UPDATED - Number of rows updated.
TOTAL_VALID - Number of rows valid in the database. Increments as the source file processes.
BAD_RECORDS - Number of rows that were not valid.

A database import job is complete

NOT_ALLOWED - Number of rows not allowed.
LIST_ID - ID of database. This is blank until Acoustic Campaign creates the database. Once the database is created, this has a value throughout processing and when the job is complete.
SQL_ADDED - Number of rows added to the database. During processing, this number increments in steps of 10,000 until the job is complete.
DUPLICATES - Number of duplicate rows detected.
TOTAL_ROWS - Number of rows in database. During processing, this value changes as the initial source file is parsed until it reads all rows in the file.
LIST_NAME - Name of database.
BAD_ADDRESSES - Number of email addresses in incorrect format.
SQL_UPDATED - Number of rows updated.
BAD_RECORDS - Number of rows valid in the source file. This increments as the source file is processed.
TOTAL_VALID - Number of rows that were not valid.

A database export job is waiting/running

NUM_PROCESSED - Number of rows processed. This increments during processing of the job.
LIST_ID - ID for exported database or query.
LIST_NAME - Name of exported database or query.

A database export job is complete

NUM_PROCESSED - Number of rows processed. Value is the number of rows.
LIST_ID - ID for the database processed.
LIST_NAME - The name of the database processed.