动物API
公共请求信息
Header参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| X-Authorization | string | true | 请求认证头部，认证规则详见 鉴权认证。标准格式：Bearer ${Access_token} |
| Accept | string | true | 请设置为 application/json |
| Content-Type | string | true | 请设置为 application/json |
HTTP响应状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功 |
| 400 | 参数错误 |
| 401 | 验证不通过，请参考 鉴权认证 生成认证信息 |
业务错误码
| 状态码 | 错误码 | 描述 | 解决方案 |
|---|---|---|---|
| 400 | PARAM_ERROR | 参数错误 | 请根据接口返回的错误描述检查参数，参数需按API文档字段填写说明填写 |
| 401 | SIGN_ERROR | 签名错误 | 权限检验异常，请详细参考文档 |
| 403 | NO_AUTH | 无权限 | 请前往平台申请此接口相关权限 |
| 429 | FREQUENCY_LIMITED | 频率超限 | 请求频率超限，请降低请求接口频率 |
| 500 | SYSTEM_ERROR | 系统错误 | 系统异常，请用相同参数重新调用 |
动物实体信息
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| id | string(36) | true | 【动物id】动物id是动物的唯一标识 |
| nfc | string(32) | false | 【动物nfc】通常在该用户下唯一 |
| scutcheon | string(32) | false | 【动物标牌】例如牛的耳标号码 |
| name | string(32) | false | 【动物名称】动物的命名 |
| petSpeciesId | integer | true | 【物种编号】例如 1 猫 2 狗 3 兔 4 马 5 牛 6 羊 7 猪 |
| petSpeciesBreedId | integer | false | 【品种编号】系统内部的编号，可不填 |
| breedName | string(32) | false | 【品种名称】该动物对应的品种名称 |
| rfid | string(36) | false | 【动物电子标识】 |
| birthDate | string(64) | false | 【动物生日】格式 yyyy-MM-dd，例如 2026-06-01 |
| gender | integer | false | 【动物性别】0 公 1 母 2 阉割 3 未知 |
| weight | double | false | 【动物体重】动物的体重 |
| weightUnit | string(32) | false | 【动物体重单位】动物的体重单位，可选 kg、lb 默认 kg |
| hairColor | string(32) | false | 【动物毛色】动物的毛色 |
| isMixed | integer | true | 【是否混血】 0为纯种，1为混血 |
| isNeutered | integer | false | 【是否绝育】0为未绝育，1为已绝育 |
| isSterilized | integer | false | 【是否消毒】0为未消毒，1为已消毒 |
| isVaccinated | integer | false | 【是否接种疫苗】0为未接种，1为已接种 |
| description | string(32) | false | 【动物备注】 |
| phone | string(32) | false | 【联系电话】 |
| string(32) | 【联系邮箱】 |
添加宠物
接口说明
请求方式：【POST】/api/petserver/pet/save
请求域名：【主域名】https://iot.seismi.co
Body 参数
json内容规范参考上述 动物实体，传入对应的字段添加即可。
应答参数
200 OK
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | integer | true | 业务状态码 |
| msg | string(32) | true | 应答信息 |
| data | object | true | 添加后的宠物信息 |
删除动物
接口说明
请求方式：【DELETE】/api/petserver/pet/delete
请求域名：【主域名】https://iot.seismi.co
Body 参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| ids | array | true | 【动物id数组】动物id是动物的唯一标识 |
应答参数
200 OK
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | integer | true | 业务状态码 |
| msg | string(32) | true | 应答信息 |
修改动物
接口说明
请求方式：【POST】/api/petserver/pet/updatePetInfo/${petId}
请求域名：【主域名】https://iot.seismi.co
Body 参数
json内容参考上述 动物实体，传入对应的字段修改即可，petId 对应宠物id。
应答参数
200 OK
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | integer | true | 业务状态码 |
| msg | string(32) | true | 应答信息 |
| data | object | true | 修改后的宠物信息 |
查询动物
接口说明
请求方式：【POST】/api/petserver/user/listAllPetInfo
请求域名：【主域名】https://iot.seismi.co
Query 参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| currPage | integer | false | 【当前页，页码-1】默认为0，页码编号从0开始 |
| pageSize | integer | false | 【页大小】默认为10 |
| sortProperty | string(36) | false | 【排序字段】可选 createTime、updaeTime 默认为createTime |
| sortOrder | string(36) | false | 【排序方式】可选 ASC、DESC，默认为DESC |
Body 参数
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| searchText | string(36) | true | 【搜索文本】支持 nfc、scutcheon、rfid、name 字段模糊搜索 |
应答参数
200 OK
| 参数名 | 类型 | 必填 | 描述 |
|---|---|---|---|
| code | integer | true | 业务状态码 |
| msg | string(32) | true | 应答信息 |
| data | object | true | 查询结果 |
| data.data | array | true | 动物列表信息 |
| data.count | integer | true | 动物总个数 |
| data.currPage | integer | true | 当前页码 |
| data.pageSize | integer | true | 当前页大小 |
| data.totalPages | integer | true | 当前总页数 |
请求示例
添加动物
curl 示例
POST
curl -X POST \
https://iot.seismi.co/api/petserver/pet/save \
-H "X-Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIi..." \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"nfc" : "1230000109",
"scutcheon" : "xxxxxxxx",
"name" : "test",
"petSpeciesId" : 5,
"rfid" : "56565656565",
"birthDate" : "2018-06-08",
"gender" : 0,
"weight" : 10,
"weightUnit" : "lb",
"description" : "test",
"phone" : "",
"email" : ""
}'
应答示例
200 OK
{
"code" : "200",
"msg" : "success",
"data" : {'id': 'a6c62ed7-198e-45c3-8578-762710d5b044'}
}
删除动物
curl 示例
DELETE
curl -X DELETE \
https://iot.seismi.co/api/petserver/pet/delete \
-H "X-Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIi..." \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '["a6c62ed7-198e-45c3-8578-762710d5b044", "2d2f9906-a3d2-4996-bbb2-fdb5f9b7e9ac"]'
应答示例
200 OK
{
"code" : "200",
"msg" : "success"
}
修改动物
curl 示例
POST
curl -X POST \
https://iot.seismi.co/api/petserver/pet/updatePetInfo/a6c62ed7-198e-45c3-8578-762710d5b044 \
-H "X-Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIi..." \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"nfc" : "1230000109",
"scutcheon" : "xxxxxxxx",
"name" : "test",
"petSpeciesId" : 5,
"rfid" : "56565656565",
"birthDate" : "2018-06-08",
"gender" : 0,
"weight" : 10,
"weightUnit" : "kg",
"description" : "test",
"phone" : "",
"email" : ""
}'
应答示例
200 OK
{
"code" : "200",
"msg" : "success",
"data" : {}
}
查询动物
curl 示例
POST
curl -X POST \
https://iot.seismi.co/api/petserver/user/listAllPetInfo \
-H "X-Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIi..." \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"searchText" : "1230000109"
}'
应答示例
200 OK
{
"code" : "200",
"msg" : "success",
"data" : {"data": [], "count": 0, "currPage": 0, "pageSize": 10, "totalPages": 0 }
}