Class: Api::V2::UserResource

Inherits:
BaseResource
  • Object
show all
Defined in:
app/resources/api/v2/user_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:

This resource is immutable: its endpoint will not accept POST, PATCH, or DELETE requests.

Note:

Access this resource via the /api/v2/users/ endpoint.

Provides a JSON:API representation of User.

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from BaseResource

apply_includes, creatable_fields, default_includes, #fetchable_fields, inclusions, resolve_relationship_names_to_relations, updatable_fields

Instance Attribute Details

#first_name ⇒ String (readonly)

Returns the user’s first/given name.

Returns:

  • (String) —

    the user’s first/given name.



34
 
# File 'app/resources/api/v2/user_resource.rb', line 34

attribute :first_name, readonly: true

#last_name ⇒ String (readonly)

Returns the user’s last/surname.

Returns:

  • (String) —

    the user’s last/surname.



38
 
# File 'app/resources/api/v2/user_resource.rb', line 38

attribute :last_name, readonly: true

#login ⇒ String (readonly)

Returns the user’s login identifier.

Returns:

  • (String) —

    the user’s login identifier.



30
 
# File 'app/resources/api/v2/user_resource.rb', line 30

attribute :login, readonly: true

#uuid ⇒ Object (readonly)

A filter to return only users with the given UUID.



26
 
# File 'app/resources/api/v2/user_resource.rb', line 26

attribute :uuid, readonly: true

Instance Method Details

#user_code ⇒ Object

A filter to return only users with the given user code. The given user code will be compared with the swipecodes and barcodes for users until matches are found.



47
 
# File 'app/resources/api/v2/user_resource.rb', line 47

filter :user_code, apply: lambda { |records, value, _options| records.with_user_code(*value) }