Batchelor SOAP Service

WSDL Comment
Show compact view 
The SOAP service handler.
  
  <code>
  // 
  // The default job queue is derived from connection. It's possibly to use
  // multiple job queues and switch between them by calling select().
  //
  proxy->select('my-job-queue');
  
  // 
  // Pass null to revert back to default job queue:
  // 
  proxy->select(null);
  </code>
  
  <code>
  // 
  // Queued jobs can be listed by calling queue(). Jobs are enqueue (scheduled 
  // for later execution) by calling enqueue:
  // 
  queued = proxy->enqueue(job);
  
  // 
  // The queued job returned contains the identity that can be used i.e. when
  // removing a job:
  // 
  proxy->dequeue(queued->identity);
  
  </code>
  
  <code>
  // 
  // The three methods opendid(), readdir() and fopen() can be used to create
  // explorer-like interfaces. This code can be used to download all files in
  // from a job queue:
  // 
  foreach (proxy->opendir() as identity) {
       foreach (proxy->readdir(identity) as filename) {
               this->save(filename, proxy->fopen(identity, filename));
       }
  }
  </code>
 
  @since 2.0.x Clients based on 1.0 API need to update.
  @author Anders Lövgren (Nowise Systems)

Methods

MessageResponseSourceDetails

Method:

QueuedJob[]queue(stringsort, stringfilter)
This method returns the list of queued jobs in current queue.

Parameters:

sort
The sort options.
filter
The filter options.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><queue><sort>string</sort><filter>string</filter></queue></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><queue><return><identity><jobid>string</jobid><result>string</result></identity><status><queued><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></queued><started><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></started><finished><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></finished><state><value>string</value></state></status><submit><task>string</task><name>string</name></submit></return></queue></soap:body></soap:envelope> 
/**
         * This method returns the list of queued jobs in current queue.
         * 
         * @param string $sort The sort options.
         * @param string $filter The filter options.
         * @return QueuedJob[]
         */
Method [ <user> public method queue ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 90 - 95

  - Parameters [2] {
    Parameter #0 [ <required> string $sort ]
    Parameter #1 [ <required> string $filter ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'sort',
      'type' => 'string',
      'repeat' => '1',
      'docs' => 'The sort options.',
    ),
    1 => 
    array (
      'name' => 'filter',
      'type' => 'string',
      'repeat' => '1',
      'docs' => 'The filter options.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'QueuedJob',
      'repeat' => 'unbounded',
      'docs' => '',
    ),
  ),
  'documentation' => 'This method returns the list of queued jobs in current queue.
          
          @param string sort The sort options.
          @param string filter The filter options.
          @return QueuedJob[]',
)
MessageResponseSourceDetails

Method:

stringselect(stringqueue)
Switch currently selected job queue.
Pass queue as the name of the job queue to select it as current job qeuue for next operations. Use null as argument for reverting back to default queue.

Parameters:

queue
The queue name.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><select><queue>string</queue></select></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><select><return>string</return></select></soap:body></soap:envelope> 
/**
         * Switch currently selected job queue.
         * 
         * Pass $queue as the name of the job queue to select it as current job
         * qeuue for next operations. Use null as argument for reverting back to
         * default queue.
         * 
         * @param string $queue The queue name.
         * @return string
         */
