Required role: | API |
All Verbs | /api/Query/User |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Skip | form | int? | No | |
Take | form | int? | No | |
OrderBy | form | string | No | |
OrderByDesc | form | string | No | |
Include | form | string | No | |
Fields | form | string | No | |
Meta | form | Dictionary<string, string> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UserId | form | int | No | |
UserName | form | string | No | |
Name | form | string | No | |
form | string | No | ||
MobilePhone | form | string | No | |
Enabled | form | bool | No | |
LastLogin | form | DateTime? | No | |
Created | form | DateTime | No | |
Training | form | bool | No | |
Deleted | form | bool | No | |
CoursesCompleted | form | int | No | |
DisplayHomeNotification | form | bool? | No | |
TwoFactorEnabled | form | bool | No | |
EmailConfirmed | form | bool | No | |
MobilePhoneConfirmed | form | bool | No | |
Notifications | form | bool | No | |
ChangePassword | form | DateTime? | No | |
Activated | form | DateTime? | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Offset | form | int | No | |
Total | form | int | No | |
Results | form | List<T> | No | |
Meta | form | Dictionary<string, string> | No | |
ResponseStatus | form | ResponseStatus | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /api/Query/User HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Skip: 0,
Take: 0,
OrderBy: String,
OrderByDesc: String,
Include: String,
Fields: String,
Meta:
{
String: String
}
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { Offset: 0, Total: 0, Results: [ { UserId: 0, UserName: String, Name: String, Email: String, MobilePhone: String, Enabled: False, LastLogin: 0001-01-01, Created: 0001-01-01, Training: False, Deleted: False, CoursesCompleted: 0, DisplayHomeNotification: False, TwoFactorEnabled: False, EmailConfirmed: False, MobilePhoneConfirmed: False, Notifications: False, ChangePassword: 0001-01-01, Activated: 0001-01-01 } ], Meta: { String: String }, ResponseStatus: { ErrorCode: String, Message: String, StackTrace: String, Errors: [ { ErrorCode: String, FieldName: String, Message: String, Meta: { String: String } } ], Meta: { String: String } } }