client/docs/passport/account.md

170 lines
3.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# Account
Passport(会员通行证)模块-数据
- [/passport.Account/Get](#passportaccountget)
- [/passport.Account/SetData](#passportaccountsetdata)
- [/passport.Account/SetPassword](#passportaccountsetpassword)
- [/passport.Account/TagCreate](#passportaccounttagcreate)
- [/passport.Account/TagRemove](#passportaccounttagremove)
- [/passport.Account/Statistics](#passportaccountstatistics)
## /passport.Account/Get
通过会员所有信息
### Request
```javascript
{}
```
### Reply
```javascript
{
identity: "", // type<string>, 唯一标识
account: "", // type<string>, 帐号
phone: "", // type<string>, 手机号码 必填
email: "", // type<string>, 验证码
rights: "", // type<string>, 权限
nickname: "", // type<string>, 昵称
avatar: "", // type<string>, 头像
birthday: "", // type<string>, 生日
sex: 0, // type<int32>, 性别1为男性2为女性
country: 0, // type<int32>, 国家
province: 0, // type<int32>, 省
city: 0, // type<int32>, 市
area: 0, // type<int32>, 区
sign: "", // type<string>, 签名
cover: "", // type<string>, 背景&封面
score: 0, // type<int32>, 积分
level: 0, // type<int32>, 等级
verify: {
"": false
}, // map<string,bool>, 数据
tags: [{
name: "", // type<string>
icon: "", // type<string>
}], // list<TagItem>
}
```
## /passport.Account/SetData
更新会员的信息数据,字段值为空或是0将不更新此数据
### Request
```javascript
{
nickname: "", // type<string>, 昵称
avatar: "", // type<string>, 头像
birthday: "", // type<string>, 生日
sex: 0, // type<int32>, 性别1为男性2为女性
country: 0, // type<int32>, 国家
province: 0, // type<int32>, 省
city: 0, // type<int32>, 市
area: 0, // type<int32>, 区
sign: "", // type<string>, 签名
cover: "", // type<string>, 背景&封面
score: 0, // type<int32>, 积分
level: 0, // type<int32>, 等级
}
```
### Reply
```javascript
{
code: 0, // type<int32>, 状态码
message: "", // type<string>, 状态说明
details: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /passport.Account/SetPassword
更新会员的密码
### Request
```javascript
{
old_password: "", // type<string>, 旧密码
new_password: "", // type<string>, 新密码
}
```
### Reply
```javascript
{
code: 0, // type<int32>, 状态码
message: "", // type<string>, 状态说明
details: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /passport.Account/TagCreate
新增标签
### Request
```javascript
{
name: "", // type<string>
icon: "", // type<string>
}
```
### Reply
```javascript
{
code: 0, // type<int32>, 状态码
message: "", // type<string>, 状态说明
details: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /passport.Account/TagRemove
删除标签
### Request
```javascript
{
id: "0", // type<int64>, 唯一ID
identity: "", // type<string>, 唯一码
}
```
### Reply
```javascript
{
code: 0, // type<int32>, 状态码
message: "", // type<string>, 状态说明
details: "", // type<string>, 数据
timeseq: "0", // type<int64>, 响应时间序列
}
```
## /passport.Account/Statistics
获取会员的相关统计数据
### Request
```javascript
{
field: [""], // list<string>, 要获取的统计数据字段。
}
```
### Reply
```javascript
{
Data: {
"": "0"
}, // map<string,int64>, 数据以Map格式输出
}
```