POST api/PatientBatch

Request Information

URI Parameters

None.

Body Parameters

Collection of Patient
NameDescriptionTypeAdditional information
PmsId

string

Required

String length: inclusive between 0 and 50
ClientPmsId

string

String length: inclusive between 0 and 50
Name

string

String length: inclusive between 0 and 50
Species

string

String length: inclusive between 0 and 50
SpeciesDescription

string

String length: inclusive between 0 and 50
Breed

string

String length: inclusive between 0 and 50
BreedDescription

string

String length: inclusive between 0 and 50
Color

string

String length: inclusive between 0 and 50
ColorDescription

string

String length: inclusive between 0 and 50
Gender

string

String length: inclusive between 0 and 50
GenderDescription

string

String length: inclusive between 0 and 50
DateOfBirth

date

None.
DateOfDeath

date

None.
EnteredDate

date

None.
Deleted

boolean

None.
IsDeceased

boolean

None.
Inactive

boolean

None.
CurrentWeight

decimal number

None.
CurrentWeightUnit

string

String length: inclusive between 0 and 50
LastTransactionDate

date

None.
SiteId

string

String length: inclusive between 0 and 50
Rabies

string

String length: inclusive between 0 and 36
MicroChip

string

String length: inclusive between 0 and 36
LostAndFoundSerial

string

String length: inclusive between 0 and 36
SuspendReminders

boolean

