Pet Module

Project: Pet Feeder | page_id: 1731

Pet Authentication Interface Documentation

Overview

• Base path: /api
• Documentation scope: pet module interfaces in the authenticated routes
• Authentication method: request header X-Token
• Content-Type: application/json

Authentication Header

Unified Response Format

{
  "code": 200,
  "msg": "Operation successful",
  "data": {}
}

Response Field Description

Common Authentication Failure Response

{
  "code": 401,
  "msg": "Not logged in or login expired",
  "data": null
}

{
  "code": 401,
  "msg": "Login has expired, please log in again",
  "data": null
}

Pet Object Field Description

1. Get the Pet List

• Path: /api/pet/list
• Method: POST
• Authentication required: Yes

Request Body Parameters

Request Example

{
  "deviceId": "dev_001"
}

An empty object can also be passed:

{}

Success Response Example

{
  "code": 200,
  "msg": "Operation successful",
  "data": [
    {
      "id": "pet_001",
      "userId": 1,
      "deviceId": "dev_001",
      "name": "Doudou",
      "type": "Cat",
      "breed": "British Shorthair",
      "age": "Adult",
      "gender": "Female",
      "avatar": "🐱",
      "weight": 4200,
      "createdAt": "2026-05-09T10:00:00Z",
      "updatedAt": "2026-05-09T10:00:00Z"
    }
  ]
}

Response Parameter Description

Failure Response Example

{
  "code": 400,
  "msg": "Parameter error",
  "data": null
}

{
  "code": 500,
  "msg": "Failed to get the pet list",
  "data": null
}

2. Add a Pet

• Path: /api/pet/add
• Method: POST
• Authentication required: Yes

Request Body Parameters

Request Example

{
  "deviceId": "dev_001",
  "name": "Doudou",
  "type": "Cat",
  "breed": "British Shorthair",
  "age": "Adult",
  "gender": "Female",
  "avatar": "🐱",
  "weight": 4200
}

Success Response Example

{
  "code": 200,
  "msg": "Pet added successfully",
  "data": {
    "id": "pet_001",
    "userId": 1,
    "deviceId": "dev_001",
    "name": "Doudou",
    "type": "Cat",
    "breed": "British Shorthair",
    "age": "Adult",
    "gender": "Female",
    "avatar": "🐱",
    "weight": 4200,
    "createdAt": "2026-05-09T10:00:00Z",
    "updatedAt": "2026-05-09T10:00:00Z"
  }
}

Response Parameter Description

Failure Response Example

{
  "code": 400,
  "msg": "Parameter error",
  "data": null
}

{
  "code": 400,
  "msg": "Device does not exist",
  "data": null
}

{
  "code": 400,
  "msg": "No permission to operate",
  "data": null
}

3. Update Pet Information

• Path: /api/pet/update
• Method: POST
• Authentication required: Yes

Request Body Parameters

Request Example

{
  "id": "pet_001",
  "name": "Doudou",
  "breed": "Golden Chinchilla",
  "age": "Adult",
  "gender": "Female",
  "avatar": "🐱",
  "weight": 4500
}

Success Response Example

{
  "code": 200,
  "msg": "Pet information updated",
  "data": null
}

Response Parameter Description

Failure Response Example

{
  "code": 400,
  "msg": "Parameter error",
  "data": null
}

{
  "code": 400,
  "msg": "Pet does not exist",
  "data": null
}

{
  "code": 400,
  "msg": "No permission to operate",
  "data": null
}

4. Delete a Pet

• Path: /api/pet/delete
• Method: POST
• Authentication required: Yes

Request Body Parameters

Request Example

{
  "id": "pet_001"
}

Success Response Example

{
  "code": 200,
  "msg": "Pet deleted",
  "data": null
}

Response Parameter Description

Failure Response Example

{
  "code": 400,
  "msg": "Parameter error",
  "data": null
}

{
  "code": 400,
  "msg": "Pet does not exist",
  "data": null
}

{
  "code": 400,
  "msg": "No permission to operate",
  "data": null
}

Appendix

Description

• Getting the pet list returns an array; when there is no data, an empty array is returned instead of null.
• When adding a pet, deviceId can be empty; when it is empty, the pet only belongs to the user and is not forcibly bound to a device.
• When updating a pet, type and deviceId currently cannot be modified; only the name, breed, age, gender, avatar and weight can be updated.