Skip to main content

2-3 Printer operations

Retrieve a list of printers

This API retrieves a list of printers.

Example 1. Endpoint URI
https://api.svfcloud.com/v1/printers


Example 2. HTTP method

GET



Example 3. Accept header for the HTTP request

application/json



Example 4. Parameters

  • Query parameter

    Query parameter

    Value

    Required

    Description

    registerable

    Printers that can be registered (true or false)

    By default, a list of registered printers is retrieved.

    • true

      Retrieves a list of unregistered printers.

    • false

      Retrieves a list of registered printers.

    agent

    Agent ID

    Specify this parameter to retrieve a list of printers that belong to a specific agent.

  • Request header

    Header field

    Value

    Description

    Authorization

    Bearer {your access token}

    Specify the access token retrieved via authentication.



Response

Code

Description

HTTP/1.1 200 OK

Indicates that the process was executed successfully.

HTTP/1.1 400 Bad Request

Occurs if the request content is invalid.

HTTP/1.1 401 Unauthorized

Occurs if the authentication information is invalid.

HTTP/1.1 429 Too many Requests

Occurs if the number of API calls exceeds the threshold. Execute again after the number of seconds passed for the value returned in "Retry-After" of the response header.

Example 5. Output example (JSON format)
[
　{
　　"id":"1a103817-d55a-46a9-8364-bc534b8aa933",
　　"segment":"",
　　"key":"23759108FCDD2B93EE4353105F69937B9CF8B44C",
　　"stateUpdated":"2015-10-02T09:32:41.000Z",
　　"name":"LBP8730",
   "label": "TestPrinter_Canon",
　　"manufacturer":"Canon",
　　"reachable":true,
　　"ipAddress":"10.XX.XX.XX",
　　"description":"Canon LBP8730 /P",
　　"pdlList":[
　　　"ESCP",
　　　"LIPS4",
　　　"PDF"
　　],
　　"preferences":[
　　],
　　　"state":2
　},
　{
　　"id":"587d2416-94a6-4af3-a4ca-8f637bc75fe1",
　　"segment":"",
　　"key":"ED7054AB697F38EE330C9AE5F613DAD6AD1ED5A3",
　　"stateUpdated":"2015-10-03T17:29:27.000Z",
　　"name":"DocuCentre-IV C2270",
　　"label": "TestPrinter_FUJI",
　　"manufacturer":"FUJI XEROX",
　　"reachable":true,
　　"ipAddress":"10.XX.XX.XX",
　　"description":"FUJI XEROX DocuCentre-IV C2270;ESS1.0.42,IOT 41.3.0,IIT 2.21.1,ADF 7.9.0,FAX 1.1.14,SJFI3.0.13,SSMI1.12.3",
　　"pdlList":[
　　　"ART4",
　　　"EMF",
　　　"ESCP",
　　　"PDF"
　　],
　　"preferences":[
　　　{
　　　　"id":"587d2416-94a6-4af3-a4ca-8f637bc75fe1",
　　　　"name":"art4_1",
　　　　"manufacturer":"FUJI XEROX",
　　　　"lastmodified":"2015-10-02T07:54:59.000Z",
　　　　"pdl":"ART4",
　　　　"description":"",
　　　　"properties":[
　　　　　{
　　　　　　"name":"AdjustX",
　　　　　　"labelKey":"",
　　　　　　"value":"10.0",
　　　　　　"readOnly":false,
　　　　　　"hidden":false
　　　　　},
　　　　　{
　　　　　　"name":"AdjustY",
　　　　　　"labelKey":"",
　　　　　　"value":"10.0",
　　　　　　"readOnly":false,
　　　　　　"hidden":false
　　　　　}
　　　　]
　　　}
　　],
　　"state":12,
　　"localPrinter":{
　　　"name":"FX DocuCentre-IV C2270",
　　　"platform":"Windows",
　　　"manufacturer":"Fuji Xerox",
　　　"driverName":"FX DocuCentre-IV C2270",
　　　"paused":false
　　　"inputTrays":["Conform to printer settings","automatic","tray 1","tray 2","tray 3","tray 4","tray 5 (manual feed)"]
　　}
　}
]

Key

Content

Description

id

Printer ID or agent ID

If "true" was specified for the registerable parameter, this ID identifies the agent. If "false" was specified for the registerable parameter, this ID identifies the printer. When you perform Direct Print, specify this printer ID.

key

Printer key

The unique key assigned for managing the printer (actual printer).

stateUpdated

Status update date and time

The date and time at which the status was updated. Since the printer status is monitored periodically, the status will be updated when a change in status is detected during the periodic monitoring.

name

Printer name

The printer name retrieved from the printer.

label

Printer label

The label set arbitrarily for each printer. You can configure the settings on the Printer screen in SVF Cloud Manager.

manufacturer

Manufacturer

The manufacturer information retrieved from the printer.

reachable

Availability of network connection

Indicates whether the printer can be accessed via the network or not. For USB connection, this key is "false".

ipAddress

IP address

The IP address for the printer.

description

Remarks

The remarks information retrieved from the printer.

pdlList

PDL list

The PDL information retrieved from the printer.

preferences

Print settings

Information about the print settings that have been defined for the printer.

state

Status

Indicates the status of the printer. For details, see "Printer status" in "Appendix".

localPrinter

