Stop printers

This Web service requests that Ricoh ProcessDirector stop the printer object. The service must indicate when to stop the printer–before the current job is complete or after.

HTTP method

POST

URI

/aiwservices/v1/printer/ID1;ID2;ID3;…

Request headers

ippdcredential

<credential token="value" />

Accept-Language (optional)

lang

Supported language values:

de German
en US English (default)
es Spanish
fr French
it Italian
ja Japanese
pt_BR Brazilian Portuguese

Query variables

The action variable must be included. The when and NPRO variables are not required. If they are not included, the system uses the default option.

action=stop

when

Indicates when the printer should stop relative to the job that is currently printing.

now (default)

Stop the printer as soon as possible, without completing the current print job.

afterCopy

For a multi-copy print job, stop the printer after the current copy of the print job is finished printing.

afterJob

Stop the printer after the current job is finished printing.

NPRO

Indicates whether the printer should do a non-process run out (NPRO) when it stops printing.
  • yes or true
  • no or false (default)

Return codes

  • 200 OK
  • 401 Unauthorized
  • 404 Not Found
  • 500 Internal Server Error
  • 501 Not Implemented

If one of the printers does not exist, a 404 Not Found error is returned and none of the printers are stopped. A 200 OK message indicates that the request has been accepted, code-executed, and no errors were encountered. It does not indicate the action is complete, but that the request is complete and successful, and no further status is forthcoming.

Examples

Sample request

Stop more than one printer.

http://hostname:15080/aiwservices/v1/printer/printer1;printer2?action=stop

 
Copyright © 2015, 2018