POST api/PrescriptionBatch

Request Information

URI Parameters

None.

Body Parameters

Collection of Prescription
NameDescriptionTypeAdditional information
Deleted

boolean

None.

CodeId

string

Required

String length: inclusive between 0 and 50

Code

string

String length: inclusive between 0 and 50

PatientId

string

Required

String length: inclusive between 0 and 50

PatientPmsId

string

Required

String length: inclusive between 0 and 50

Description

string

String length: inclusive between 0 and 100

ProviderId

string

Required

String length: inclusive between 0 and 50

ProviderName

string

String length: inclusive between 0 and 50

Filler

string

String length: inclusive between 0 and 50

IssuedDate

date

None.

FillDate

date

None.

ExpirationDate

date

None.

Quantity

decimal number

None.

TransactionId

string

Required

String length: inclusive between 0 and 50

TotalRefills

integer

None.

CurrentRefillNumber

integer

None.

PrescriptionNumber

string

Required

String length: inclusive between 0 and 50

Instructions

string

String length: inclusive between 0 and 1024

IsVoided

boolean

None.

SiteId

string

String length: inclusive between 0 and 50

ApiCreateDate

date

Required

ApiLastChangeDate

date

None.

CheckSum

integer

None.

RowKey

integer

Required

Id

string

Required

String length: inclusive between 0 and 50

SyncId

string

Required

String length: inclusive between 0 and 50

SubscriberId

string

Required

String length: inclusive between 0 and 50

Request Formats

application/json, text/json

Sample:
[
  {
    "Deleted": true,
    "CodeId": "sample string 1",
    "Code": "sample string 2",
    "PatientId": "sample string 3",
    "PatientPmsId": "sample string 4",
    "Description": "sample string 5",
    "ProviderId": "sample string 6",
    "ProviderName": "sample string 7",
    "Filler": "sample string 8",
    "IssuedDate": "2025-12-16T00:52:06.9425969+00:00",
    "FillDate": "2025-12-16T00:52:06.9425969+00:00",
    "ExpirationDate": "2025-12-16T00:52:06.9425969+00:00",
    "Quantity": 9.0,
    "TransactionId": "sample string 10",
    "TotalRefills": 11,
    "CurrentRefillNumber": 12,
    "PrescriptionNumber": "sample string 13",
    "Instructions": "sample string 14",
    "IsVoided": true,
    "SiteId": "sample string 15",
    "ApiCreateDate": "2025-12-16T00:52:06.9425969+00:00",
    "ApiLastChangeDate": "2025-12-16T00:52:06.9425969+00:00",
    "CheckSum": 17,
    "RowKey": 18,
    "Id": "sample string 19",
    "SyncId": "sample string 20",
    "SubscriberId": "sample string 21"
  },
  {
    "Deleted": true,
    "CodeId": "sample string 1",
    "Code": "sample string 2",
    "PatientId": "sample string 3",
    "PatientPmsId": "sample string 4",
    "Description": "sample string 5",
    "ProviderId": "sample string 6",
    "ProviderName": "sample string 7",
    "Filler": "sample string 8",
    "IssuedDate": "2025-12-16T00:52:06.9425969+00:00",
    "FillDate": "2025-12-16T00:52:06.9425969+00:00",
    "ExpirationDate": "2025-12-16T00:52:06.9425969+00:00",
    "Quantity": 9.0,
    "TransactionId": "sample string 10",
    "TotalRefills": 11,
    "CurrentRefillNumber": 12,
    "PrescriptionNumber": "sample string 13",
    "Instructions": "sample string 14",
    "IsVoided": true,
    "SiteId": "sample string 15",
    "ApiCreateDate": "2025-12-16T00:52:06.9425969+00:00",
    "ApiLastChangeDate": "2025-12-16T00:52:06.9425969+00:00",
    "CheckSum": 17,
    "RowKey": 18,
    "Id": "sample string 19",
    "SyncId": "sample string 20",
    "SubscriberId": "sample string 21"
  }
]

application/xml, text/xml

Sample:
<ArrayOfPrescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PVExDataModel">
  <Prescription>
    <ApiCreateDate>2025-12-16T00:52:06.9425969+00:00</ApiCreateDate>
    <ApiLastChangeDate>2025-12-16T00:52:06.9425969+00:00</ApiLastChangeDate>
    <CheckSum>17</CheckSum>
    <Code>sample string 2</Code>
    <CodeId>sample string 1</CodeId>
    <CurrentRefillNumber>12</CurrentRefillNumber>
    <Deleted>true</Deleted>
    <Description>sample string 5</Description>
    <ExpirationDate>2025-12-16T00:52:06.9425969+00:00</ExpirationDate>
    <FillDate>2025-12-16T00:52:06.9425969+00:00</FillDate>
    <Filler>sample string 8</Filler>
    <Id>sample string 19</Id>
    <Instructions>sample string 14</Instructions>
    <IsVoided>true</IsVoided>
    <IssuedDate>2025-12-16T00:52:06.9425969+00:00</IssuedDate>
    <PatientId>sample string 3</PatientId>
    <PatientPmsId>sample string 4</PatientPmsId>
    <PrescriptionNumber>sample string 13</PrescriptionNumber>
    <ProviderId>sample string 6</ProviderId>
    <ProviderName>sample string 7</ProviderName>
    <Quantity>9</Quantity>
    <RowKey>18</RowKey>
    <SiteId>sample string 15</SiteId>
    <SubscriberId>sample string 21</SubscriberId>
    <SyncId>sample string 20</SyncId>
    <TotalRefills>11</TotalRefills>
    <TransactionId>sample string 10</TransactionId>
  </Prescription>
  <Prescription>
    <ApiCreateDate>2025-12-16T00:52:06.9425969+00:00</ApiCreateDate>
    <ApiLastChangeDate>2025-12-16T00:52:06.9425969+00:00</ApiLastChangeDate>
    <CheckSum>17</CheckSum>
    <Code>sample string 2</Code>
    <CodeId>sample string 1</CodeId>
    <CurrentRefillNumber>12</CurrentRefillNumber>
    <Deleted>true</Deleted>
    <Description>sample string 5</Description>
    <ExpirationDate>2025-12-16T00:52:06.9425969+00:00</ExpirationDate>
    <FillDate>2025-12-16T00:52:06.9425969+00:00</FillDate>
    <Filler>sample string 8</Filler>
    <Id>sample string 19</Id>
    <Instructions>sample string 14</Instructions>
    <IsVoided>true</IsVoided>
    <IssuedDate>2025-12-16T00:52:06.9425969+00:00</IssuedDate>
    <PatientId>sample string 3</PatientId>
    <PatientPmsId>sample string 4</PatientPmsId>
    <PrescriptionNumber>sample string 13</PrescriptionNumber>
    <ProviderId>sample string 6</ProviderId>
    <ProviderName>sample string 7</ProviderName>
    <Quantity>9</Quantity>
    <RowKey>18</RowKey>
    <SiteId>sample string 15</SiteId>
    <SubscriberId>sample string 21</SubscriberId>
    <SyncId>sample string 20</SyncId>
    <TotalRefills>11</TotalRefills>
    <TransactionId>sample string 10</TransactionId>
  </Prescription>
</ArrayOfPrescription>

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 'List`1'.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.