POST api/RequestVetDataSync
Request Information
URI Parameters
None.
Body Parameters
VetDataApiSyncRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| CustomerNumber | string |
Required String length: inclusive between 0 and 50 |
|
| VetDataInstallationId | string |
Required String length: inclusive between 0 and 50 |
|
| StartDate | date |
None. |
|
| EndDate | date |
None. |
|
| FullSyncElements | IncludeElement |
Required |
|
| IncludedElements | IncludeElement |
Required |
|
| InitialSync | boolean |
None. |
|
| CheckSumOnly | boolean |
None. |
|
| TicketNumber | globally unique identifier |
None. |
|
| SingleCache | string |
None. |
|
| RequestedBy | string |
None. |
|
| DeletedRecordsOnly | boolean |
None. |
|
| RequestedFrom | string |
None. |
|
| RequestedDate | date |
None. |
|
| ServiceClientModifier | string |
None. |
|
| ExecutedDate | date |
None. |
|
| ExecutedBy | string |
None. |
|
| ErrorInfo | string |
None. |
|
| Status | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"CustomerNumber": "sample string 1",
"VetDataInstallationId": "sample string 2",
"StartDate": "2026-02-09T01:01:09.7323452+00:00",
"EndDate": "2026-02-09T01:01:09.7323452+00:00",
"FullSyncElements": 0,
"IncludedElements": 0,
"InitialSync": true,
"CheckSumOnly": true,
"TicketNumber": "2a359f2c-e441-459e-8070-13735146cedf",
"SingleCache": "sample string 8",
"RequestedBy": "sample string 9",
"DeletedRecordsOnly": true,
"RequestedFrom": "sample string 11",
"RequestedDate": "2026-02-09T01:01:09.7323452+00:00",
"ServiceClientModifier": "sample string 13",
"ExecutedDate": "2026-02-09T01:01:09.7323452+00:00",
"ExecutedBy": "sample string 15",
"ErrorInfo": "sample string 16",
"Status": "sample string 17"
}
application/xml, text/xml
Sample:
<VetDataApiSyncRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ScheduledJobModels"> <CheckSumOnly>true</CheckSumOnly> <CustomerNumber>sample string 1</CustomerNumber> <DeletedRecordsOnly>true</DeletedRecordsOnly> <EndDate>2026-02-09T01:01:09.7323452+00:00</EndDate> <ErrorInfo>sample string 16</ErrorInfo> <ExecutedBy>sample string 15</ExecutedBy> <ExecutedDate>2026-02-09T01:01:09.7323452+00:00</ExecutedDate> <FullSyncElements>None</FullSyncElements> <IncludedElements>None</IncludedElements> <InitialSync>true</InitialSync> <RequestedBy>sample string 9</RequestedBy> <RequestedDate>2026-02-09T01:01:09.7323452+00:00</RequestedDate> <RequestedFrom>sample string 11</RequestedFrom> <ServiceClientModifier>sample string 13</ServiceClientModifier> <SingleCache>sample string 8</SingleCache> <StartDate>2026-02-09T01:01:09.7323452+00:00</StartDate> <Status>sample string 17</Status> <TicketNumber>2a359f2c-e441-459e-8070-13735146cedf</TicketNumber> <VetDataInstallationId>sample string 2</VetDataInstallationId> </VetDataApiSyncRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.