---
name: "getPetDetail"
mode: "api"
versionRequirements:
  - { name: "@ray-js/ray", version: "1.6.27" }
title: "getPetDetail - 获取宠物详情"
---

## getPetDetail

> [VERSION] @ray-js/ray >= 1.6.27

### 描述

获取宠物详情

### 参数

`Params`

| 参数 | 类型 | 必填 | 描述 |
| --- | --- | --- | --- |
| `data` | `GetPetDetail` | 是 | 请求参数：ownerId 家庭 id，id 宠物 id |

### 返回值

类型: `Promise<PetDetail>`

Promise，resolve 值为宠物详情（PetDetail）

##### PetDetail

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `ownerId` | `string` | 家庭id |
| `petType` | `"cat" \| "dog"` | 宠物类型 |
| `name` | `string` | 宠物名字，不能超过40个字符 |
| `avatar` | `string` | 宠物头像路径，以 "smart/" 开头 |
| `sex` | `number` | 性别. 0-雌性, 1-雄性, 2-绝育雌性, 3-绝育雄性 |
| `activeness` | `number` | 活跃度，0-不活跃，1-正常，2-非常活跃 |
| `birth` | `number` | 生日, 单位: 毫秒 |
| `weight` | `number` | 体重，单位为g |
| `breedCode` | `string` | 品种code(从宠物品种列表接口获取) |
| `rfid` | `string` | rfid |
| `id` | `number` | 宠物id |
| `avatarDisplay` | `string` | 宠物头像可访问路径 |
| `breedName` | `string` | 品种名称 |
| `extInfo` | `string` | 额外信息，不要放敏感信息 |
| `personalities` | `string[]` | 宠物性格code |
| `idPhotos` | `IdPhotos[]` | 宠物正面照 |
| `features` | `Feature[]` | 宠物特征code |
| `devIds` | `string[]` | 关联的设备IDs |
| `relationFood` | `Object` | 关联的主粮信息 |
| `weightType` | `0 \| 1 \| 2` | 体型，0-偏轻，1-正常，2-偏重（需关联主粮、品种等信息） |
| `dailyCalorie` | `number` | 日推荐卡路里，单位：Kcal（需关联主粮、品种等信息） |
| `dailyFeeding` | `number` | 日推荐喂食量，单位：g（需关联主粮、品种等信息） |
| `gmtCreate` | `number` | 创建时间戳，单位毫秒 |
| `gmtModified` | `number` | 修改时间戳，单位毫秒 |

##### PetDetail.relationFood 的属性

| 属性 | 类型 | 必填 | 默认值 | 描述 |
| --- | --- | --- | --- | --- |
| `id` | `number` | 是 | - | 主粮id |
| `name` | `string` | 是 | - | 主粮名称 |


### 引用对象

##### `type` GetPetDetail

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `ownerId` | `string` | 家庭id |
| `id` | `number` | 宠物id |

##### `type` IdPhotos

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `angle` | `string` |  |
| `objectKey` | `string` |  |
| `display` | `string` |  |

##### `type` Feature

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `category` | `string` |  |
| `details` | `string[]` |  |

##### `type` Images

| 属性 | 类型 | 描述 |
| --- | --- | --- |
| `imageDisplayUrl` | `string` |  |
| `objectKey` | `string` |  |
| `angle` | `string` |  |
| `desc` | `string` |  |


### 示例代码

#### 请求示例

```typescript
import { getPetDetail } from '@ray-js/ray';

getPetDetail({
  ownerId: 'xxxx',
  id: 1,
});
```

#### 返回示例

```json
{
  "id": 1,
  "ownerId": "xxxx",
  "petType": "cat",
  "name": "福宝",
  "avatar": "smart/xxxx/xxxx/xxxx",
  "avatarDisplay": "https://xxx/xxx",
  "sex": 1,
  "activeness": 1,
  "birth": 1614528000000,
  "weight": 5000,
  "breedCode": "xxx",
  "breedName": "金吉拉",
  "rfid": "xxxxx",
  "extInfo": "",
  "idPhotos": [
    {
      "angle": "firstFront",
      "display": "https://xxx/xxx",
      "objectKey": "xxxx"
    }
  ],
  "features": [
    {
      "category": "eyeColor",
      "details": ["棕色"]
    }
  ],
  "personalities": ["independent"],
  "relationFood": {
    "id": 22,
    "name": "xxx"
  },
  "weightType": 1,
  "dailyCalorie": 62.7,
  "dailyFeeding": 191,
  "gmtCreate": 1740792022716,
  "gmtModified": 1741785184589
}
```