BootView WebApi

<back to all web services

FindAssistedReleasesPost

The following routes are available for this service:
POST/assistedreleasesGets the list of assisted boot releases that haven't yet been released. (using post because parameters grow to much GET seems to have problems)
FindAssistedReleasesPost Parameters:
NameParameterData TypeRequiredDescription
CustomerIdsbodyGuid[]YesThe comma-separated list of customer ids to restrict the results to. If none are given, this will default to the current user's allowed customers. Ids that are not in the current user's allowed customers will be ignored.
FromDateTimebodyDateTimeNoThe start date/time (mm/dd/yyyy hh:mm:ss [am|pm]) limit. If no time is given, midnight between the day before and the date given is assumed.
ToDateTimebodyDateTimeNoThe end date/time (mm/dd/yyyy hh:mm:ss [am|pm]) limit. If no time is given, then the results will include the full day.
StatusbodyAssistedReleaseStatusNoBoth | Queued | Dispatched. Defaults to Both if not provided.
ShowHistoricalbodyboolNoIf true, this will include historical assisted releases, those which were EVER queued and/or dispatched (depending upon the Status value). Defaults to false.
ExRemovedbodyboolNoIf true, this will include only boot records where the associated boot is currently marked as on the car
AssistedReleaseStatus Enum:
NameValue
Both0
Unknown1
Queued5
Dispatched6

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.

POST /assistedreleases HTTP/1.1 
Host: api.paylock.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<FindAssistedReleasesPost xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <CustomerIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>00000000-0000-0000-0000-000000000000</d2p1:guid>
  </CustomerIds>
  <ExRemoved>false</ExRemoved>
  <FromDateTime>0001-01-01T00:00:00</FromDateTime>
  <ShowHistorical>false</ShowHistorical>
  <Status>Both</Status>
  <ToDateTime>0001-01-01T00:00:00</ToDateTime>
</FindAssistedReleasesPost>

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

<ArrayOfAssistedRelease xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <AssistedRelease>
    <AssistedReleaseStatus>Both</AssistedReleaseStatus>
    <BootId>00000000-0000-0000-0000-000000000000</BootId>
    <BootSerialNumber>String</BootSerialNumber>
    <BootStatusId>0</BootStatusId>
    <Color>String</Color>
    <CustomerCode>String</CustomerCode>
    <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
    <DispatchedOfficerName>String</DispatchedOfficerName>
    <HoursInPreviousStatus>0</HoursInPreviousStatus>
    <HoursInStatus>0</HoursInStatus>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <IsDispatched>false</IsDispatched>
    <IsOverdue>false</IsOverdue>
    <LicensePlate>String</LicensePlate>
    <LicenseState>String</LicenseState>
    <Location>String</Location>
    <MakeModel>String</MakeModel>
    <ParkingAreaFull>String</ParkingAreaFull>
    <ParkingZone>String</ParkingZone>
    <ParkingZoneCounty>String</ParkingZoneCounty>
    <Reason>String</Reason>
    <StatusDateTime>0001-01-01T00:00:00</StatusDateTime>
    <VehicleFlagsCount>0</VehicleFlagsCount>
    <VehicleId>00000000-0000-0000-0000-000000000000</VehicleId>
    <VioNumber>String</VioNumber>
  </AssistedRelease>
</ArrayOfAssistedRelease>