On this page:

• /users resource
  • Endpoint
  • Properties
  • Actions by method
    • GET
    • POST
    • PUT
    • PATCH
    • DELETE

/users resource

The /users resource lets you add a new user, update all or part of an existing user, list all users, list a user by its ID, or delete an existing user by its ID. Users represent the whale watching enthusiasts who report orca sightings.

Also see /sightings resource.

Endpoint

{base_url}/users

Also see Base URL.

Properties

Shows an example of a full /users resource:

{
    "last_name": "Marsh",
    "first_name": "Stan",
    "email": "stan.marsh@gmail.com",
    "id": 1
}

Describes all properties available in the /users resource:

Property	Type	Description	Example
last_name	string	The user’s last name.	"Marsh"
first_name	string	The user’s first name.	"Stan"
email	string	The user’s email address. Must be unique.	"stan.marsh@gmail.com"
id	integer	Unique identifier for the user. Read-only, automatically generated.	1

Actions by method

GET

• Get all users
• Get an existing user by ID

POST

• Create a new user

PUT

• Update an existing user’s information

PATCH

• Update part of an existing user’s information

DELETE

• Delete a user by ID