| 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). |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | Guid | Yes | The unique boot collection attempt Id |
| AssistedReleaseStatus | body | AssistedReleaseStatus | Yes | The 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. |
| OfficerName | body | string | No | The name of the officer dispatched is required when Dipatching a boot for release but not when Un-dispatching |
| Name | Value |
|---|---|
| Both | 0 |
| Unknown | 1 |
| Queued | 5 |
| Dispatched | 6 |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /assistedreleases/{id} HTTP/1.1
Host: api.paylock.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"id":"00000000000000000000000000000000","assistedReleaseStatus":"Both","officerName":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length "00000000000000000000000000000000"