App.Sync.Pull
拉取增量

接口地址:https://pad1.itsoft.top/?s=App.Sync.Pull

请求方式  GET

接口描述: 按游标拉取所有表的变更,首次调用不传 cursor 即为全量

Download Markdown ApiDoc

接口参数

参数名字类型是否必须默认值其他说明
cursor字符串可选增量游标,留空表示首次全量拉取

返回结果

参数名字类型说明
cursor字符串下次拉取要带上的游标
exercises字符串动作库
workouts字符串训练计划
weekPlans字符串周计划
sessions字符串训练记录
weights字符串体重
settings字符串应用设置(单对象,可能为 null)
tombstones字符串删除墓碑

错误列表

错误状态码错误描述信息
400表示客户端参数错误
404表示接口服务不存在
500表示服务端内部错误

在线测试   

参数是否必须值
service 必须
cursor 可选

客户端请求示例


# 【 拉取增量】接口文档 v1.0.0
**所属平台**: PhalApi开源接口框架
**接口地址**: `https://pad1.itsoft.top/?s=App.Sync.Pull`
**请求方式**: GET

## 接口基本信息
- **功能描述**:  按游标拉取所有表的变更,首次调用不传 cursor 即为全量
- **返回格式**: JSON

## 请求参数说明

### 系统参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| s | string | 必填 | 接口服务名,固定为`App.Sync.Pull` |


### 业务参数
| 参数名 | 类型 | 必填 | 说明 |
|---|---|---|---|
| cursor | string | 可选 | 增量游标,留空表示首次全量拉取 |


## 返回字段
| 返回字段 | 类型 | 说明 |
|---|---|---|
| ret	| int | 接口状态码,`200`表示成功,`4xx`表示客户端非法请求,`5xx`表示服务端异常 |
| data | object/array/混合 | 接口返回的业务数据,由不同的API接口决定不同的数据返回字段和结构。|
| msg | 字符串 | 提示信息,面向技术人员的帮助或错误提示信息,成功返回时为空字符串 |
| data.cursor | string | 下次拉取要带上的游标|
| data.exercises | array | 动作库|
| data.workouts | array | 训练计划|
| data.weekPlans | array | 周计划|
| data.sessions | array | 训练记录|
| data.weights | array | 体重|
| data.settings | array | 应用设置(单对象,可能为 null)|
| data.tombstones | array | 删除墓碑|


## 请求示例
```bash
curl -X GET 'https://pad1.itsoft.top/?s=App.Sync.Pull'&cursor= \
  -H 'Content-Type: application/json'
```

返回示例:
```json

```
温馨提示: 此接口文档根据接口代码和注释实时自动生成,帮助文档请见PhalApi 2.x 开发文档。