Optima2 API v.2 REST

Prescription

by client

request

GET /api/v2/clients/1000000010/prescription HTTP/1.1

Table 301. /api/v2/clients/{clientId}/prescription
Parameter	Description
`clientId`	client’s id

response

HTTP/1.1 200 OK

{
  "prescriptions" : [ {
    "id" : 1000000002,
    "sphOd" : -1.25,
    "sphOs" : -2.0,
    "cylOd" : -0.5,
    "cylOs" : -0.5,
    "axOd" : 70,
    "axOs" : 90,
    "prism1DioptreOd" : null,
    "prism1DioptreOs" : null,
    "prism2DioptreOd" : null,
    "prism2DioptreOs" : null,
    "prism1BaseOd" : null,
    "prism1BaseOs" : null,
    "prism2BaseOd" : null,
    "prism2BaseOs" : null,
    "addidationOd" : null,
    "addidationOs" : null,
    "dpp" : 66.0,
    "dppOd" : 33.0,
    "dppOs" : 33.0,
    "visusOd" : null,
    "visusOs" : null,
    "purpose" : "Рецепт клиента",
    "purposeForClientPrescription" : null,
    "basis" : "CLIENT_PRESCRIPTION",
    "recommendedLenses" : null,
    "comments" : "",
    "date" : "2018-10-04T00:00:00.000+00:00",
    "deleted" : false,
    "empty" : null
  }, {
    "id" : 1000000001,
    "sphOd" : -0.5,
    "sphOs" : -1.0,
    "cylOd" : null,
    "cylOs" : null,
    "axOd" : null,
    "axOs" : null,
    "prism1DioptreOd" : null,
    "prism1DioptreOs" : null,
    "prism2DioptreOd" : null,
    "prism2DioptreOs" : null,
    "prism1BaseOd" : null,
    "prism1BaseOs" : null,
    "prism2BaseOd" : null,
    "prism2BaseOs" : null,
    "addidationOd" : null,
    "addidationOs" : null,
    "dpp" : 64.0,
    "dppOd" : 32.0,
    "dppOs" : 32.0,
    "visusOd" : null,
    "visusOs" : null,
    "purpose" : "Рецепт клиента",
    "purposeForClientPrescription" : null,
    "basis" : "CLIENT_PRESCRIPTION",
    "recommendedLenses" : null,
    "comments" : "",
    "date" : "2018-10-04T00:00:00.000+00:00",
    "deleted" : false,
    "empty" : null
  } ],
  "contactLensPrescriptions" : [ ]
}

Table 302. response description
Path	Type	Description
`prescriptions.id`	`Number`	Prescription’s id
`prescriptions.sphOd`	`Number`	Prescription’s sphOd
`prescriptions.sphOs`	`Number`	Prescription’s sphOs
`prescriptions.cylOd`	`Number`	Prescription’s cylOd
`prescriptions.cylOs`	`Number`	Prescription’s cylOs
`prescriptions.axOd`	`Number`	Prescription’s axOd
`prescriptions.axOs`	`Number`	Prescription’s axOs
`prescriptions.addidationOd`	`Number`	Prescription’s addidationOd
`prescriptions.addidationOs`	`Number`	Prescription’s addidationOs
`prescriptions.dpp`	`Number`	Prescription’s dpp
`prescriptions.dppOd`	`Number`	Prescription’s dppOd
`prescriptions.dppOs`	`Number`	Prescription’s dppOs
`prescriptions.visusOd`	`Number`	Prescription’s visusOd
`prescriptions.visusOs`	`Number`	Prescription’s visusOs
`prescriptions.purpose`	`String`	Prescription’s purpose
`prescriptions.purposeForClientPrescription`	`String`	Prescription’s purposeForClientPrescription
`prescriptions.basis`	`String`	Prescription’s basis
`prescriptions.recommendedLenses`	`String`	Prescription’s recommendedLenses
`prescriptions.comments`	`String`	Prescription’s comments
`prescriptions.date`	`String`	Prescription’s date
`prescriptions.deleted`	`Boolean`	Prescription’s deleted
`prescriptions.empty`	`Boolean`	Prescription’s empty
`clPrescriptions.id`	`Number`	CL Prescription’s id
`clPrescriptions.sphOd`	`Number`	CL Prescription’s sphOd
`clPrescriptions.sphOs`	`Number`	CL Prescription’s sphOs
`clPrescriptions.cylOd`	`Number`	CL Prescription’s cylOd
`clPrescriptions.cylOs`	`Number`	CL Prescription’s cylOs
`clPrescriptions.axOd`	`Number`	CL Prescription’s axOd
`clPrescriptions.axOs`	`Number`	CL Prescription’s axOs
`clPrescriptions.addidationOd`	`Number`	CL Prescription’s addidationOd
`clPrescriptions.addidationOs`	`Number`	CL Prescription’s addidationOs
`clPrescriptions.radiusOd`	`Number`	CL Prescription’s radiusOd
`clPrescriptions.radiusOs`	`Number`	CL Prescription’s radiusOs
`clPrescriptions.diameterOd`	`Number`	CL Prescription’s diameterOd
`clPrescriptions.diameterOs`	`Number`	CL Prescription’s diameterOs
`clPrescriptions.model`	`String`	CL Prescription’s model
`clPrescriptions.color`	`String`	CL Prescription’s color
`clPrescriptions.basis`	`String`	CL Prescription’s basis
`clPrescriptions.comments`	`String`	CL Prescription’s comments
`clPrescriptions.date`	`String`	CL Prescription’s date
`clPrescriptions.deleted`	`Boolean`	CL Prescription’s deleted

