id - ID питомца owner_id - ID владельца питомца type_id - ID типа питомца alias - кличка sex - пол date_register - дата регистрации (формат Y-m-d H:i:s) birthday - дата рождения (формат Y-m-d) note - примечание breed_id - ID породы color_id - ID цвета deathnote - причина смерти deathdate - дата смерти (формат Y-m-d H:i:s) chip_number - номер чипа lab_number - лабораторный номер status - статус питомца picture weight значения поля sex male - мужской, female - женский, castrated - кастрирован, sterilized - стерилизован, unknown - неизвестный значения поля status alive - активный dead - умер deleted - удален
Для создания питомца необходимо задать его кличку и id клиента-хозяина. Также можно задавать вид питомца и породу, дату рождения, окрас и т.д.
Поле type_id берется из запроса модели PetType.
Поле breed_id берется из запроса модели Breed.
curl --location --request POST 'https://{DOMAIN NAME}/rest/api/pet' \ --header 'Content-Type: application/json' \ --header 'X-REST-API-KEY: {REST API KEY}' \ --data-raw '{ "owner_id":6, "alias":"Матроскин", "type_id": 6, "breed_id":384 }'
Ответ сервера
{ "success": true, "message": "Record(s) Created", "data": { "totalCount": 1, "pet": [ { "id": "5", "owner_id": "6", "type_id": "6", "alias": "Матроскин", "sex": "unknown", "date_register": "2021-09-17 16:07:44", "birthday": null, "note": "", "breed_id": "384", "old_id": null, "color_id": null, "deathnote": null, "deathdate": null, "chip_number": "", "lab_number": "", "status": "alive", "picture": null, "weight": "0.0000000000", "owner": { "id": "6", "address": "", "home_phone": "", "work_phone": "", "note": "", "type_id": null, "how_find": null, "balance": "0.0000000000", "email": "", "city": "", "city_id": "145", "date_register": "2021-09-09 14:37:37", "cell_phone": "0957778899", "zip": "", "registration_index": null, "vip": "0", "last_name": "Client001", "first_name": "Client001", "middle_name": "Client001", "status": "ACTIVE", "discount": "0", "passport_series": "", "lab_number": "", "street_id": "0", "apartment": "", "unsubscribe": "0", "in_blacklist": "0", "last_visit_date": "0000-00-00 00:00:00", "number_of_journal": "", "phone_prefix": "38" }, "type": { "id": "6", "title": "Сельскохозяйственные", "picture": "", "type": "" }, "breed": { "id": "384", "title": "Свинья", "pet_type_id": "6" } } ] } }
Пример запроса на получение типов и пород питомцев
curl --location --request GET 'https://{DOMAIN NAME}/rest/api/PetType' \ --header 'Content-Type: application/json' \ --header 'X-REST-API-KEY: {REST API KEY}'
Ответ сервера
{ "success": true, "message": "Records Retrieved Successfully", "data": { "totalCount": "14", "petType": [ { "id": "8", "title": "Собака", "picture": "dog", "type": "dog", "breeds": [ { "id": "87", "title": "Доберман", "pet_type_id": "8" }, { "id": "88", "title": "Боксер", "pet_type_id": "8" }, { "id": "89", "title": "Дог", "pet_type_id": "8" }, { "id": "90", "title": "Такса", "pet_type_id": "8" }, { "id": "102", "title": "Стаффордшир-терьер", "pet_type_id": "8" } ] }, { "id": "11", "title": "Птица", "picture": "", "type": "", "breeds": [ { "id": "287", "title": "Фазан", "pet_type_id": "11" }, { "id": "289", "title": "Ворона", "pet_type_id": "11" }, { "id": "299", "title": "Канарейка", "pet_type_id": "11" } ] }, { "id": "12", "title": "Грызун", "picture": "", "type": "", "breeds": [ { "id": "195", "title": "Кролик", "pet_type_id": "12" }, { "id": "269", "title": "Крыса", "pet_type_id": "12" }, { "id": "270", "title": "Белка", "pet_type_id": "12" }, { "id": "273", "title": "Хомяк", "pet_type_id": "12" }, { "id": "279", "title": "Морская свинка", "pet_type_id": "12" }, ] } ] }
Создание питомца:
Обязательные поля для запроса: owner_id, alias, breed_id, type_id
Обновление питомца:
Нет обязательных полей (но как минимум одно поле нужно передать)