BootView WebApi

GetBootRecordsByTowStatus

The following routes are available for this service:
GET	/bootrecordsbytowstatus	Gets boot records by tow status.

**GetBootRecordsByTowStatus** Parameters:
Name	Parameter	Data Type	Required	Description
CustomerIds	query	List[]	Yes	The customer Id(s) for which we want the boot records.
TowStatus	query	BootRecordTowStatus	No	The tow status of the boot records.
TowedFrom	query	DateTime	No	The earliest date of tow eligibility to search.
TowedTo	query	DateTime	No	The most recent date of tow eligibility to search.
HoursUntilTowEligible	query	int	No	The number of hours until eligible.
SortField	query	string	No	The sort field for the boot records.
PageIndex	query	int	No	The page index.
PageSize	query	int	No	Number of results to return.

**BootRecordTowStatus** Enum:
Name	Value
EligileForTow	1
QueuedForTow	2
TowDispatched	3
EligibleSoon	4

**BootRecordByTowStatusSearchResult** Parameters:
Name	Parameter	Data Type	Required
PageIndex	form	int	No
PageSize	form	int	No
TotalItems	form	int	No
Results	form	List<BootRecordByTowStatusSearchResultItem>	No
EligibleSoonResults	form	List<BootRecordByEligibleSoonTowStatusSearchResultItem>	No

**BootRecordByTowStatusSearchResultItem** Parameters:
Name	Parameter	Data Type	Required
MunicipalityCode	form	string	No
CollectionAttemptId	form	Guid	No
StickerId	form	string	No
VehicleId	form	Guid	No
FullTag	form	string	No
FullMakeColorTag	form	string	No
Location	form	string	No
Zone	form	string	No
BootId	form	Guid	No
BootSerialNumber	form	string	No
HoursSinceBooting	form	int	No
DaysHours	form	string	No
NetDue	form	decimal	No
IsOverdue	form	bool	No
BootRecordId	form	Guid	No
BootRecordStatusDate	form	DateTime	No
BootInstalledOn	form	DateTime	No
CustomerId	form	Guid	No
QueuedForTowReason	form	string	No
TowCompanyName	form	string	No

**BootRecordByEligibleSoonTowStatusSearchResultItem** Parameters:
Name	Parameter	Data Type	Required
MunicipalityCode	form	string	No
CollectionAttemptId	form	Guid	No
StickerId	form	string	No
VehicleId	form	Guid	No
FullTag	form	string	No
FullMakeColorTag	form	string	No
TowEligibleDate	form	string	No
AmountDue	form	decimal	No
HoursBeforeEligible	form	string	No
PhoneNumber	form	string	No
CallerName	form	string	No
Zone	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /bootrecordsbytowstatus HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BootRecordByTowStatusSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <EligibleSoonResults>
    <BootRecordByEligibleSoonTowStatusSearchResultItem>
      <AmountDue>0</AmountDue>
      <CallerName>String</CallerName>
      <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
      <FullMakeColorTag>String</FullMakeColorTag>
      <FullTag>String</FullTag>
      <HoursBeforeEligible>String</HoursBeforeEligible>
      <MunicipalityCode>String</MunicipalityCode>
      <PhoneNumber>String</PhoneNumber>
      <StickerId>String</StickerId>
      <TowEligibleDate>String</TowEligibleDate>
      <VehicleId>00000000-0000-0000-0000-000000000000</VehicleId>
      <Zone>String</Zone>
    </BootRecordByEligibleSoonTowStatusSearchResultItem>
  </EligibleSoonResults>
  <PageIndex>0</PageIndex>
  <PageSize>0</PageSize>
  <Results>
    <BootRecordByTowStatusSearchResultItem>
      <BootId>00000000-0000-0000-0000-000000000000</BootId>
      <BootInstalledOn>0001-01-01T00:00:00</BootInstalledOn>
      <BootRecordId>00000000-0000-0000-0000-000000000000</BootRecordId>
      <BootRecordStatusDate>0001-01-01T00:00:00</BootRecordStatusDate>
      <BootSerialNumber>String</BootSerialNumber>
      <CollectionAttemptId>00000000-0000-0000-0000-000000000000</CollectionAttemptId>
      <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
      <DaysHours>String</DaysHours>
      <FullMakeColorTag>String</FullMakeColorTag>
      <FullTag>String</FullTag>
      <HoursSinceBooting>0</HoursSinceBooting>
      <IsOverdue>false</IsOverdue>
      <Location>String</Location>
      <MunicipalityCode>String</MunicipalityCode>
      <NetDue>0</NetDue>
      <QueuedForTowReason>String</QueuedForTowReason>
      <StickerId>String</StickerId>
      <TowCompanyName>String</TowCompanyName>
      <VehicleId>00000000-0000-0000-0000-000000000000</VehicleId>
      <Zone>String</Zone>
    </BootRecordByTowStatusSearchResultItem>
  </Results>
  <TotalItems>0</TotalItems>
</BootRecordByTowStatusSearchResult>