POST api/v3/Convenet/OrderPrescription

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
medications	Collection of Medication	None.
isProxied	boolean	None.
requestId	string	None.
patientId	string	None.
gpOdsCode	string	None.

Request Formats

application/json, text/json

Sample:

{
  "medications": [
    {
      "medicineId": "sample string 1",
      "issueNumber": 2,
      "medicineName": "sample string 3",
      "dose": "sample string 4",
      "quantity": "sample string 5",
      "canBeRequested": true,
      "lastIssued": "2025-12-06T03:58:13.8713861+00:00",
      "selected": true,
      "requestStatus": "sample string 8",
      "convenetPrescriptionId": "sample string 9",
      "chargePerItem": 1.0,
      "currencyCode": "sample string 10"
    },
    {
      "medicineId": "sample string 1",
      "issueNumber": 2,
      "medicineName": "sample string 3",
      "dose": "sample string 4",
      "quantity": "sample string 5",
      "canBeRequested": true,
      "lastIssued": "2025-12-06T03:58:13.8713861+00:00",
      "selected": true,
      "requestStatus": "sample string 8",
      "convenetPrescriptionId": "sample string 9",
      "chargePerItem": 1.0,
      "currencyCode": "sample string 10"
    }
  ],
  "isProxied": true,
  "requestId": "sample string 2",
  "patientId": "sample string 3",
  "gpOdsCode": "sample string 4"
}

application/xml, text/xml

Sample:

<OrderPrescriptionRequestModelApi xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CodaPharma.Api.Models">
  <gpOdsCode>sample string 4</gpOdsCode>
  <isProxied>true</isProxied>
  <medications>
    <Medication>
      <canBeRequested>true</canBeRequested>
      <chargePerItem>1</chargePerItem>
      <convenetPrescriptionId>sample string 9</convenetPrescriptionId>
      <currencyCode>sample string 10</currencyCode>
      <dose>sample string 4</dose>
      <issueNumber>2</issueNumber>
      <lastIssued>2025-12-06T03:58:13.8713861+00:00</lastIssued>
      <medicineId>sample string 1</medicineId>
      <medicineName>sample string 3</medicineName>
      <quantity>sample string 5</quantity>
      <requestStatus>sample string 8</requestStatus>
      <selected>true</selected>
    </Medication>
    <Medication>
      <canBeRequested>true</canBeRequested>
      <chargePerItem>1</chargePerItem>
      <convenetPrescriptionId>sample string 9</convenetPrescriptionId>
      <currencyCode>sample string 10</currencyCode>
      <dose>sample string 4</dose>
      <issueNumber>2</issueNumber>
      <lastIssued>2025-12-06T03:58:13.8713861+00:00</lastIssued>
      <medicineId>sample string 1</medicineId>
      <medicineName>sample string 3</medicineName>
      <quantity>sample string 5</quantity>
      <requestStatus>sample string 8</requestStatus>
      <selected>true</selected>
    </Medication>
  </medications>
  <patientId>sample string 3</patientId>
  <requestId>sample string 2</requestId>
</OrderPrescriptionRequestModelApi>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ResponseModel

Name	Type	Additional information
Status	ResStatus	None.
ErrorMessage	string	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 0,
  "ErrorMessage": "sample string 1",
  "Data": {}
}

application/xml, text/xml

Sample:

<ResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CodaPharma.Api.Models">
  <Data />
  <ErrorMessage>sample string 1</ErrorMessage>
  <Status>Fail</Status>
</ResponseModel>