| GET | /collectionattempts/{id} | Gets a collection attempt. Can be a boot, tow, or notice attempt (see AttemptType). If not found or no permission, throws exception. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | Guid | Yes | The Collection Attempt Id. |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | form | Guid | No | |
| AttemptType | form | AttemptType | No | |
| VehicleId | form | Guid | No | |
| AttemptDate | form | DateTime? | No | |
| AttemptedByOfficerId | form | Guid? | No | |
| CreatedByUserId | form | Guid? | No | |
| CustomerId | form | Guid | No | |
| CustomerReferenceId | form | string | No | |
| DateCreated | form | DateTime? | No | |
| IsFlaggedForFollowup | form | bool | No | |
| IsDeleted | form | bool | No | |
| IsLocked | form | bool? | No | |
| Location | form | string | No | |
| IsOnPaymentPlan | form | bool | No | |
| IsOnPaylockPaymentPlan | form | bool | No | |
| RequiresSupervisorAttention | form | bool? | No | |
| TotalDue | form | decimal | No | |
| TotalPaid | form | decimal | No | |
| NetDue | form | decimal | No | |
| NetDueWithMerchantFees | form | decimal | No | |
| IsSelfReleaseEligible | form | bool | No | |
| HasGiftCardPayment | form | bool | No | |
| HasTowRecord | form | bool | No |
| Any |
| Boot |
| Notice |
| Tow |
| TowHold |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /collectionattempts/{id} HTTP/1.1
Host: api.paylock.com
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{Unable to show example output for type 'CollectionAttempt' using the custom 'csv' filter}Cannot create an abstract class.