POST api/ExcellentSchool/Login
Login by user name and password
Request Information
Body Parameters
LoginModelName | Description | Type | Additional information |
---|---|---|---|
Name |
user [or IMEI] |
string |
None. |
Pass |
password |
string |
None. |
AppId |
APP Application Identifier |
string |
None. |
PushId | string |
None. |
|
FcmId | string |
None. |
|
Language |
User localism |
string |
None. |
LoginType |
Login type 0. stands user login |
integer |
None. |
Version | integer |
None. |
Request Formats
application/json, text/json
{ "Name": "sample string 1", "Pass": "sample string 2", "AppId": "sample string 3", "PushId": "sample string 4", "FcmId": "sample string 5", "Language": "sample string 6", "LoginType": 7, "Version": 8 }
application/xml, text/xml
<LoginModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewGPS2012.AppApi.Models.ParModel"> <AppId>sample string 3</AppId> <FcmId>sample string 5</FcmId> <Language>sample string 6</Language> <LoginType>7</LoginType> <Name>sample string 1</Name> <Pass>sample string 2</Pass> <PushId>sample string 4</PushId> <Version>8</Version> </LoginModel>
Response Information
Resource Description
State corresponding states
0. indicats that requestion is normal and correct return
1000. It means that the account doesn't exist
1007. Indicates that the mailbox is not activated [user login is valid, global configurable]
Name | Description | Type | Additional information |
---|---|---|---|
LoginType |
Login type 0. stands user login 1. stands device login |
integer |
None. |
AccessToken |
this access Token |
string |
None. |
Item |
correspondent entities ,when user logs in return User information,device information is returned when the device is logged in |
Object |
None. |
ThirdParty |
Third party login information [general user login only valid] |
Object |
None. |
WeChartAppId | string |
None. |
|
State |
status code |
integer |
None. |
Response Formats
application/json, text/json
{ "LoginType": 1, "AccessToken": "sample string 2", "Item": {}, "ThirdParty": {}, "WeChartAppId": "sample string 5", "State": 6 }
application/xml, text/xml
<LoginResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NewGPS2012.AppApi.Models.ResModel"> <State>6</State> <AccessToken>sample string 2</AccessToken> <Item /> <LoginType>1</LoginType> <ThirdParty /> <WeChartAppId>sample string 5</WeChartAppId> </LoginResult>