BootView WebApi

<back to all web services

GetCollectionAttempt

The following routes are available for this service:
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.
GetCollectionAttempt Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe Collection Attempt Id.
CollectionAttempt Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
AttemptTypeformAttemptTypeNo
VehicleIdformGuidNo
AttemptDateformDateTime?No
AttemptedByOfficerIdformGuid?No
CreatedByUserIdformGuid?No
CustomerIdformGuidNo
CustomerReferenceIdformstringNo
DateCreatedformDateTime?No
IsFlaggedForFollowupformboolNo
IsDeletedformboolNo
IsLockedformbool?No
LocationformstringNo
IsOnPaymentPlanformboolNo
RequiresSupervisorAttentionformbool?No
TotalDueformdecimalNo
TotalPaidformdecimalNo
NetDueformdecimalNo
NetDueWithMerchantFeesformdecimalNo
IsSelfReleaseEligibleformboolNo

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

HTTP + X-MSGPACK

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

POST /x-msgpack/reply/GetCollectionAttempt HTTP/1.1 
Host: api.paylock.com 
Content-Type: application/x-msgpack
Content-Length: length

{"id":"00000000000000000000000000000000"}
HTTP/1.1 200 OK
Content-Type: application/x-msgpack
Content-Length: length

{Unable to show example output for type 'CollectionAttempt' using the custom 'x-msgpack' filter}Cannot create an abstract class.