Method [ <user> public method select ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 107 - 110

  - Parameters [1] {
    Parameter #0 [ <required> string $queue ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'queue',
      'type' => 'string',
      'repeat' => '1',
      'docs' => 'The queue name.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'string',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'documentation' => 'Switch currently selected job queue.
          
          Pass queue as the name of the job queue to select it as current job
          qeuue for next operations. Use null as argument for reverting back to
          default queue.
          
          @param string queue The queue name.
          @return string',
)
MessageResponseSourceDetails

Method:

QueuedJobenqueue(JobDataindata)
Queues an job for later execution.

Parameters:

indata
The input data.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><enqueue><indata><data>string</data><type>string</type><task>string</task><name>string</name></indata></enqueue></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><enqueue><return><identity><jobid>string</jobid><result>string</result></identity><status><queued><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></queued><started><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></started><finished><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></finished><state><value>string</value></state></status><submit><task>string</task><name>string</name></submit></return></enqueue></soap:body></soap:envelope> 
/**
         * Queues an job for later execution.
         * 
         * @param JobData $indata The input data.
         * @return QueuedJob
         */
Method [ <user> public method enqueue ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 118 - 121

  - Parameters [1] {
    Parameter #0 [ <required> Batchelor\WebService\Types\JobData $indata ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'indata',
      'type' => 'JobData',
      'repeat' => '1',
      'docs' => 'The input data.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'QueuedJob',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'documentation' => 'Queues an job for later execution.
          
          @param JobData indata The input data.
          @return QueuedJob',
)
MessageResponseSourceDetails

Method:

booldequeue(JobIdentityjob)
Dequeues an already existing job.

Parameters:

job
The job identity.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><dequeue><job><jobid>string</jobid><result>string</result></job></dequeue></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><dequeue><return>bool</return></dequeue></soap:body></soap:envelope> 
/**
         * Dequeues an already existing job.
         * 
         * @param JobIdentity $job The job identity.
         * @return bool
         */
Method [ <user> public method dequeue ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 129 - 132

  - Parameters [1] {
    Parameter #0 [ <required> Batchelor\WebService\Types\JobIdentity $job ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'job',
      'type' => 'JobIdentity',
      'repeat' => '1',
      'docs' => 'The job identity.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'bool',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'documentation' => 'Dequeues an already existing job.
          
          @param JobIdentity job The job identity.
          @return bool',
)
MessageResponseSourceDetails

Method:

boolsuspend(JobIdentityjob)
Suspend (pause) an already running job.

Parameters:

job
The job identity.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><suspend><job><jobid>string</jobid><result>string</result></job></suspend></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><suspend><return>bool</return></suspend></soap:body></soap:envelope> 
/**
         * Suspend (pause) an already running job.
         * @param JobIdentity $job The job identity.
         * @return bool
         */
Method [ <user> public method suspend ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 139 - 142

  - Parameters [1] {
    Parameter #0 [ <required> Batchelor\WebService\Types\JobIdentity $job ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'job',
      'type' => 'JobIdentity',
      'repeat' => '1',
      'docs' => 'The job identity.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'bool',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'documentation' => 'Suspend (pause) an already running job.
          @param JobIdentity job The job identity.
          @return bool',
)
MessageResponseSourceDetails

Method:

boolresume(JobIdentityjob)
Resume (continue) an already suspended job.

Parameters:

job
The job identity.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><resume><job><jobid>string</jobid><result>string</result></job></resume></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><resume><return>bool</return></resume></soap:body></soap:envelope> 
/**
         * Resume (continue) an already suspended job.
         * @param JobIdentity $job The job identity.
         * @return bool
         */
Method [ <user> public method resume ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 149 - 152

  - Parameters [1] {
    Parameter #0 [ <required> Batchelor\WebService\Types\JobIdentity $job ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'job',
      'type' => 'JobIdentity',
      'repeat' => '1',
      'docs' => 'The job identity.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'bool',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'documentation' => 'Resume (continue) an already suspended job.
          @param JobIdentity job The job identity.
          @return bool',
)
MessageResponseSourceDetails

Method:

JobStatusstat(JobIdentityjob)
Get status for single job.

Parameters:

job
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><stat><job><jobid>string</jobid><result>string</result></job></stat></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><stat><return><queued><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></queued><started><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></started><finished><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></finished><state><value>string</value></state></return></stat></soap:body></soap:envelope> 
/**
         * Get status for single job.
         * 
         * @param JobIdentity $job
         * @return JobStatus
         */
Method [ <user> public method stat ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 160 - 163

  - Parameters [1] {
    Parameter #0 [ <required> Batchelor\WebService\Types\JobIdentity $job ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'job',
      'type' => 'JobIdentity',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'JobStatus',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'documentation' => 'Get status for single job.
          
          @param JobIdentity job
          @return JobStatus',
)
MessageResponseSourceDetails

Method:

QueuedJob[]watch(intstamp)
Get an list of jobs enqueued after the given timestamp.

Parameters:

stamp
The UNIX timestamp.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><watch><stamp>int</stamp></watch></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><watch><return><identity><jobid>string</jobid><result>string</result></identity><status><queued><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></queued><started><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></started><finished><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></finished><state><value>string</value></state></status><submit><task>string</task><name>string</name></submit></return></watch></soap:body></soap:envelope> 
/**
         * Get an list of jobs enqueued after the given timestamp.
         * 
         * @param int $stamp The UNIX timestamp.
         * @return QueuedJob[]
         */
Method [ <user> public method watch ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 171 - 174

  - Parameters [1] {
    Parameter #0 [ <required> int $stamp ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'stamp',
      'type' => 'int',
      'repeat' => '1',
      'docs' => 'The UNIX timestamp.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'QueuedJob',
      'repeat' => 'unbounded',
      'docs' => '',
    ),
  ),
  'documentation' => 'Get an list of jobs enqueued after the given timestamp.
          
          @param int stamp The UNIX timestamp.
          @return QueuedJob[]',
)
MessageResponseSourceDetails

Method:

JobIdentity[]opendir(void)
List all queued jobs.
Call this method to return a list of all jobs in the current selected batch queue.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><opendir/></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><opendir><return><jobid>string</jobid><result>string</result></return></opendir></soap:body></soap:envelope> 
/**
         * List all queued jobs.
         * 
         * Call this method to return a list of all jobs in the current selected 
         * batch queue.
         * 
         * @return JobIdentity[]
         */
Method [ <user> public method opendir ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 184 - 187
}

array (
  'input' => 
  array (
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'JobIdentity',
      'repeat' => 'unbounded',
      'docs' => '',
    ),
  ),
  'documentation' => 'List all queued jobs.
          
          Call this method to return a list of all jobs in the current selected 
          batch queue.
          
          @return JobIdentity[]',
)
MessageResponseSourceDetails

Method:

File[]readdir(JobIdentityjob)
List files and directories in job directory.
Get a list of all files and directories in the job directory associated with the job identity object.

Parameters:

job
The job identity.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><readdir><job><jobid>string</jobid><result>string</result></job></readdir></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><readdir><return><name>string</name><size>int</size><mime>string</mime><type>string</type><lang>string</lang></return></readdir></soap:body></soap:envelope> 
/**
         * List files and directories in job directory.
         * 
         * Get a list of all files and directories in the job directory associated 
         * with the job identity object.
         * 
         * @param JobIdentity $job The job identity.
         * @return File[]
         */
Method [ <user> public method readdir ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 198 - 201

  - Parameters [1] {
    Parameter #0 [ <required> Batchelor\WebService\Types\JobIdentity $job ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'job',
      'type' => 'JobIdentity',
      'repeat' => '1',
      'docs' => 'The job identity.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'File',
      'repeat' => 'unbounded',
      'docs' => '',
    ),
  ),
  'documentation' => 'List files and directories in job directory.
          
          Get a list of all files and directories in the job directory associated 
          with the job identity object.
          
          @param JobIdentity job The job identity.
          @return File[]',
)
MessageResponseSourceDetails

Method:

stringfopen(JobIdentityjob, stringfile)
Read file content.
Opens the given file from the job directory associated with the job identity object and return its content.

Parameters:

job
The job identity.
file
The filename.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><fopen><job><jobid>string</jobid><result>string</result></job><file>string</file></fopen></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><fopen><return>string</return></fopen></soap:body></soap:envelope> 
/**
         * Read file content.
         * 
         * Opens the given file from the job directory associated with the job 
         * identity object and return its content.
         * 
         * @param JobIdentity $job The job identity.
         * @param string $file The filename.
         * @return string
         */
Method [ <user> public method fopen ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 213 - 216

  - Parameters [2] {
    Parameter #0 [ <required> Batchelor\WebService\Types\JobIdentity $job ]
    Parameter #1 [ <required> string $file ]
  }
}

array (
  'input' => 
  array (
    0 => 
    array (
      'name' => 'job',
      'type' => 'JobIdentity',
      'repeat' => '1',
      'docs' => 'The job identity.',
    ),
    1 => 
    array (
      'name' => 'file',
      'type' => 'string',
      'repeat' => '1',
      'docs' => 'The filename.',
    ),
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'string',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'documentation' => 'Read file content.
          
          Opens the given file from the job directory associated with the job 
          identity object and return its content.
          
          @param JobIdentity job The job identity.
          @param string file The filename.
          @return string',
)
MessageResponseSourceDetails

Method:

stringversion(void)
Get API version.
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><version/></soap:body></soap:envelope>
<?xml version="1.0" encoding="utf-8"?> <soap:envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope/" soap:encodingStyle="http://www.w3.org/2003/05/soap-encoding"><soap:body xmlns="https://nowise.se/schemas/batchelor/soap?ver=2.0"><version><return>string</return></version></soap:body></soap:envelope> 
/**
         * Get API version.
         * @return string
         */
Method [ <user> public method version ] {
  @@ /var/www/localhost/apps/alvadesc/vendor/nowise/batchelor/source/Batchelor/WebService/Handler/SoapServiceHandler.php 222 - 225
}

array (
  'input' => 
  array (
  ),
  'output' => 
  array (
    0 => 
    array (
      'name' => 'return',
      'type' => 'string',
      'repeat' => '1',
      'docs' => '',
    ),
  ),
  'documentation' => 'Get API version.
          @return string',
)

Types

SerializedDetails

QueuedJob

JobIdentity identity
The job identity.
JobStatus status
The job status.
JobSubmit submit
The submitted job.
<?xml version="1.0" encoding="utf-8"?> <queuedjob><identity><jobid>string</jobid><result>string</result></identity><status><queued><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></queued><started><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></started><finished><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></finished><state><value>string</value></state></status><submit><task>string</task><name>string</name></submit></queuedjob> 
array (
  0 => 
  array (
    'name' => 'identity',
    'type' => 'JobIdentity',
    'docs' => 'The job identity.',
  ),
  1 => 
  array (
    'name' => 'status',
    'type' => 'JobStatus',
    'docs' => 'The job status.',
  ),
  2 => 
  array (
    'name' => 'submit',
    'type' => 'JobSubmit',
    'docs' => 'The submitted job.',
  ),
)
SerializedDetails

JobIdentity

string jobid
The job identity.
string result
The root directory.
<?xml version="1.0" encoding="utf-8"?> <jobidentity><jobid>string</jobid><result>string</result></jobidentity> 
array (
  0 => 
  array (
    'name' => 'jobid',
    'type' => 'string',
    'docs' => 'The job identity.',
  ),
  1 => 
  array (
    'name' => 'result',
    'type' => 'string',
    'docs' => 'The root directory.',
  ),
)
SerializedDetails

JobStatus

DateTime queued
When job was queued.
DateTime started
When job was started.
DateTime finished
When job was finished.
JobState state
The job state.
<?xml version="1.0" encoding="utf-8"?> <jobstatus><queued><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></queued><started><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></started><finished><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></finished><state><value>string</value></state></jobstatus> 
array (
  0 => 
  array (
    'name' => 'queued',
    'type' => 'DateTime',
    'docs' => 'When job was queued.',
  ),
  1 => 
  array (
    'name' => 'started',
    'type' => 'DateTime',
    'docs' => 'When job was started.',
  ),
  2 => 
  array (
    'name' => 'finished',
    'type' => 'DateTime',
    'docs' => 'When job was finished.',
  ),
  3 => 
  array (
    'name' => 'state',
    'type' => 'JobState',
    'docs' => 'The job state.',
  ),
)
SerializedDetails

DateTime

string date
The datetime string.
int timezone_type
The timezone type (i.e. 3).
string timezone
The timezone.
<?xml version="1.0" encoding="utf-8"?> <datetime><date>string</date><timezone_type>int</timezone_type><timezone>string</timezone></datetime> 
array (
  0 => 
  array (
    'name' => 'date',
    'type' => 'string',
    'docs' => 'The datetime string.',
  ),
  1 => 
  array (
    'name' => 'timezone_type',
    'type' => 'int',
    'docs' => 'The timezone type (i.e. 3).',
  ),
  2 => 
  array (
    'name' => 'timezone',
    'type' => 'string',
    'docs' => 'The timezone.',
  ),
)
SerializedDetails

JobState

string value
The enum value.
<?xml version="1.0" encoding="utf-8"?> <jobstate><value>string</value></jobstate> 
array (
  0 => 
  array (
    'name' => 'value',
    'type' => 'string',
    'docs' => 'The enum value.',
  ),
)
SerializedDetails

JobSubmit

string task
The task name.
string name
The optional job name.
<?xml version="1.0" encoding="utf-8"?> <jobsubmit><task>string</task><name>string</name></jobsubmit> 
array (
  0 => 
  array (
    'name' => 'task',
    'type' => 'string',
    'docs' => 'The task name.',
  ),
  1 => 
  array (
    'name' => 'name',
    'type' => 'string',
    'docs' => 'The optional job name.',
  ),
)
SerializedDetails

JobData

string data
The job data (plain data, file path or an URL).
string type
The data type (either "data", "file", "pipe" or "url").
string task
The task processor.
string name
Optional name for job.
<?xml version="1.0" encoding="utf-8"?> <jobdata><data>string</data><type>string</type><task>string</task><name>string</name></jobdata> 
array (
  0 => 
  array (
    'name' => 'data',
    'type' => 'string',
    'docs' => 'The job data (plain data, file path or an URL).',
  ),
  1 => 
  array (
    'name' => 'type',
    'type' => 'string',
    'docs' => 'The data type (either "data", "file", "pipe" or "url").',
  ),
  2 => 
  array (
    'name' => 'task',
    'type' => 'string',
    'docs' => 'The task processor.',
  ),
  3 => 
  array (
    'name' => 'name',
    'type' => 'string',
    'docs' => 'Optional name for job.',
  ),
)
SerializedDetails

File

string name
The file name.
int size
The file size in bytes.
string mime
The MIME type.
string type
The file type (dir, file or link).
string lang
The source code language.
<?xml version="1.0" encoding="utf-8"?> <file><name>string</name><size>int</size><mime>string</mime><type>string</type><lang>string</lang></file> 
array (
  0 => 
  array (
    'name' => 'name',
    'type' => 'string',
    'docs' => 'The file name.',
  ),
  1 => 
  array (
    'name' => 'size',
    'type' => 'int',
    'docs' => 'The file size in bytes.',
  ),
  2 => 
  array (
    'name' => 'mime',
    'type' => 'string',
    'docs' => 'The MIME type.',
  ),
  3 => 
  array (
    'name' => 'type',
    'type' => 'string',
    'docs' => 'The file type (dir, file or link).',
  ),
  4 => 
  array (
    'name' => 'lang',
    'type' => 'string',
    'docs' => 'The source code language.',
  ),
)