BootView WebApi

<back to all web services

UpdateAssistedRelease

The following routes are available for this service:
PUT/assistedreleases/{id}Use this to move items from Queued to Dispatched (i.e. Dispatch a boot) and Dispatched to Queued (i.e. Un-Dispatch a boot).
UpdateAssistedRelease Parameters:
NameParameterData TypeRequiredDescription
IdpathGuidYesThe unique boot collection attempt Id
AssistedReleaseStatusbodyAssistedReleaseStatusYesThe status that you want to update the Boot Attempt to (Queued | Dispatched). If you try to update to the same status (i.e. from Queued to Queued), nothing will happen, and the response will be Success=false.
OfficerNamebodystringNoThe name of the officer dispatched is required when Dipatching a boot for release but not when Un-dispatching

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

HTTP + CSV

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

POST /csv/reply/UpdateAssistedRelease HTTP/1.1 
Host: api.paylock.com 
Content-Type: text/csv
Content-Length: length

{"id":"00000000000000000000000000000000","assistedReleaseStatus":"Both","officerName":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

"00000000000000000000000000000000"