Class: V1::SampleResource

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

Overview

TODO:

This documentation does not yet include a detailed description of what this resource represents.

TODO:

This documentation does not yet include detailed descriptions for relationships, attributes and filters.

TODO:

This documentation does not yet include any example usage of the API via cURL or similar.

Note:

Access this resource via the /v1/samples endpoint.

Provides a JSON:API representation of Sample and exposes valid request for use by the UI.

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.

Instance Attribute Summary collapse

Instance Attribute Details

#accession_number ⇒ String

Returns the accession number.

Returns:

  • (String) —

    the accession number



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#country_of_origin ⇒ String

Returns the country of origin.

Returns:

  • (String) —

    the country of origin



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#created_at ⇒ String

Returns the creation date of the sample in US format.

Returns:

  • (String) —

    the creation date of the sample in US format



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#date_of_sample_collection ⇒ String

Returns the date of sample collection.

Returns:

  • (String) —

    the date of sample collection



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#deactivated_at ⇒ String?

Returns the deactivation date of the sample in US format; nil if not deactivated.

Returns:

  • (String, nil) —

    the deactivation date of the sample in US format; nil if not deactivated



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#donor_id ⇒ String

Returns the donor ID.

Returns:

  • (String) —

    the donor ID



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#external_id ⇒ String

Returns the external ID of the sample.

Returns:

  • (String) —

    the external ID of the sample



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#name ⇒ String

Returns the name of the sample.

Returns:

  • (String) —

    the name of the sample



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#sanger_sample_id ⇒ String

Returns the Sanger sample ID.

Returns:

  • (String) —

    the Sanger sample ID



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#species ⇒ String

Returns the species of the sample.

Returns:

  • (String) —

    the species of the sample



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#supplier_name ⇒ String

Returns the name of the supplier.

Returns:

  • (String) —

    the name of the supplier



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at

#taxon_id ⇒ String

Returns the taxon ID.

Returns:

  • (String) —

    the taxon ID



42
 
# File 'app/resources/v1/sample_resource.rb', line 42

attributes :name, :external_id, :species, :created_at, :deactivated_at