POST | /towrecords | Creates a new Tow Record. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CustomerId | body | Guid | Yes | The Customer Id. |
BootId | body | Guid | No | The Boot Record Id. |
AttemptId | body | Guid | No | The Collection Attempt 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. |
TowedDate | body | string | No | The Towed Date. |
TowedTime | body | string | No | The TowedTime. |
AttemptType | body | int | No | The Collection Record Attempt Type |
Location | body | string | Yes | The Boot Record Id. |
TowCompanyId | body | Guid | Yes | The Tow Company Id. |
OfficerId | body | Guid | Yes | The Officer Id. |
ParkingAreaId | body | Guid | Yes | The Parking Area Id. |
BootReturnLocation | body | Guid | No | The Boot Record Id. |
BootReturnNote | body | string | No | The Boot Return Note. |
BootReturnStatus | body | int | No | The Boot Return Status. |
IsBootDamaged | body | bool | No | Whether the boot is damaged. |
BootDamageNote | body | string | No | The Boot Damage Note. |
BootDamageTypes | body | List<BootDamageType> | No | The damage types that apply to the boot. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
DamageTypeId | form | int | No | |
DamageTypeName | form | string | No |
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 .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /towrecords HTTP/1.1
Host: api.paylock.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
customerId: 00000000000000000000000000000000,
bootId: 00000000000000000000000000000000,
attemptId: 00000000000000000000000000000000,
licenseTag: String,
color: String,
makeModel: String,
licenseState: String,
plateType: String,
towedDate: 0001-01-01,
towedTime: 0001-01-01,
attemptType: 0,
location: String,
towCompanyId: 00000000000000000000000000000000,
officerId: 00000000000000000000000000000000,
parkingAreaId: 00000000000000000000000000000000,
bootReturnLocation: 00000000000000000000000000000000,
bootReturnNote: String,
bootReturnStatus: 0,
isBootDamaged: False,
bootDamageNote: String,
bootDamageTypes:
[
{
damageTypeId: 0,
damageTypeName: String
}
]
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { collectionAttemptId: 00000000000000000000000000000000 }