VEvetnio
vetmanager

VetManager visit context for a consultation

Returns what the vet needs before exporting: whether the consultation is already linked to a VetManager visit, an unfinished visit creation to resume, earlier visits the animal can be added to, and the VetManager animal of the consultation's patient. Errors: 401 when the caller must sign in to VetManager again; 403 when the practice is not linked to this workspace; 404 when the consultation does not exist.

get/workspaces/{workspaceId}/consultations/{consultationId}/vetmanager/visit-context

Request

  • Base URL
    https://vetnio.com/api/v2
  • URL
    https://vetnio.com/api/v2/workspaces/{workspaceId}/consultations/{consultationId}/vetmanager/visit-context
  • Auth
    HTTP bearer

Path parameters

workspaceIdstring required

Identifier of the clinic (workspace), as returned by GET /workspaces. The key's user must be a member of the clinic, or an admin of the organization it belongs to.

Example:furunculotic-loud-chihuahua
consultationIdstring required

Identifier of the consultation (UUID), as returned when it was created or by GET /workspaces/{workspaceId}/consultations. It must belong to the clinic in workspaceId.

Example:a1b2c3d4-e5f6-7890-abcd-ef1234567890

Response

The visit context.

identityKeystring required

Opaque key from the visit context. A request is rejected with 409 when the signed-in VetManager account or practice changed since it was issued.

linkedboolean required

true when the consultation is already linked to a visit; export directly.

returnUrlstring nullable required

Link back to the linked visit in VetManager, when known.

Example response

{
  "identityKey": "3f1e9c0b7a",
  "practice": {
    "id": 4242,
    "name": "Demogården"
  },
  "linkedVisit": {
    "resonId": 2535050,
    "assignmentId": 3100001,
    "practiceId": 4242,
    "contactId": 5101,
    "animalId": 8811
  },
  "pending": {
    "key": "vetnio-visit-6c1f",
    "selection": {
      "contactId": 5101,
      "animalId": 8811,
      "assignmentId": 3100001,
      "name": "Hälta"
    },
    "canRetry": true
  },
  "visits": [
    {
      "assignmentId": 3100001,
      "contactId": 5101,
      "name": "Bella – Hälta"
    }
  ],
  "patientChoice": {
    "contactId": 5101,
    "animalId": 8811,
    "animalName": "Bella",
    "ownerName": "Anna Lindqvist"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.