Abort a Job.

Abort the Job by ID.

Function

  • abortJob()

Parameters

  • username: String
    • Account login name.
  • password: String
    • Account password.
  • jobId: Integer
    • The Job ID.

Return

  • int:
    • 1: Successfully Aborted this Job
    • 0: Failed Aborted this Job

Exception

  • Exception

Documentation

  • Ability to abort the job when it is:
    • Paused,
    • NOT finished
    • the state equals Ready.

Examples

public void abortJobSample() throws Exception {

        String username = "XXX";
        String password = "XXX";
        int jobId = 1234;

        int result = port.abortJob(username, password, jobId);

        if (result == 1) {
            System.out.println("success");
        }

}

<?php
include 'puresend.php';

$p = new Puresend();

$abortJobData = new abortJob();
$abortJobData->username = 'XXX';
$abortJobData->password = 'XXX';
$abortJobData->jobId = 1234;

$response = $p->abortJob($abortJobData);
var_dump($response);
?>