Overview

Skill Level: Beginner

Step-by-step

  1. Syntax of the request and response XML for GetJobStatus

    This step 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) which you can find in the Download folder of the FTP account.

    Operation

    <GetJobStatus>

    Elements

    JOB_ID

    Identifies the Acoustic Campaign Background Job that is created and scheduled as a result of another API call.
    Example 
    <Envelope>
  <Body>
    <GetJobStatus>
      <JOB_ID>40865</JOB_ID>
    </GetJobStatus>
  </Body>
</Envelope>
    Response <RESULT>

    Elements

    SUCCESS

    True if successful.
     

    JOB_ID

    Identifies the Acoustic Campaign background job that is 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. Valid values are:

    • WAITING
    • RUNNING
    • CANCELLED
    • ERROR
    • COMPLETE
     

    JOB_DESCRIPTION

    Description of the job processed.
     

    PARAMETERS

    Parameter list that contains <Parameter> elements with name-value pairs.

    (See each response example in the tables for more detail.)
    Example 
    <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>

    Various job types can be executed in the Acoustic Campaign and monitored by using the GetJobStatus operation. 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.

    The following tables describe the different Parameters that are returned from GetJobStatus depending on the current state of the job and the API called to create the job.

    Parameters when a database Import Job is Waiting/Running

    PARAMETERS List of parameters that begin with <PARAMETER> element and containing name-value pairs with details on the status of the export database job.
    Name-value pairs NOT_ALLOWED Number of rows not allowed.
    LIST_ID ID of database. Blank until the 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.
    DULICATES 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 that were valid in the database. Increments as the source file processes.
    BAD_RECORDS Number of rows that were not valid.

     

    Parameters when database Import Job is complete

    PARAMETERS List of parameters that begin with <PARAMETER> element and containing name-value pairs with details on the status of the job.
    Name-value pairs NOT_ALLOWED Number of rows not allowed.
    LIST_ID ID of database. This is blank until the 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 that were valid in the source file. This increments as the source file is processed.
      TOTAL_VALID Number of rows that were not valid.

     

    Parameters when database Export Job is Waiting/Running

    PARAMETERS List of parameters that begin with <PARAMETER> element and containing name/value pairs with details on the status of the job.
    Name-value pairs 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.

     

    Parameters when database Export Job is complete

    PARAMETERS List of parameters that begin with <PARAMETER> element and containing name-value pairs with details on the status of the job.
    Name-value pairs 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 that is processed.

Join The Discussion

Your email address will not be published. Required fields are marked *