Class: V1::PrinterResource

Inherits:
JSONAPI::Resource
  • Object
show all
Defined in:
app/resources/v1/printer_resource.rb

Overview

Note:

Access this resource via the /v1/printer_types endpoint.

Provides a JSON:API representation of Printer

For more information about JSON:API see the JSON:API Specifications or look at the JSONAPI::Resources package for the service implementation of the JSON:API standard.

Filters: * name * labware_type * active

Examples:

curl -X GET http://localhost:3100/v1/printers/1
curl -X GET http://localhost:3100/v1/printers/
curl -X GET "http://localhost:3100/v1/printers?filter[name]=printer_name"
curl -X GET "http://localhost:3100/v1/printers?filter[labware_type]=tube_rack_24"
curl -X GET "http://localhost:3100/v1/printers?filter[active]=true"

Instance Attribute Summary collapse

Instance Attribute Details

#active? ⇒ Boolean

Returns the active status of the printer.

Returns:

  • (Boolean) —

    the active status of the printer



40
 
# File 'app/resources/v1/printer_resource.rb', line 40

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#created_at ⇒ String

Returns the timestamp when the printer was created.

Returns:

  • (String) —

    the timestamp when the printer was created



40
 
# File 'app/resources/v1/printer_resource.rb', line 40

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#deactivated_at ⇒ DateTime?

Returns the timestamp when printer was deactivated, or nil if it is active.

Returns:

  • (DateTime, nil) —

    the timestamp when printer was deactivated, or nil if it is active



40
 
# File 'app/resources/v1/printer_resource.rb', line 40

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#labware_type ⇒ String

Returns the type of labware the printer handles.

Returns:

  • (String) —

    the type of labware the printer handles



40
 
# File 'app/resources/v1/printer_resource.rb', line 40

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#name ⇒ String

Returns the name of the printer.

Returns:

  • (String) —

    the name of the printer



40
 
# File 'app/resources/v1/printer_resource.rb', line 40

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at

#updated_at ⇒ String

Returns the timestamp when the printer was last updated.

Returns:

  • (String) —

    the timestamp when the printer was last updated



40
 
# File 'app/resources/v1/printer_resource.rb', line 40

attributes :name, :labware_type, :active?, :created_at, :updated_at, :deactivated_at