None.
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: 
[
  {
    "PmsId": "sample string 1",
    "ClientPmsId": "sample string 2",
    "Name": "sample string 3",
    "Species": "sample string 4",
    "SpeciesDescription": "sample string 5",
    "Breed": "sample string 6",
    "BreedDescription": "sample string 7",
    "Color": "sample string 8",
    "ColorDescription": "sample string 9",
    "Gender": "sample string 10",
    "GenderDescription": "sample string 11",
    "DateOfBirth": "2025-12-16T00:52:15.8350513+00:00",
    "DateOfDeath": "2025-12-16T00:52:15.8350513+00:00",
    "EnteredDate": "2025-12-16T00:52:15.8350513+00:00",
    "Deleted": true,
    "IsDeceased": true,
    "Inactive": true,
    "CurrentWeight": 1.0,
    "CurrentWeightUnit": "sample string 12",
    "LastTransactionDate": "2025-12-16T00:52:15.8350513+00:00",
    "SiteId": "sample string 13",
    "Rabies": "sample string 14",
    "MicroChip": "sample string 15",
    "LostAndFoundSerial": "sample string 16",
    "SuspendReminders": true,
    "ApiCreateDate": "2025-12-16T00:52:15.8350513+00:00",
    "ApiLastChangeDate": "2025-12-16T00:52:15.8350513+00:00",
    "CheckSum": 18,
    "RowKey": 19,
    "Id": "sample string 20",
    "SyncId": "sample string 21",
    "SubscriberId": "sample string 22"
  },
  {
    "PmsId": "sample string 1",
    "ClientPmsId": "sample string 2",
    "Name": "sample string 3",
    "Species": "sample string 4",
    "SpeciesDescription": "sample string 5",
    "Breed": "sample string 6",
    "BreedDescription": "sample string 7",
    "Color": "sample string 8",
    "ColorDescription": "sample string 9",
    "Gender": "sample string 10",
    "GenderDescription": "sample string 11",
    "DateOfBirth": "2025-12-16T00:52:15.8350513+00:00",
    "DateOfDeath": "2025-12-16T00:52:15.8350513+00:00",
    "EnteredDate": "2025-12-16T00:52:15.8350513+00:00",
    "Deleted": true,
    "IsDeceased": true,
    "Inactive": true,
    "CurrentWeight": 1.0,
    "CurrentWeightUnit": "sample string 12",
    "LastTransactionDate": "2025-12-16T00:52:15.8350513+00:00",
    "SiteId": "sample string 13",
    "Rabies": "sample string 14",
    "MicroChip": "sample string 15",
    "LostAndFoundSerial": "sample string 16",
    "SuspendReminders": true,
    "ApiCreateDate": "2025-12-16T00:52:15.8350513+00:00",
    "ApiLastChangeDate": "2025-12-16T00:52:15.8350513+00:00",
    "CheckSum": 18,
    "RowKey": 19,
    "Id": "sample string 20",
    "SyncId": "sample string 21",
    "SubscriberId": "sample string 22"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPatient xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PVExDataModel">
  <Patient>
    <ApiCreateDate>2025-12-16T00:52:15.8350513+00:00</ApiCreateDate>
    <ApiLastChangeDate>2025-12-16T00:52:15.8350513+00:00</ApiLastChangeDate>
    <Breed>sample string 6</Breed>
    <BreedDescription>sample string 7</BreedDescription>
    <CheckSum>18</CheckSum>
    <ClientPmsId>sample string 2</ClientPmsId>
    <Color>sample string 8</Color>
    <ColorDescription>sample string 9</ColorDescription>
    <CurrentWeight>1</CurrentWeight>
    <CurrentWeightUnit>sample string 12</CurrentWeightUnit>
    <DateOfBirth>2025-12-16T00:52:15.8350513+00:00</DateOfBirth>
    <DateOfDeath>2025-12-16T00:52:15.8350513+00:00</DateOfDeath>
    <Deleted>true</Deleted>
    <EnteredDate>2025-12-16T00:52:15.8350513+00:00</EnteredDate>
    <Gender>sample string 10</Gender>
    <GenderDescription>sample string 11</GenderDescription>
    <Id>sample string 20</Id>
    <Inactive>true</Inactive>
    <IsDeceased>true</IsDeceased>
    <LastTransactionDate>2025-12-16T00:52:15.8350513+00:00</LastTransactionDate>
    <LostAndFoundSerial>sample string 16</LostAndFoundSerial>
    <MicroChip>sample string 15</MicroChip>
    <Name>sample string 3</Name>
    <PmsId>sample string 1</PmsId>
    <Rabies>sample string 14</Rabies>
    <RowKey>19</RowKey>
    <SiteId>sample string 13</SiteId>
    <Species>sample string 4</Species>
    <SpeciesDescription>sample string 5</SpeciesDescription>
    <SubscriberId>sample string 22</SubscriberId>
    <SuspendReminders>true</SuspendReminders>
    <SyncId>sample string 21</SyncId>
  </Patient>
  <Patient>
    <ApiCreateDate>2025-12-16T00:52:15.8350513+00:00</ApiCreateDate>
    <ApiLastChangeDate>2025-12-16T00:52:15.8350513+00:00</ApiLastChangeDate>
    <Breed>sample string 6</Breed>
    <BreedDescription>sample string 7</BreedDescription>
    <CheckSum>18</CheckSum>
    <ClientPmsId>sample string 2</ClientPmsId>
    <Color>sample string 8</Color>
    <ColorDescription>sample string 9</ColorDescription>
    <CurrentWeight>1</CurrentWeight>
    <CurrentWeightUnit>sample string 12</CurrentWeightUnit>
    <DateOfBirth>2025-12-16T00:52:15.8350513+00:00</DateOfBirth>
    <DateOfDeath>2025-12-16T00:52:15.8350513+00:00</DateOfDeath>
    <Deleted>true</Deleted>
    <EnteredDate>2025-12-16T00:52:15.8350513+00:00</EnteredDate>
    <Gender>sample string 10</Gender>
    <GenderDescription>sample string 11</GenderDescription>
    <Id>sample string 20</Id>
    <Inactive>true</Inactive>
    <IsDeceased>true</IsDeceased>
    <LastTransactionDate>2025-12-16T00:52:15.8350513+00:00</LastTransactionDate>
    <LostAndFoundSerial>sample string 16</LostAndFoundSerial>
    <MicroChip>sample string 15</MicroChip>
    <Name>sample string 3</Name>
    <PmsId>sample string 1</PmsId>
    <Rabies>sample string 14</Rabies>
    <RowKey>19</RowKey>
    <SiteId>sample string 13</SiteId>
    <Species>sample string 4</Species>
    <SpeciesDescription>sample string 5</SpeciesDescription>
    <SubscriberId>sample string 22</SubscriberId>
    <SuspendReminders>true</SuspendReminders>
    <SyncId>sample string 21</SyncId>
  </Patient>
</ArrayOfPatient>

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.