Users

>>>

GET /api/v1/users/:id/list_fave_locations.json
Fetch list of favorite locations

Fetch list of favorite locations

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
>>>

GET /api/v1/users/total_user_count.json
Fetch total count of users

Fetch total count of users

Supported Formats

json
>>>

POST /api/v1/users/:id/add_fave_location.json
Adds a location to your fave list

Adds a location to your fave list

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
location_id
required

ID of location to add

Validations:

  • Must be a Integer
>>>

POST /api/v1/users/:id/remove_fave_location.json
Removes a location from your fave list

Removes a location from your fave list

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
location_id
required

ID of location to remove

Validations:

  • Must be a Integer
>>>

GET /api/v1/users/auth_details.json
Fetch auth info for a user

This info includes the user’s API token.

Params

Param name Description
login
required

User’s username or email address

Validations:

  • Must be a String
password
required

User’s password

Validations:

  • Must be a String
>>>

POST /api/v1/users/forgot_password.json
Password retrieval

Reset a forgotten password

Params

Param name Description
identification
required

A username or email address

Validations:

  • Must be a String
>>>

POST /api/v1/users/resend_confirmation.json
Resend confirmation

Resend an account confirmation

Params

Param name Description
identification
required

A username or email address

Validations:

  • Must be a String
>>>

POST /api/v1/users/signup.json
Signup a new user

Signup a new user for the PBM

Params

Param name Description
username
required

New username

Validations:

  • Must be a String
email
required

New email address

Validations:

  • Must be a String
password
required

New password

Validations:

  • Must be a String
confirm_password
required

New password confirmation

Validations:

  • Must be a String
>>>

GET /api/v1/users/:id/profile_info.json
Fetch profile info for a user

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
>>>

POST /api/v1/users/:id/update_user_flag
Set a country or U.S. flag icon for your user

Supported Formats

json

Params

Param name Description
id
required

ID of user

Validations:

  • Must be a Integer
user_flag
optional

ISO code for flag

Validations:

  • Must be a String