Get a Pet record by ID

1 min

GET

/api/v1/pets/{id}

Returns a Pet record

Path Parameters

idintegerrequired
Description
The entity id

Query Parameters

includestring
Description
Additional info to include. You can use multiple, comma separated. Options: species,breed,crossBreed,owners)
appendstring
Description
Additional attributes to include(comma separated attributes. Ex: hormonalStatusString)

Responses

200Successful operation

object
- dataPet
  - idinteger
    Example
    1
  - nicknamestring
    Example
    Fritz
  - species_idstring
    Example
    1
  - breed_idstring
    Example
    1
  - observationsstring
  - genderstring<male | female | unknown>
    Example
    male
  - microchipstring
  - crossbreedstring<0 | 1>
    Example
    0
  - crossbreed_details_idinteger
  - colorstring
    Example
    NavajoWhite
  - distinctive_marksstring
  - birthdaystring<date>
    Example
    1983-03-29
  - gender_stringstring
  - chip_numberstring
  - microchip_locationstring
  - insurance_numberstring
  - passportstring
  - profile_picturestring
    Example
    https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2
  - descriptionstring
    Example
    Lorem ipsum
  - constitutionstring
  - conformationstring
  - weightnumber
  - allergiesstring
  - nr_recsinteger
  - blood_typestring
  - hormonal_statusinteger
    Description
    0: 'Unknown' 1: 'Intact' 2: 'Neutered'
  - agestring
    Example
    38 Years, 3 Months, 19 Days
  - patientNumberstring
    Example
    mxc-1 #jwq-1
  - is_verifiedstring<0 | 1>
    Example
    1
  - breederstring
  - archiveArchive
    Description
    Slim resource for archive, usually attached to other resources
    - idinteger
      Example
      1
    - reasonstring
      Example
      The patient was archived because...
    - typestring<Deceased | Moved away | Change of owner | Other>
      Example
      Deceased
  - birthday_estimatedboolean
  - rabic_tag_numberstring
    Example
    12109384
  - updated_atstring<date-time>
    Example
    2020-06-12 15:45:43

curl

curl --request GET \
     --url /api/v1/pets/{id} \
     --header 'accept: application/json'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("/api/v1/pets/{id}", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("/api/v1/pets/{id}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

response = http.request(request)
puts response.read_body

python

import requests
import json

url = "/api/v1/pets/{id}"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Successful operation
{
  "data": {
    "id": 1,
    "nickname": "Fritz",
    "species_id": "1",
    "breed_id": "1",
    "observations": "",
    "gender": "male",
    "microchip": "",
    "crossbreed": "0",
    "crossbreed_details_id": 0,
    "color": "NavajoWhite",
    "distinctive_marks": "",
    "birthday": "1983-03-29",
    "gender_string": "",
    "chip_number": "",
    "microchip_location": "",
    "insurance_number": "",
    "passport": "",
    "profile_picture": "https://dev-1-public-digitail.s3.eu-central-1.amazonaws.com/ionut/uploads/KXy8Rlv2vluiZYqwRCy2",
    "description": "Lorem ipsum",
    "constitution": "",
    "conformation": "",
    "weight": 0,
    "allergies": "",
    "nr_recs": 0,
    "blood_type": "",
    "hormonal_status": 0,
    "age": "38 Years, 3 Months, 19 Days",
    "patientNumber": "mxc-1 #jwq-1",
    "is_verified": "1",
    "breeder": "",
    "archive": {
      "id": 1,
      "reason": "The patient was archived because...",
      "type": "Deceased"
    },
    "birthday_estimated": false,
    "rabic_tag_number": "12109384",
    "updated_at": "2020-06-12 15:45:43"
  }
}