User

Users are accessed via /api/user.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in UserProperties. Here are some of the more commonly used properties:

username

Another unique way of identifying a user. However, this can be changed by an admin or the user himself.

real_name

The name that this user goes by in the real world. Example: Andy Dufresne

email

An email address associated with this user.S

Relationships

See "Relationships" in Introduction for how to use them.

apikeys

APIKeys the user has generated.

badges

Badges the user controls.

Queryable
name
badge_number
Qualifiers
convention_id
verified

cashdrawers

CashDrawers the user controls.

conventioncarts

ConventionCarts the user controls.

conventionreceipts

ConventionReceipts the user controls.

Queryable
order_number

conventions_running

A list of Conventions that this user is running. Running is defined as having some level of privilege over either through the ConventionPrivileges system or by the Group that is in charge of the convention.

events

Events this user is listed as the host of.

groups

A list of Groups this user controls.

libraries

Game Librarys this user controls.

Queryable
name
event_number
Qualifiers
convention_id
is_scheduled

eventsubmissions

EventSubmissions the user has submitted.

Queryable
name
Qualifiers
convention_id

eventwaits

EventWaits the user has requested.

exhibitors

Exhibitor applications this user has submitted.

interestedprototypes

Prototypes the user has expressed interest in.

Queryable
prototype.name
prototype.synopsis
prototype.description
Qualifiers
prototype.convention_id

libraries

Librarys that this user controls.

librarygamecheckouts

LibraryGameCheckouts that this user has made.

playtowins

The PlayToWins associated with this user, if any.

prototypeinterests

The list of PrototypeInterest relationship managers.

prototypes

The list of Prototypes the user has submitted.

Services

The services used to fetch and manipulate users.

Update User

 PUT /api/user/xxx

Can only be done by an admin or the user itself.

Returns:

 {
   "id" : "xxx",
   "username" : "andy",
   ...
 }

Delete User

 DELETE /api/user/xxx

Can only be done by an admin or the user itself.

Returns:

 {
   "success" : 1
 }

Read User

 GET /api/user/xxx

Can by done by anybody.

Returns:

 {
   "id" : "xxx",
   "username" : "andy",
   ...
 }

Search Users

 GET /api/user
query

A partial username or email address.

Returns:

 {
    "items" : [
        {
            "id" : "xxx",
            "display_name" : "Andy",
            ...
        },
        ...
    ],
    "paging" : {...}
 }