getPetBreedList(data: GetPetBreedList)

Requires:
@ray-js/ray≥1.6.27

Description

Get pet breed list

Parameters

ParameterTypeRequiredDescription
YesRequest parameters: petType is cat or dog

Return Value

Type: Promise<PetBreedListResult>
Promise that resolves to the breed list (code, multilingual name, initial, etc.)

Referenced Types

typePetBreedListResult
Array<{
  /** 品种code */
  breedCode: string;
  /** 品种多语言名称 */
  name: string;
  /** 宠物名称首字母，中英文才有 */
  headerChar: string;
}>

Valid Values

GetPetBreedList.petType
ValueDescriptionSince
cat--
dog--

Examples

Request example

import { getPetBreedList } from '@ray-js/ray';

getPetBreedList({
  petType: 'dog',
});

Response example

[
  {
    "breedCode": "xxx",
    "name": "Dogo Argentino",
    "headerChar": "A"
  }
]