contact lens prescriptions

request

GET /api/v2/clients/122333/prescription/contact-lens HTTP/1.1

Table 303. /api/v2/clients/{clientId}/prescription/contact-lens
Parameter	Description
`clientId`	client’s id

response

HTTP/1.1 200 OK

[ {
  "id" : 1100000002,
  "model" : null,
  "color" : null,
  "basis" : "DOCTOR_PRESCRIPTION",
  "comment" : null,
  "createdOn" : "2025-04-09",
  "doctorId" : 9000000010,
  "deleted" : false,
  "leftEye" : {
    "dioptre" : -1.25,
    "cylinder" : null,
    "axis" : null,
    "add" : null,
    "curvatureRadius" : 7.0,
    "diameter" : 14.0,
    "expirationOn" : null
  },
  "rightEye" : {
    "dioptre" : -1.25,
    "cylinder" : null,
    "axis" : null,
    "add" : null,
    "curvatureRadius" : 7.0,
    "diameter" : 14.0,
    "expirationOn" : null
  }
}, {
  "id" : 1100000001,
  "model" : null,
  "color" : null,
  "basis" : "DOCTOR_PRESCRIPTION",
  "comment" : null,
  "createdOn" : "2025-04-08",
  "doctorId" : 9000000010,
  "deleted" : false,
  "leftEye" : {
    "dioptre" : 1.0,
    "cylinder" : 1.0,
    "axis" : 1,
    "add" : "+1,00",
    "curvatureRadius" : 8.0,
    "diameter" : 15.5,
    "expirationOn" : null
  },
  "rightEye" : {
    "dioptre" : 1.25,
    "cylinder" : 1.0,
    "axis" : 1,
    "add" : "+1,00",
    "curvatureRadius" : 8.0,
    "diameter" : 15.5,
    "expirationOn" : null
  }
} ]

Table 304. response description
Path	Type	Description
`id`	`Number`	CL Prescription’s id
`model`	`String`	CL Prescription’s model
`color`	`String`	CL Prescription’s color
`basis`	`String`	CL Prescription’s basis
`comment`	`String`	CL Prescription’s comments
`createdOn`	`String`	CL Prescription’s date
`doctorId`	`Number`	doctor
`deleted`	`Boolean`	CL Prescription’s deleted
`leftEye`	`Object`	CL Prescription’s left eye
`leftEye.dioptre`	`Number`	CL Prescription’s left eye dioptre
`leftEye.cylinder`	`Number`	CL Prescription’s left eye cylinder
`leftEye.axis`	`Number`	CL Prescription’s left eye axis
`leftEye.add`	`String`	CL Prescription’s left eye add
`leftEye.curvatureRadius`	`Number`	CL Prescription’s left eye curvature radius
`leftEye.diameter`	`Number`	CL Prescription’s left eye diameter
`rightEye`	`Object`	CL Prescription’s left eye
`rightEye.dioptre`	`Number`	CL Prescription’s left eye dioptre
`rightEye.cylinder`	`Number`	CL Prescription’s left eye cylinder
`rightEye.axis`	`Number`	CL Prescription’s left eye axis
`rightEye.add`	`String`	CL Prescription’s left eye add
`rightEye.curvatureRadius`	`Number`	CL Prescription’s left eye curvature radius
`rightEye.diameter`	`Number`	CL Prescription’s left eye diameter