POST api/admin/login

Get users from system

Request Information

URI Parameters

None.

Body Parameters

YSHAdminUserDataModel
NameDescriptionTypeAdditional information
user_uid

integer

None.

user_login_id

string

Required

String length: inclusive between 0 and 45

user_password

string

String length: inclusive between 0 and 1024

user_phone_cc

string

String length: inclusive between 0 and 5

user_phone

string

String length: inclusive between 0 and 45

user_email

string

String length: inclusive between 0 and 1024

user_verify_code

string

String length: inclusive between 0 and 6

verify_code_last_update_date

date

None.

user_verified

boolean

None.

verified_date

date

None.

need_reset_password

boolean

None.

reset_password_token

string

None.

user_lang

integer

None.

user_loc

integer

None.

user_create_date

date

None.

user_last_update_date

date

None.

user_last_login_date

date

None.

application_uid

integer

None.

disabled

boolean

None.

enable_notification

boolean

None.

PushTokens

Collection of GCSPushDataModel

None.

Request Formats

application/json, text/json

Sample:
{
  "user_uid": 1,
  "user_login_id": "sample string 2",
  "user_password": "sample string 3",
  "user_phone_cc": "sample string 4",
  "user_phone": "sample string 5",
  "user_email": "sample string 6",
  "user_verify_code": "sample string 7",
  "verify_code_last_update_date": "2018-01-22T17:27:56.5601479+08:00",
  "user_verified": true,
  "verified_date": "2018-01-22T17:27:56.5601479+08:00",
  "need_reset_password": true,
  "reset_password_token": "sample string 10",
  "user_lang": 11,
  "user_loc": 12,
  "user_create_date": "2018-01-22T17:27:56.5601479+08:00",
  "user_last_update_date": "2018-01-22T17:27:56.5601479+08:00",
  "user_last_login_date": "2018-01-22T17:27:56.5601479+08:00",
  "application_uid": 15,
  "disabled": true,
  "enable_notification": true,
  "PushTokens": [
    {
      "push_uid": 1,
      "user_uid": 1,
      "push_token": "sample string 2",
      "push_token_type": 3,
      "push_token_create_date": "2018-01-22T17:27:56.5601479+08:00",
      "push_token_last_update_date": "2018-01-22T17:27:56.5601479+08:00",
      "push_token_status": 6,
      "application_uid": 7,
      "User": {
        "user_uid": 1,
        "user_login_id": "sample string 2",
        "user_password": "sample string 3",
        "user_phone_cc": "sample string 4",
        "user_phone": "sample string 5",
        "user_email": "sample string 6",
        "user_verify_code": "sample string 7",
        "verify_code_last_update_date": "2018-01-22T17:27:56.5601479+08:00",
        "user_verified": true,
        "verified_date": "2018-01-22T17:27:56.5601479+08:00",
        "need_reset_password": true,
        "reset_password_token": "sample string 10",
        "user_lang": 11,
        "user_loc": 12,
        "user_create_date": "2018-01-22T17:27:56.5601479+08:00",
        "user_last_update_date": "2018-01-22T17:27:56.5601479+08:00",
        "user_last_login_date": "2018-01-22T17:27:56.5601479+08:00",
        "application_uid": 15,
        "disabled": true,
        "enable_notification": true,
        "PushTokens": []
      }
    },
    {
      "push_uid": 1,
      "user_uid": 1,
      "push_token": "sample string 2",
      "push_token_type": 3,
      "push_token_create_date": "2018-01-22T17:27:56.5601479+08:00",
      "push_token_last_update_date": "2018-01-22T17:27:56.5601479+08:00",
      "push_token_status": 6,
      "application_uid": 7,
      "User": {
        "user_uid": 1,
        "user_login_id": "sample string 2",
        "user_password": "sample string 3",
        "user_phone_cc": "sample string 4",
        "user_phone": "sample string 5",
        "user_email": "sample string 6",
        "user_verify_code": "sample string 7",
        "verify_code_last_update_date": "2018-01-22T17:27:56.5601479+08:00",
        "user_verified": true,
        "verified_date": "2018-01-22T17:27:56.5601479+08:00",
        "need_reset_password": true,
        "reset_password_token": "sample string 10",
        "user_lang": 11,
        "user_loc": 12,
        "user_create_date": "2018-01-22T17:27:56.5601479+08:00",
        "user_last_update_date": "2018-01-22T17:27:56.5601479+08:00",
        "user_last_login_date": "2018-01-22T17:27:56.5601479+08:00",
        "application_uid": 15,
        "disabled": true,
        "enable_notification": true,
        "PushTokens": []
      }
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'YSHAdminUserDataModel'.

Response Information

Resource Description

a list of users with basic info

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.