POST | /bootrecords | Creates a new Boot Record. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | body | Guid | No | The Boot Record Id. |
CustomerId | body | Guid | Yes | The Customer Id. |
BootId | body | Guid | Yes | The Boot Id. |
BootSerialNumber | query | string | Yes | The serial number of the boot. |
RedirectAfterSave | body | bool | No | Whether to redirect the user to the new attempt or to add another record. |
AttemptId | body | Guid | No | The Attempt Id. |
StickerId | body | string | Yes | The Sticker Id/Vio. |
VehicleId | body | Guid | No | The Vehicle Id. |
LicenseTag | body | string | Yes | The License Tag. |
Color | body | string | Yes | The vehicle Color. |
MakeModel | body | string | Yes | The vehicle Make/Model. |
LicenseState | body | string | Yes | The License State. |
PlateType | body | string | No | The Plate Type. |
PreventRelease | body | bool | No | Whether to prevent release or not. |
TowEligibleDate | body | DateTime | No | The Tow Eligible Date. |
BootDate | body | DateTime | No | The Boot Date. |
BootTime | body | DateTime | No | The Boot Time. |
BootReturnDueDateOverride | body | DateTime | No | The Boot Return Due Date Override. |
Status | body | int | No | The Boot Status. |
StatusId | body | int | No | The Boot Status Id. |
StatusLabel | body | string | No | The Boot Status Label. |
BootStatusDate | body | DateTime | No | The Boot Status Date. |
IsBootRecordDeleted | body | bool | No | Whether the boot record is deleted. |
AssistedReleaseReasonId | body | Guid | No | The Assisted Release Reason Id. |
IsQueuedForTow | body | bool | No | Whether vehicle is queued for tow. |
QueuedForTowReasonId | body | Guid | No | The Queued For Tow Reason Id. |
StandardBootReason | body | string | Yes | The Standard Boot Reason. |
Location | body | string | Yes | The Vehicle Location. |
CustomBootReason | body | string | No | The Custom Boot Reason. |
TowCompanyId | body | Guid | No | The Tow Company Id. |
OfficerId | body | Guid | Yes | The Officer Id. |
ParkingAreaId | body | Guid | Yes | The Parking Area Id. |
BootingOfficerId | body | Guid | No | The Booting Officer Id. |
IsBootReturned | body | bool | No | Whether the boot is returned. |
BootReturnedDateOrDateDue | body | DateTime | No | The Boot Returned Date or Date Due. |
IsRunaway | body | bool | No | Whether the vehicle is a runaway. |
IsBootViewSource | body | bool | No | Whether it is BootView Source. |
TowEligibleDateHasChanged | body | bool | No | Whether the Tow Eligible Date Has Changed. |
BootedStreetSide | body | bool | No | Whether it is booted street side. |
MandatoryAssistedRelease | body | bool | No | Whether it is a Mandatory Assisted Release . |
Latitude | body | string | No | The Boot Record Latitude. |
Longitude | body | string | No | The Boot Record Longitude. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CollectionAttemptId | form | Guid | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /bootrecords HTTP/1.1
Host: api.paylock.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CreateBootRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
<AssistedReleaseReasonId>00000000-0000-0000-0000-000000000000</AssistedReleaseReasonId>
<AttemptId>00000000-0000-0000-0000-000000000000</AttemptId>
<BootDate>0001-01-01T00:00:00</BootDate>
<BootId>00000000-0000-0000-0000-000000000000</BootId>
<BootReturnDueDateOverride>0001-01-01T00:00:00</BootReturnDueDateOverride>
<BootReturnedDateOrDateDue>0001-01-01T00:00:00</BootReturnedDateOrDateDue>
<BootSerialNumber>String</BootSerialNumber>
<BootStatusDate>0001-01-01T00:00:00</BootStatusDate>
<BootTime>0001-01-01T00:00:00</BootTime>
<BootedStreetSide>false</BootedStreetSide>
<BootingOfficerId>00000000-0000-0000-0000-000000000000</BootingOfficerId>
<Color>String</Color>
<CustomBootReason>String</CustomBootReason>
<CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
<Id>00000000-0000-0000-0000-000000000000</Id>
<IsBootRecordDeleted>false</IsBootRecordDeleted>
<IsBootReturned>false</IsBootReturned>
<IsBootViewSource>false</IsBootViewSource>
<IsQueuedForTow>false</IsQueuedForTow>
<IsRunaway>false</IsRunaway>
<Latitude>String</Latitude>
<LicenseState>String</LicenseState>
<LicenseTag>String</LicenseTag>
<Location>String</Location>
<Longitude>String</Longitude>
<MakeModel>String</MakeModel>
<MandatoryAssistedRelease>false</MandatoryAssistedRelease>
<OfficerId>00000000-0000-0000-0000-000000000000</OfficerId>
<ParkingAreaId>00000000-0000-0000-0000-000000000000</ParkingAreaId>
<PlateType>String</PlateType>
<PreventRelease>false</PreventRelease>
<QueuedForTowReasonId>00000000-0000-0000-0000-000000000000</QueuedForTowReasonId>
<RedirectAfterSave>false</RedirectAfterSave>
<StandardBootReason>String</StandardBootReason>
<Status>0</Status>
<StatusId>0</StatusId>
<StatusLabel>String</StatusLabel>
<StickerId>String</StickerId>
<TowCompanyId>00000000-0000-0000-0000-000000000000</TowCompanyId>
<TowEligibleDate>0001-01-01T00:00:00</TowEligibleDate>
<TowEligibleDateHasChanged>false</TowEligibleDateHasChanged>
<VehicleId>00000000-0000-0000-0000-000000000000</VehicleId>
</CreateBootRecord>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <CreateBootRecordResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel"> <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId> </CreateBootRecordResult>