BootView WebApi

<back to all web services

CreateTowRecord

The following routes are available for this service:
POST/towrecordsCreates a new Tow Record.
CreateTowRecord Parameters:
NameParameterData TypeRequiredDescription
CustomerIdbodyGuidYesThe Customer Id.
BootIdbodyGuidNoThe Boot Record Id.
AttemptIdbodyGuidNoThe Collection Attempt Id.
LicenseTagbodystringYesThe License Tag.
ColorbodystringYesThe vehicle color.
MakeModelbodystringYesThe vehicle make/model.
LicenseStatebodystringYesThe License State.
PlateTypebodystringNoThe Plate Type.
TowedDatebodystringNoThe Towed Date.
TowedTimebodystringNoThe TowedTime.
AttemptTypebodyintNoThe Collection Record Attempt Type
LocationbodystringYesThe Boot Record Id.
TowCompanyIdbodyGuidYesThe Tow Company Id.
OfficerIdbodyGuidYesThe Officer Id.
ParkingAreaIdbodyGuidYesThe Parking Area Id.
BootReturnLocationbodyGuidNoThe Boot Record Id.
BootReturnNotebodystringNoThe Boot Return Note.
BootReturnStatusbodyintNoThe Boot Return Status.
IsBootDamagedbodyboolNoWhether the boot is damaged.
BootDamageNotebodystringNoThe Boot Damage Note.
BootDamageTypesbodyList<BootDamageType>NoThe damage types that apply to the boot.
DamageType Parameters:
NameParameterData TypeRequiredDescription
DamageTypeIdformintNo
DamageTypeNameformstringNo
CreateTowRecordResult Parameters:
NameParameterData TypeRequiredDescription
CollectionAttemptIdformGuidNo

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 /xml/reply/CreateTowRecord HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/xml
Content-Length: length

<CreateTowRecord xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BootView.WebApi.ServiceModel">
  <AttemptId>00000000-0000-0000-0000-000000000000</AttemptId>
  <AttemptType>0</AttemptType>
  <BootDamageNote>String</BootDamageNote>
  <BootDamageTypes>
    <DamageType>
      <DamageTypeId>0</DamageTypeId>
      <DamageTypeName>String</DamageTypeName>
    </DamageType>
  </BootDamageTypes>
  <BootId>00000000-0000-0000-0000-000000000000</BootId>
  <BootReturnLocation>00000000-0000-0000-0000-000000000000</BootReturnLocation>
  <BootReturnNote>String</BootReturnNote>
  <BootReturnStatus>0</BootReturnStatus>
  <Color>String</Color>
  <CustomerId>00000000-0000-0000-0000-000000000000</CustomerId>
  <IsBootDamaged>false</IsBootDamaged>
  <LicenseState>String</LicenseState>
  <LicenseTag>String</LicenseTag>
  <Location>String</Location>
  <MakeModel>String</MakeModel>
  <OfficerId>00000000-0000-0000-0000-000000000000</OfficerId>
  <ParkingAreaId>00000000-0000-0000-0000-000000000000</ParkingAreaId>
  <PlateType>String</PlateType>
  <TowCompanyId>00000000-0000-0000-0000-000000000000</TowCompanyId>
  <TowedDate>0001-01-01T00:00:00</TowedDate>
  <TowedTime>0001-01-01T00:00:00</TowedTime>
</CreateTowRecord>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CreateTowRecordResult 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>
</CreateTowRecordResult>