Create a Record

1 min

POST

https://developer.digitail.io/api/v1/records

Permissions needed: CREATE_CHECKUPS Create a new Record.

Body Parameters

bodyobjectrequired
- clinic_idinteger
  Description
  Clinic Id.
- vet_idinteger
  Description
  Clinic Id.
- pet_idinteger
  Description
  Pet Id.
- appointment_idinteger
  Description
  Appointment Id.
- template_idinteger
  Description
  Template Id.
- internal_notesstring
  Description
  Internal notes visible only to clinic staff members.
- diagnosisstring
  Description
  Diagnosis.
- presumptive_diagnosisstring
  Description
  Presumptive Diagnosis.
- treatmentstring
  Description
  Treatment.
- recommendationsstring
  Description
  Recommendations.
- template_defaultstring<general | refill>
  Description
  Optional category of default record template to apply when template_id is not provided. When omitted, the general default template (if any) is applied. Pass null to skip default-template lookup entirely.
  Allowed
  generalrefill

Responses

201successful operation

object
- dataobject
  Description
  Record = NewFileCase = Consultation = Soap. Record is the preferred naming.
  - idinteger
    Example
    1
  - numberstring
    Example
    175
  - statusinteger
    Example
    1
    Description
    0 - Draft 1 - Saved 2 - Closed 3 - Hospitalized
    Allowed
    0123
  - vet_idinteger
    Example
    1
  - responsible_idinteger
    Example
    1
  - responsibleobject
    Description
    Vet responsible for the record. Only present when responsible is requested via the include query parameter.
    - items
  - clinic_idinteger
    Example
    1
  - pet_idinteger
    Example
    1
  - sale_idinteger
    Example
    1
  - datestring
    Example
    2021-11-19
  - reasonstring
    Example
    Routine checkup
  - template_idinteger
  - commentsstring
  - recommendationsstring
  - rabic_tag_numberstring
  - presumptive_diagnosisstring
  - diagnosisstring
  - treatmentstring
  - visit_typesobject[]
    - idinteger
    - clinic_idinteger
    - namestring
    - descriptionstring
    - categorystring<consultation_exams | vaccines | preventive_vaccines | euthanasia | spay_neuter | medical_procedures | imagining_diagnostics | boarding | grooming | microchipping | other | admin>
      Allowed
      consultation_examsvaccinespreventive_vaccineseuthanasiaspay_neutermedical_proceduresimagining_diagnosticsboardinggroomingmicrochippingotheradmin
    - category_labelstring
    - durationinteger
    - is_visibleboolean
    - colorstring
    - orderinteger
    - deposit_for_online_bookingnumber<float>
      Format
      float
    - has_intake_enabledboolean
      Description
      only valid for clinics with Tails integration in the Pet Parent App
    - printable_filesobject[]
      - idinteger
      - titlestring
    - service_packagesobject[]
      - idinteger
      - namestring
      - client_namestring
      - descriptionstring
      - unit_pricestring
        Description
        Warning: Deprecated
        Deprecated. Use price_without_vat.
      - pricestring
        Description
        Warning: Deprecated
        Deprecated. Use price_with_vat.
      - price_with_vatnumber<float>
        Description
        Price with tax. In the clinic's currency.
        Format
        float
      - price_without_vatnumber<float>
        Description
        Price without tax. In the clinic's currency.
        Format
        float
      - price_includes_taxboolean
        Description
        Warning: Deprecated
        Deprecated. Use price_with_vat / price_without_vat.
      - taxfloat
  - reason_visit_typeitems
  - structureobject
  - selectedDiagnosesobject[]
    Description
    Only present when selectedDiagnoses is requested via the include query parameter.
    - idinteger
      Example
      1
    - namestring
      Example
      Otitis externa
    - descriptionstring
    - recommendationstring
    - clinic_idinteger
      Example
      1
  - clinical_examination_notesstring
    Description
    Only present when clinical_examination_notes is requested via the append query parameter.
  - has_quick_soapboolean
    Description
    Whether the record has QuickSOAP content. Only present when has_quick_soap is requested via the append query parameter.

curl

curl --request POST \
     --url https://developer.digitail.io/api/v1/records \
     --header 'accept: application/json'

javascript

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

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

fetch("https://developer.digitail.io/api/v1/records", 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("https://developer.digitail.io/api/v1/records")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"

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

python

import requests
import json

url = "https://developer.digitail.io/api/v1/records"

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

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

print(response.text)

201

// successful operation
{
  "data": {
    "id": 1,
    "number": "175",
    "status": 1,
    "vet_id": 1,
    "responsible_id": 1,
    "responsible": {},
    "clinic_id": 1,
    "pet_id": 1,
    "sale_id": 1,
    "date": "2021-11-19",
    "reason": "Routine checkup",
    "template_id": 0,
    "comments": "",
    "recommendations": "",
    "rabic_tag_number": "",
    "presumptive_diagnosis": "",
    "diagnosis": "",
    "treatment": "",
    "visit_types": [
      {
        "id": 0,
        "clinic_id": 0,
        "name": "",
        "description": "",
        "category": "",
        "category_label": "",
        "duration": 0,
        "is_visible": false,
        "color": "",
        "order": 0,
        "deposit_for_online_booking": "",
        "has_intake_enabled": false,
        "printable_files": [
          {
            "id": 0,
            "title": ""
          }
        ],
        "service_packages": [
          {
            "id": 0,
            "name": "",
            "client_name": "",
            "description": "",
            "unit_price": "",
            "price": "",
            "price_with_vat": "",
            "price_without_vat": "",
            "price_includes_tax": false,
            "tax": ""
          }
        ]
      }
    ],
    "reason_visit_type": {},
    "structure": {},
    "selectedDiagnoses": [
      {
        "id": 1,
        "name": "Otitis externa",
        "description": "",
        "recommendation": "",
        "clinic_id": 1
      }
    ],
    "clinical_examination_notes": "",
    "has_quick_soap": false
  }
}