Local printer information

Information about the local printer.

inputTrays

Paper tray information

The paper tray information retrieved from the printer.

  • Any key items that are not included in the list are not currently used. They have been defined for future use.



Register printers

This API registers a printer with the specified printer key.

Example 6. Endpoint URI
https://api.svfcloud.com/v1/printers


Example 7. HTTP method

POST



Example 8. Content-type header for the HTTP request

application/x-www-form-urlencoded



Example 9. Parameters

  • Request body

    Request body data

    Value

    Required

    Description

    key

    Printer key

    maru.png

    Specify the key of the printer to register from the list of printers with provisional registration status.

  • Request header

    Header field

    Value

    Description

    Authorization

    Bearer {your access token}

    Specify the access token retrieved via authentication.



Response

Code

Description

HTTP/1.1 201 Created

Indicates that the printer was registered successfully. A URI that can be used for inquiring about information concerning the registered printer is returned in "Location" in the response header. The format for "Location" is as follows:

https://api.svfcloud.com/v1/printers/{printerId}

HTTP/1.1 400 Bad Request

Occurs if the request content is invalid.

HTTP/1.1 401 Unauthorized

Occurs if the authentication information is invalid.

HTTP/1.1 404 Not Found

Occurs if the specified key does not exist.

HTTP/1.1 409 Conflict

Occurs if registration of a registered printer (double registration) was attempted.

HTTP/1.1 429 Too many Requests

Occurs if the number of API calls exceeds the threshold. Execute again after the number of seconds passed for the value returned in "Retry-After" of the response header.

Retrieve printer information

This API retrieves information about the specified printer ID.

Example 10. Endpoint URI
https://api.svfcloud.com/v1/printers/{printerId}


Example 11. HTTP method

GET



Example 12. Accept header for the HTTP request

application/json



Example 13. Parameters

  • Path parameter

    Path parameter

    Value

    Required

    Description

    printerId

    Printer ID

    maru.png

    Specify the ID of the printer whose information is to be retrieved.

  • Request header

    Header field

    Value

    Description

    Authorization

    Bearer {your access token}

    Specify the access token retrieved via authentication.



Response

Code

Description

HTTP/1.1 200 OK

Indicates that the process was executed successfully.

HTTP/1.1 401 Unauthorized

Occurs if the authentication information is invalid.

HTTP/1.1 404 Not Found

Occurs if a printer with the specified ID does not exist.

HTTP/1.1 429 Too many Requests

Occurs if the number of API calls exceeds the threshold. Execute again after the number of seconds passed for the value returned in "Retry-After" of the response header.

Example 14. Output example (JSON format)
{
　"id":"1aaf7a8e-f805-428b-86a2-1dab0b7e9aab",
　"segment":"",
　"key":"02F557B32F6C6DCE5182473E94B7104B759B3871",
　"stateUpdated":"2015-10-01T11:44:10.000Z",
　"name":"IPSiO CX7200",
　"label": "TestPrinter_RICOH",
　"manufacturer":"RICOH",
　"reachable":true,
　"ipAddress":"10.XX.XX.XX",
　"description":"RICOH IPSiO CX7200 1.12 / RICOH Network Printer C model",
　"pdlList":[
　　"RPCS",
　],
　"preferences":[
　],
　"state":2
}

Key

Content

Description

id

Printer ID

The ID that identifies the printer. To specify the printer to use at the time of printing, specify this printer ID.

key

Printer key

The unique key assigned for managing the printer (actual printer).

stateUpdated

Status update date and time

The date and time at which the status was updated. Since the printer status is monitored periodically, the status will be updated when a change in status is detected during the periodic monitoring.

name

Printer name

The printer name retrieved from the printer.

label

Printer label

The label set arbitrarily for each printer. You can configure the settings on the Printer screen in SVF Cloud Manager.

manufacturer

Manufacturer

The manufacturer information retrieved from the printer.

reachable

Availability of network connection

Indicates whether the printer can be accessed via the network or not. For USB connection, this key is "false".

ipAddress

IP address

The IP address for the printer.

description

Remarks

The remarks information retrieved from the printer.

pdlList

PDL list

The PDL information retrieved from the printer.

preferences

Print settings

Information about the print settings that have been defined for the printer.

state

Status

Indicates the status of the printer. For details, see "Printer status" in "Appendix".

localPrinter

Local printer information

Information about the local printer.

  • Any key items that are not included in the list are not currently used. They have been defined for future use.



Unregister printers

This API unregisters a printer with the specified printer ID.

Example 15. Endpoint URI
https://api.svfcloud.com/v1/printers/{printerId}


Example 16. HTTP method

DELETE



Example 17. Parameters

  • Path parameter

    Path parameter

    Value

    Required

    Description

    printerId

    Printer ID

    maru.png

    Specify the ID for the printer to unregister.

  • Request header

    Header field

    Value

    Description

    Authorization

    Bearer {your access token}

    Specify the access token retrieved via authentication.



Response

Code

Description

HTTP/1.1 204 No Content

Indicates that the process was executed successfully.

HTTP/1.1 401 Unauthorized

Occurs if the authentication information is invalid.

HTTP/1.1 429 Too many Requests

Occurs if the number of API calls exceeds the threshold. Execute again after the number of seconds passed for the value returned in "Retry-After" of the response header.

In this section: