PATCH api/ContactLensPrescriptions

Deactivate or activate a contact lens prescription.

Request Information

URI Parameters

None.

Body Parameters

Model used to deactivate/activate a contact lens prescription

ContactLensPrescriptionPatchModel
NameDescriptionTypeAdditional information
ExternalId

Unique ID of the model in the integrating system (Required).

 string

None.
Active

Whether the contact lens prescription is active or not.

 boolean

None.

Request Formats

application/json, text/json

Sample: 
{
  "externalId": "sample string 1",
  "active": true
}

application/xml, text/xml

Sample: 
<ContactLensPrescriptionPatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.ContactLensPrescriptions">
  <Active>true</Active>
  <ExternalId>sample string 1</ExternalId>
</ContactLensPrescriptionPatchModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ContactLensPrescriptionPatchModel'.

Response Information

Resource Description

ContactLensPrescriptionPatchModel
NameDescriptionTypeAdditional information
ExternalId

Unique ID of the model in the integrating system (Required).

 string

None.
Active

Whether the contact lens prescription is active or not.

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "externalId": "sample string 1",
  "active": true
}

application/xml, text/xml

Sample: 
<ContactLensPrescriptionPatchModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/GlobalPortal.Api.Models.ContactLensPrescriptions">
  <Active>true</Active>
  <ExternalId>sample string 1</ExternalId>
</ContactLensPrescriptionPatchModel>