Users are accessed via /api/user.
See "Object Properties" in Introduction for basic shared properties.
Complete details in UserProperties. Here are some of the more commonly used properties:
Another unique way of identifying a user. However, this can be changed by an admin or the user himself.
The name that this user goes by in the real world. Example: Andy Dufresne
An email address associated with this user.
See "Relationships" in Introduction for how to use them.
APIKeys the user has generated.
Badges the user controls.
CashDrawers the user controls.
ConventionCarts the user controls.
ConventionReceipts the user controls.
EventReservationss for this user.
A list of Groups this user controls.
Game Librarys this user controls.
EventSubmissions the user has submitted.
EventWaits the user has requested.
Exhibitor applications this user has submitted.
Prototypes the user has expressed interest in.
Librarys that this user controls.
LibraryGameCheckouts that this user has made.
The PlayToWins associated with this user, if any.
The list of PrototypeInterest relationship managers.
The list of Prototypes the user has submitted.
EventSubmissionReservations for this user.
The SupplyOrders made by this user.
The Volunteer applications made by this user. Note that this is across conventions. A user can have only one volunteer application per convention.
The services used to fetch and manipulate users.
PUT /api/user/xxx
Can only be done by an admin or the user itself.
Returns:
{
"id" : "xxx",
"username" : "andy",
...
}
DELETE /api/user/xxx
Can only be done by an admin or the user itself.
Returns:
{
"success" : 1
}
GET /api/user/xxx
Can only be done by an admin or the user itself.
Returns:
{
"id" : "xxx",
"username" : "andy",
...
}
Searching across all users is no longer supported.
GET /api/user/xxx/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.
Can only be done by an admin or the user itself.
Returns:
{
"items" : [
{
"id" : "xxx",
"name" : "Supa-Con Extra Wow",
...
},
...
],
"paging" : {...}
}
GET /api/user/xxx/conventions-helping
A list of Conventions that this user is helping. Helping is defined as being an EventHost or convention Volunteer.
Can only be done by an admin or the user itself.
Returns:
{
"items" : [
{
"id" : "xxx",
"name" : "Supa-Con Extra Wow",
...
},
...
],
"paging" : {...}
}
GET /api/user/xxx/events-hosted
The list of Events this user is listed as a host of. Hosted events can be seen by the user in question, a TTE friend of the user, or a convention organizer if a convention_id is passed.
Pass a convention_id to see a user's hosted events for a specific convention. The session user must have the scheduling privilege to see them.
Can be 1 (scheduled) or 0 (not scheduled).
Returns:
{
"items" : [
{
"id" : "xxx",
"event_number" : "xxx",
"name" : "Nice Event",
...
},
...
],
"paging" : {...}
}
GET /api/user/xxx/events-reserved
The list of Events this user has a reservation for. Event reservations can be seen by the user in question, or a convention organizer if a convention_id is passed.
Pass a convention_id to see a user's event reservations for a specific convention. The session user must have the scheduling privilege to see them.
Returns:
{
"items" : [
{
"id" : "xxx",
"event_number" : "xxx",
"name" : "Nice Event",
...
},
...
],
"paging" : {...}
}